@xchainjs/xchain-aggregator 1.0.2 → 1.0.4

package/lib/aggregator.d.ts

@@ -25,6 +25,7 @@ export declare class Aggregator {
      * Do swap
      * @param {QuoteSwapParams & { protocol?: Protocol }} params Swap parameters. If protocol is not set,
      * estimateSwap will be call and swap will be done in protocol with the greatest expected amount
+     * Approve the tx if needed
      * @returns the swap with the greatest expected amount estimated in the supported protocols
      */
     doSwap(params: QuoteSwapParams & {

package/lib/index.d.ts

@@ -1,2 +1,2 @@
 export { Aggregator } from './aggregator';
-export { IProtocol, QuoteSwapParams, QuoteSwap, TxSubmitted, SwapHistory, SwapHistoryParams, SwapResume, Config, } from './types';
+export { IProtocol, QuoteSwapParams, QuoteSwap, TxSubmitted, SwapHistory, SwapHistoryParams, SwapResume, Config, ApproveParams, IsApprovedParams, } from './types';

package/lib/index.esm.js

@@ -1,4 +1,4 @@
-import { CachedValue, isSynthAsset, isTradeAsset, CryptoAmount, baseAmount, eqAsset, assetFromStringEx, assetToString } from '@xchainjs/xchain-util';
+import { CachedValue, isSynthAsset, isTradeAsset, CryptoAmount, baseAmount, eqAsset, assetFromStringEx, assetToString, isTokenAsset } from '@xchainjs/xchain-util';
 import { AssetCacao, MAYAChain } from '@xchainjs/xchain-mayachain';
 import { MayachainAMM } from '@xchainjs/xchain-mayachain-amm';
 import { MayachainQuery } from '@xchainjs/xchain-mayachain-query';
@@ -25423,6 +25423,12 @@ class ChainflipProtocol {
             return this.sdk.getAssets();
         }, 24 * 60 * 60 * 1000);
     }
+    approveRouterToSpend(_params) {
+        throw new Error('Method not implemented.');
+    }
+    shouldBeApproved(_params) {
+        throw new Error('Method not implemented.');
+    }
     /**
      * Check if an asset is supported in the protocol
      * @param {Asset} asset Asset to check if it is supported
@@ -25593,6 +25599,33 @@ class MayachainProtocol {
         this.mayachainQuery = new MayachainQuery();
         this.mayachainAmm = new MayachainAMM(this.mayachainQuery, configuration === null || configuration === void 0 ? void 0 : configuration.wallet);
         this.configuration = configuration;
+        this.wallet = configuration === null || configuration === void 0 ? void 0 : configuration.wallet;
+    }
+    /**
+     * Aprove tx for ERC-20
+     * @param {ApproveParams} approveParams params to approve tx
+     * @returns {TxSubmitted} Transaction hash and URL of the swap
+     */
+    approveRouterToSpend(params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { asset, amount } = params;
+            const txSubmitted = yield this.mayachainAmm.approveRouterToSpend({ asset, amount });
+            yield ((_a = this.wallet) === null || _a === void 0 ? void 0 : _a.awaitTxConfirmed(asset.chain, txSubmitted.hash));
+            return 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) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { asset, amount, address } = params;
+            const errors = yield this.mayachainAmm.isRouterApprovedToSpend({ asset, amount, address });
+            return errors.some((error) => error === 'Maya router has not been approved to spend this amount');
+        });
     }
     /**
      * Check if an asset is supported in the protocol
@@ -25681,6 +25714,33 @@ class ThorchainProtocol {
         this.thorchainQuery = new ThorchainQuery();
         this.thorchainAmm = new ThorchainAMM(this.thorchainQuery, configuration === null || configuration === void 0 ? void 0 : configuration.wallet);
         this.configuration = configuration;
+        this.wallet = configuration === null || configuration === void 0 ? void 0 : configuration.wallet;
+    }
+    /**
+     * 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) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { asset, amount } = params;
+            const txSubmitted = yield this.thorchainAmm.approveRouterToSpend({ asset, amount });
+            yield ((_a = this.wallet) === null || _a === void 0 ? void 0 : _a.awaitTxConfirmed(asset.chain, txSubmitted.hash));
+            return 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) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { asset, amount, address } = params;
+            const errors = yield this.thorchainAmm.isRouterApprovedToSpend({ asset, amount, address });
+            return errors.some((error) => error === 'Thorchain router has not been approved to spend this amount');
+        });
     }
     /**
      * Check if an asset is supported in the protocol
@@ -25843,14 +25903,25 @@ class Aggregator {
      * Do swap
      * @param {QuoteSwapParams & { protocol?: Protocol }} params Swap parameters. If protocol is not set,
      * estimateSwap will be call and swap will be done in protocol with the greatest expected amount
+     * Approve the tx if needed
      * @returns the swap with the greatest expected amount estimated in the supported protocols
      */
     doSwap(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const protocolName = params.protocol ? params.protocol : (yield this.estimateSwap(params)).protocol;
             const protocol = this.protocols.find((protocol) => protocol.name === protocolName);
-            if (!protocol)
+            if (!protocol) {
                 throw Error(`${protocolName} protocol is not supported`);
+            }
+            if (isTokenAsset(params.fromAsset)) {
+                if (yield protocol.shouldBeApproved({
+                    asset: params.fromAsset,
+                    amount: params.amount,
+                    address: params.fromAddress || '',
+                })) {
+                    yield protocol.approveRouterToSpend({ asset: params.fromAsset, amount: params.amount });
+                }
+            }
             return protocol.doSwap(params);
         });
     }