@xchainjs/xchain-mayachain-amm 1.0.1 → 1.0.3

package/lib/index.esm.js

@@ -2,7 +2,7 @@ import { Client as Client$2, defaultBTCParams } from '@xchainjs/xchain-bitcoin';
 import { Network } from '@xchainjs/xchain-client';
 import { Client as Client$4, defaultDashParams } from '@xchainjs/xchain-dash';
 import { Client as Client$3, defaultEthParams, AssetETH } from '@xchainjs/xchain-ethereum';
-import { abi } from '@xchainjs/xchain-evm';
+import { MAX_APPROVAL, abi } from '@xchainjs/xchain-evm';
 import { Client as Client$1 } from '@xchainjs/xchain-cosmos-sdk';
 import { baseAmount, eqAsset, CryptoAmount, getContractAddressFromAsset as getContractAddressFromAsset$1 } from '@xchainjs/xchain-util';
 import { Client as Client$6, MAYAChain } from '@xchainjs/xchain-mayachain';
@@ -12380,6 +12380,26 @@ class Wallet {
             return client.deposit({ asset, amount, memo, walletIndex, sequence, gasLimit });
         });
     }
+    /**
+     * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
+     * @param {Asset} asset to check
+     * @param {BaseAmount} amount to check
+     * @param {string} fromAddress owner of the amount asset
+     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
+     * @throws {Error} if asset is a non ERC20 asset
+     */
+    approve(asset, amount, spenderAddress) {
+        return __awaiter$5(this, void 0, void 0, function* () {
+            const client = this.getClient(asset.chain);
+            if (!('approve' in client))
+                throw Error('Can not make approve over non EVM client');
+            if (asset.chain === asset.ticker)
+                throw Error('Can not make approve over native asset');
+            const contractAddress = getContractAddressFromAsset(asset);
+            return yield client.approve({ contractAddress, amount, spenderAddress });
+        });
+    }
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
      * @param {Asset} asset to check
@@ -12537,12 +12557,12 @@ class MayachainAMM {
                 errors.push(`affiliateBps ${affiliateBps} out of range [0 - 10000]`);
             }
             if (this.isERC20Asset(fromAsset) && fromAddress) {
-                const inboundDetails = yield this.mayachainQuery.getChainInboundDetails(fromAsset.chain);
-                if (!inboundDetails.router)
-                    throw Error(`Unknown router address for ${fromAsset.chain}`);
-                const isApprovedResult = yield this.wallet.isApproved(fromAsset, amount.baseAmount, fromAddress, inboundDetails.router);
-                if (!isApprovedResult)
-                    errors.push('Maya router has not been approved to spend this amount');
+                const approveErrors = yield this.isRouterApprovedToSpend({
+                    asset: fromAsset,
+                    address: fromAddress,
+                    amount,
+                });
+                errors.push(...approveErrors);
             }
             return errors;
         });
@@ -12571,6 +12591,41 @@ class MayachainAMM {
                 : this.doNonProtocolAssetSwap(amount, quoteSwap.toAddress, quoteSwap.memo);
         });
     }
