@xchainjs/xchain-aggregator 1.0.2 → 1.0.4

package/lib/protocols/chainflip/chainflipProtocol.d.ts

@@ -1,4 +1,4 @@
-import { AnyAsset, Chain } from '@xchainjs/xchain-util';
+import { AnyAsset, Chain, CryptoAmount, TokenAsset } from '@xchainjs/xchain-util';
 import { IProtocol, ProtocolConfig, QuoteSwap, QuoteSwapParams, SwapHistory, TxSubmitted } from '../../types';
 /**
  * Chainflip protocol
@@ -9,6 +9,15 @@ export declare class ChainflipProtocol implements IProtocol {
     private wallet?;
     private assetsData;
     constructor(configuration?: ProtocolConfig);
+    approveRouterToSpend(_params: {
+        asset: TokenAsset;
+        amount?: CryptoAmount;
+    }): Promise<TxSubmitted>;
+    shouldBeApproved(_params: {
+        asset: TokenAsset;
+        amount: CryptoAmount;
+        address: string;
+    }): Promise<boolean>;
     /**
      * Check if an asset is supported in the protocol
      * @param {Asset} asset Asset to check if it is supported

package/lib/protocols/mayachain/mayachainProtocol.d.ts

@@ -1,3 +1,4 @@
+import { ApproveParams, IsApprovedParams } from '@xchainjs/xchain-mayachain-amm';
 import { AnyAsset, Chain } from '@xchainjs/xchain-util';
 import { IProtocol, ProtocolConfig, QuoteSwap, QuoteSwapParams, SwapHistory, SwapHistoryParams, TxSubmitted } from '../../types';
 export declare class MayachainProtocol implements IProtocol {
@@ -5,7 +6,20 @@ export declare class MayachainProtocol implements IProtocol {
     private mayachainQuery;
     private mayachainAmm;
     private configuration;
+    private wallet?;
     constructor(configuration?: ProtocolConfig);
+    /**
+     * Aprove tx for ERC-20
+     * @param {ApproveParams} approveParams params to approve tx
+     * @returns {TxSubmitted} Transaction hash and URL of the swap
+     */
+    approveRouterToSpend(params: ApproveParams): Promise<TxSubmitted>;
+    /**
+     * Check if tx is approved for ERC-20
+     * @param {IsApprovedParams} isApprovedParams params to check if tx is approved
+     * @returns {string[]} array of errors
+     */
+    shouldBeApproved(params: IsApprovedParams): Promise<boolean>;
     /**
      * Check if an asset is supported in the protocol
      * @param {Asset} asset Asset to check if it is supported

package/lib/protocols/thorchain/thorchainProtocol.d.ts

@@ -1,3 +1,4 @@
+import { ApproveParams, IsApprovedParams } from '@xchainjs/xchain-thorchain-amm';
 import { AnyAsset, Chain } from '@xchainjs/xchain-util';
 import { IProtocol, ProtocolConfig, QuoteSwap, QuoteSwapParams, SwapHistory, SwapHistoryParams, TxSubmitted } from '../../types';
 export declare class ThorchainProtocol implements IProtocol {
@@ -5,7 +6,20 @@ export declare class ThorchainProtocol implements IProtocol {
     private thorchainQuery;
     private thorchainAmm;
     private configuration;
+    private wallet?;
     constructor(configuration?: ProtocolConfig);
+    /**
+     * Aprove tx for ERC-20 and wait until tx is confirmed
+     * @param {ApproveParams} approveParams params to approve tx
+     * @returns {TxSubmitted} Transaction hash and URL of the swap
+     */
+    approveRouterToSpend(params: ApproveParams): Promise<TxSubmitted>;
+    /**
+     * Check if tx should be approved for ERC-20
+     * @param {IsApprovedParams} isApprovedParams params to check if tx is approved
+     * @returns {boolean} array of errors
+     */
+    shouldBeApproved(params: IsApprovedParams): Promise<boolean>;
     /**
      * Check if an asset is supported in the protocol
      * @param {Asset} asset Asset to check if it is supported

package/lib/types.d.ts

@@ -108,6 +108,15 @@ type SwapHistory = {
     count: number;
     swaps: SwapResume[];
 };
+type ApproveParams = {
+    asset: TokenAsset;
+    amount?: CryptoAmount;
+};
+type IsApprovedParams = {
+    asset: TokenAsset;
+    amount: CryptoAmount;
+    address: string;
+};
 interface IProtocol {
     name: Protocol;
     isAssetSupported(asset: AnyAsset): Promise<boolean>;
@@ -115,5 +124,7 @@ interface IProtocol {
     estimateSwap(params: QuoteSwapParams): Promise<QuoteSwap>;
     doSwap(params: QuoteSwapParams): Promise<TxSubmitted>;
     getSwapHistory(params: SwapHistoryParams): Promise<SwapHistory>;
+    approveRouterToSpend(params: ApproveParams): Promise<TxSubmitted>;
+    shouldBeApproved(params: IsApprovedParams): Promise<boolean>;
 }
-export { IProtocol, QuoteSwapParams, QuoteSwap, TxSubmitted, Protocol, SwapHistory, SwapResume, SwapHistoryParams };
+export { IProtocol, QuoteSwapParams, QuoteSwap, TxSubmitted, Protocol, SwapHistory, SwapResume, SwapHistoryParams, ApproveParams, IsApprovedParams, };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xchainjs/xchain-aggregator",
   "description": "Protocol aggregator to make actions in different protocols",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -30,22 +30,22 @@
   },
   "dependencies": {
     "@chainflip/sdk": "1.3.0",
-    "@xchainjs/xchain-client": "1.0.1",
-    "@xchainjs/xchain-mayachain": "2.0.1",
-    "@xchainjs/xchain-mayachain-amm": "3.0.2",
-    "@xchainjs/xchain-mayachain-query": "1.0.1",
-    "@xchainjs/xchain-thorchain": "2.0.1",
-    "@xchainjs/xchain-thorchain-amm": "2.0.2",
-    "@xchainjs/xchain-thorchain-query": "1.0.1",
-    "@xchainjs/xchain-util": "1.0.0",
-    "@xchainjs/xchain-wallet": "1.0.2"
+    "@xchainjs/xchain-client": "1.0.2",
+    "@xchainjs/xchain-mayachain": "2.0.2",
+    "@xchainjs/xchain-mayachain-amm": "3.0.4",
+    "@xchainjs/xchain-mayachain-query": "1.0.2",
+    "@xchainjs/xchain-thorchain": "2.0.2",
+    "@xchainjs/xchain-thorchain-amm": "2.0.4",
+    "@xchainjs/xchain-thorchain-query": "1.0.2",
+    "@xchainjs/xchain-util": "1.0.1",
+    "@xchainjs/xchain-wallet": "1.0.4"
   },
   "devDependencies": {
-    "@xchainjs/xchain-avax": "1.0.2",
-    "@xchainjs/xchain-binance": "6.0.1",
-    "@xchainjs/xchain-bitcoin": "1.0.1",
-    "@xchainjs/xchain-ethereum": "1.0.2",
-    "@xchainjs/xchain-kujira": "1.0.1",
+    "@xchainjs/xchain-avax": "1.0.4",
+    "@xchainjs/xchain-binance": "6.0.2",
+    "@xchainjs/xchain-bitcoin": "1.0.2",
+    "@xchainjs/xchain-ethereum": "1.0.4",
+    "@xchainjs/xchain-kujira": "1.0.2",
     "axios": "1.7.4",
     "axios-mock-adapter": "1.20.0"
   }