+    /**
+     * Approve Mayachain router in the chain of the asset to spend the amount in name of the address
+     * @param {ApproveParams} approveParams contains the asset and amount the router will be allowed. If amount is not defined,
+     * an infinity approve will be done
+     */
+    approveRouterToSpend({ asset, amount }) {
+        return __awaiter$6(this, void 0, void 0, function* () {
+            const inboundDetails = yield this.mayachainQuery.getChainInboundDetails(asset.chain);
+            if (!inboundDetails.router)
+                throw Error(`Unknown router address for ${asset.chain}`);
+            const tx = yield this.wallet.approve(asset, (amount === null || amount === void 0 ? void 0 : amount.baseAmount) || baseAmount(MAX_APPROVAL.toString(), yield this.mayachainQuery.getAssetDecimals(asset)), inboundDetails.router);
+            return {
+                hash: tx.hash,
+                url: yield this.wallet.getExplorerTxUrl(asset.chain, tx.hash),
+            };
+        });
+    }
+    /**
+     * Validate if the asset router is allowed to spend the asset amount in name of the address
+     * @param {IsApprovedParams} isApprovedParams contains the asset and the amount the router is supposed to spend
+     * int name of address
+     * @returns {string[]} the reasons the router of the asset is not allowed to spend the amount. If it is empty, the asset router is allowed to spend the amount
+     */
+    isRouterApprovedToSpend({ asset, amount, address }) {
+        return __awaiter$6(this, void 0, void 0, function* () {
+            const errors = [];
+            const inboundDetails = yield this.mayachainQuery.getChainInboundDetails(asset.chain);
+            if (!inboundDetails.router)
+                throw Error(`Unknown router address for ${asset.chain}`);
+            const isApprovedResult = yield this.wallet.isApproved(asset, amount.baseAmount, address, inboundDetails.router);
+            if (!isApprovedResult)
+                errors.push('Maya router has not been approved to spend this amount');
+            return errors;
+        });
+    }
     /**
      * Check if a name is a valid MAYAName
      * @param {string} name MAYAName

package/lib/index.js

@@ -12384,6 +12384,26 @@ class Wallet {
             return client.deposit({ asset, amount, memo, walletIndex, sequence, gasLimit });
         });
     }
+    /**
+     * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
+     * @param {Asset} asset to check
+     * @param {BaseAmount} amount to check
+     * @param {string} fromAddress owner of the amount asset
+     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
+     * @throws {Error} if asset is a non ERC20 asset
+     */
+    approve(asset, amount, spenderAddress) {
+        return __awaiter$5(this, void 0, void 0, function* () {
+            const client = this.getClient(asset.chain);
+            if (!('approve' in client))
+                throw Error('Can not make approve over non EVM client');
+            if (asset.chain === asset.ticker)
+                throw Error('Can not make approve over native asset');
+            const contractAddress = getContractAddressFromAsset(asset);
+            return yield client.approve({ contractAddress, amount, spenderAddress });
+        });
+    }
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
      * @param {Asset} asset to check
@@ -12541,12 +12561,12 @@ class MayachainAMM {
                 errors.push(`affiliateBps ${affiliateBps} out of range [0 - 10000]`);
             }
             if (this.isERC20Asset(fromAsset) && fromAddress) {
-                const inboundDetails = yield this.mayachainQuery.getChainInboundDetails(fromAsset.chain);
-                if (!inboundDetails.router)
-                    throw Error(`Unknown router address for ${fromAsset.chain}`);
-                const isApprovedResult = yield this.wallet.isApproved(fromAsset, amount.baseAmount, fromAddress, inboundDetails.router);
-                if (!isApprovedResult)
-                    errors.push('Maya router has not been approved to spend this amount');
+                const approveErrors = yield this.isRouterApprovedToSpend({
+                    asset: fromAsset,
+                    address: fromAddress,
+                    amount,
+                });
+                errors.push(...approveErrors);
             }
             return errors;
         });
@@ -12575,6 +12595,41 @@ class MayachainAMM {
                 : this.doNonProtocolAssetSwap(amount, quoteSwap.toAddress, quoteSwap.memo);
         });
     }
+    /**
+     * Approve Mayachain router in the chain of the asset to spend the amount in name of the address
+     * @param {ApproveParams} approveParams contains the asset and amount the router will be allowed. If amount is not defined,
+     * an infinity approve will be done
+     */
+    approveRouterToSpend({ asset, amount }) {
+        return __awaiter$6(this, void 0, void 0, function* () {
+            const inboundDetails = yield this.mayachainQuery.getChainInboundDetails(asset.chain);
+            if (!inboundDetails.router)
+                throw Error(`Unknown router address for ${asset.chain}`);
+            const tx = yield this.wallet.approve(asset, (amount === null || amount === void 0 ? void 0 : amount.baseAmount) || xchainUtil.baseAmount(xchainEvm.MAX_APPROVAL.toString(), yield this.mayachainQuery.getAssetDecimals(asset)), inboundDetails.router);
+            return {
+                hash: tx.hash,
+                url: yield this.wallet.getExplorerTxUrl(asset.chain, tx.hash),
+            };
+        });
+    }
+    /**
+     * Validate if the asset router is allowed to spend the asset amount in name of the address
+     * @param {IsApprovedParams} isApprovedParams contains the asset and the amount the router is supposed to spend
+     * int name of address
+     * @returns {string[]} the reasons the router of the asset is not allowed to spend the amount. If it is empty, the asset router is allowed to spend the amount
+     */
+    isRouterApprovedToSpend({ asset, amount, address }) {
+        return __awaiter$6(this, void 0, void 0, function* () {
+            const errors = [];
+            const inboundDetails = yield this.mayachainQuery.getChainInboundDetails(asset.chain);
+            if (!inboundDetails.router)
+                throw Error(`Unknown router address for ${asset.chain}`);
+            const isApprovedResult = yield this.wallet.isApproved(asset, amount.baseAmount, address, inboundDetails.router);
+            if (!isApprovedResult)
+                errors.push('Maya router has not been approved to spend this amount');
+            return errors;
+        });
+    }
     /**
      * Check if a name is a valid MAYAName
      * @param {string} name MAYAName

package/lib/mayachain-amm.d.ts

@@ -1,6 +1,6 @@
 import { MayachainQuery, QuoteSwap, QuoteSwapParams } from '@xchainjs/xchain-mayachain-query';
 import { Wallet } from '@xchainjs/xchain-wallet';
-import { TxSubmitted } from './types';
+import { ApproveParams, IsApprovedParams, TxSubmitted } from './types';
 /**
  * MAYAChainAMM class for interacting with THORChain.
  * Recommended main class to use for swapping with MAYAChain
@@ -33,6 +33,19 @@ export declare class MayachainAMM {
      * @returns {TxSubmitted} the swap transaction hash and url
      */
     doSwap({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, toleranceBps, }: QuoteSwapParams): Promise<TxSubmitted>;
+    /**
+     * Approve Mayachain router in the chain of the asset to spend the amount in name of the address
+     * @param {ApproveParams} approveParams contains the asset and amount the router will be allowed. If amount is not defined,
+     * an infinity approve will be done
+     */
+    approveRouterToSpend({ asset, amount }: ApproveParams): Promise<TxSubmitted>;
+    /**
+     * Validate if the asset router is allowed to spend the asset amount in name of the address
+     * @param {IsApprovedParams} isApprovedParams contains the asset and the amount the router is supposed to spend
+     * int name of address
+     * @returns {string[]} the reasons the router of the asset is not allowed to spend the amount. If it is empty, the asset router is allowed to spend the amount
+     */
+    isRouterApprovedToSpend({ asset, amount, address }: IsApprovedParams): Promise<string[]>;
     /**
      * Check if a name is a valid MAYAName
      * @param {string} name MAYAName

package/lib/types.d.ts

@@ -1,4 +1,14 @@
+import { Address, Asset, CryptoAmount } from '@xchainjs/xchain-util';
 export type TxSubmitted = {
     hash: string;
     url: string;
 };
+export type ApproveParams = {
+    asset: Asset;
+    amount: CryptoAmount | undefined;
+};
+export type IsApprovedParams = {
+    asset: Asset;
+    amount: CryptoAmount;
+    address: Address;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-mayachain-amm",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "module that exposes estimating & swapping cryptocurrency assets on mayachain",
   "keywords": [
     "MAYAChain",
@@ -38,7 +38,8 @@
   "dependencies": {
     "@xchainjs/xchain-ethereum": "0.31.5",
     "@xchainjs/xchain-kujira": "0.1.7",
-    "@xchainjs/xchain-wallet": "0.1.0"
+    "@xchainjs/xchain-wallet": "0.1.1",
+    "@xchainjs/xchain-mayachain-query": "0.1.7"
   },
   "devDependencies": {
     "@cosmos-client/core": "0.46.1",
@@ -49,9 +50,9 @@
     "@xchainjs/xchain-crypto": "^0.3.1",
     "@xchainjs/xchain-dash": "^0.2.9",
     "@xchainjs/xchain-mayanode": "^0.1.3",
-    "@xchainjs/xchain-mayachain-query": "^0.1.6",
+    "@xchainjs/xchain-mayachain-query": "^0.1.7",
     "@xchainjs/xchain-evm": "^0.4.4",
-    "@xchainjs/xchain-mayachain": "^0.2.14",
+    "@xchainjs/xchain-mayachain": "^0.2.15",
     "@xchainjs/xchain-mayamidgard": "^0.1.1",
     "@xchainjs/xchain-thorchain": "^0.28.17",
     "@xchainjs/xchain-util": "^0.13.1",
@@ -76,9 +77,9 @@
     "@xchainjs/xchain-crypto": "^0.3.1",
     "@xchainjs/xchain-dash": "^0.2.9",
     "@xchainjs/xchain-mayanode": "^0.1.3",
-    "@xchainjs/xchain-mayachain-query": "^0.1.6",
+    "@xchainjs/xchain-mayachain-query": "^0.1.7",
     "@xchainjs/xchain-evm": "^0.4.4",
-    "@xchainjs/xchain-mayachain": "^0.2.14",
+    "@xchainjs/xchain-mayachain": "^0.2.15",
     "@xchainjs/xchain-mayamidgard": "^0.1.1",
     "@xchainjs/xchain-thorchain": "^0.28.17",
     "@xchainjs/xchain-util": "^0.13.1",