@xchainjs/xchain-thorchain-amm 1.0.5 → 1.1.0

package/lib/index.esm.js

@@ -7,11 +7,11 @@ import { Network, FeeOption, Protocol } from '@xchainjs/xchain-client';
 import { AssetATOM, Client as Client$7 } from '@xchainjs/xchain-cosmos';
 import { Client as Client$3, defaultDogeParams } from '@xchainjs/xchain-doge';
 import { AssetETH, Client as Client$4, defaultEthParams } from '@xchainjs/xchain-ethereum';
+import { abi, MAX_APPROVAL } from '@xchainjs/xchain-evm';
 import { Client as Client$2, defaultLtcParams } from '@xchainjs/xchain-litecoin';
 import { THORChain, Client as Client$9, defaultClientConfig } from '@xchainjs/xchain-thorchain';
 import { ThorchainQuery, ThorchainCache, Thornode } from '@xchainjs/xchain-thorchain-query';
-import { abi } from '@xchainjs/xchain-evm';
-import { eqAsset, getContractAddressFromAsset as getContractAddressFromAsset$1 } from '@xchainjs/xchain-util';
+import { eqAsset, getContractAddressFromAsset as getContractAddressFromAsset$1, baseAmount as baseAmount$1 } from '@xchainjs/xchain-util';
 import { ethers } from 'ethers';
 
 /******************************************************************************
@@ -12596,7 +12596,8 @@ const isProtocolEVMChain = (chain) => {
  */
 const isProtocolERC20Asset = (asset) => {
     return isProtocolEVMChain(asset.chain)
-        ? [AssetETH, AssetAVAX, AssetBSC].findIndex((nativeEVMAsset) => eqAsset(nativeEVMAsset, asset)) === -1
+        ? [AssetETH, AssetAVAX, AssetBSC].findIndex((nativeEVMAsset) => eqAsset(nativeEVMAsset, asset)) === -1 &&
+            !asset.synth
         : false;
 };
 /**
@@ -12626,7 +12627,7 @@ class ThorchainAction {
             });
             return {
                 hash,
-                url: yield wallet.getExplorerTxUrl(assetAmount.asset.chain, hash),
+                url: yield wallet.getExplorerTxUrl(THORChain, hash),
             };
         });
     }
@@ -12832,6 +12833,27 @@ class ThorchainAMM {
             });
         });
     }
+    /**
+     * Approve the Thorchain router to spend a certain amount in the asset chain.
+     * @param {ApproveParams} approveParams Parameters for approving the router to spend
+     * @returns {Promise<TxSubmitted>} Transaction hash and URL
+     */
+    approveRouterToSpend({ asset, amount }) {
+        return __awaiter$6(this, void 0, void 0, function* () {
+            // Get inbound details for the asset chain
+            const inboundDetails = yield this.thorchainQuery.getChainInboundDetails(asset.chain);
+            if (!inboundDetails.router)
+                throw Error(`Unknown router address for ${asset.chain}`);
+            // Perform approval
+            const tx = yield this.wallet.approve(asset, (amount === null || amount === void 0 ? void 0 : amount.baseAmount) ||
+                baseAmount$1(MAX_APPROVAL.toString(), yield this.thorchainQuery.thorchainCache.midgardQuery.getDecimalForAsset(asset)), inboundDetails.router);
+            // Return transaction hash and URL
+            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

package/lib/index.js

@@ -11,10 +11,10 @@ var xchainClient = require('@xchainjs/xchain-client');
 var xchainCosmos = require('@xchainjs/xchain-cosmos');
 var xchainDoge = require('@xchainjs/xchain-doge');
 var xchainEthereum = require('@xchainjs/xchain-ethereum');
+var xchainEvm = require('@xchainjs/xchain-evm');
 var xchainLitecoin = require('@xchainjs/xchain-litecoin');
 var xchainThorchain = require('@xchainjs/xchain-thorchain');
 var xchainThorchainQuery = require('@xchainjs/xchain-thorchain-query');
-var xchainEvm = require('@xchainjs/xchain-evm');
 var xchainUtil = require('@xchainjs/xchain-util');
 var ethers = require('ethers');
 
@@ -12600,7 +12600,8 @@ const isProtocolEVMChain = (chain) => {
  */
 const isProtocolERC20Asset = (asset) => {
     return isProtocolEVMChain(asset.chain)
-        ? [xchainEthereum.AssetETH, xchainAvax.AssetAVAX, xchainBsc.AssetBSC].findIndex((nativeEVMAsset) => xchainUtil.eqAsset(nativeEVMAsset, asset)) === -1
+        ? [xchainEthereum.AssetETH, xchainAvax.AssetAVAX, xchainBsc.AssetBSC].findIndex((nativeEVMAsset) => xchainUtil.eqAsset(nativeEVMAsset, asset)) === -1 &&
+            !asset.synth
         : false;
 };
 /**
@@ -12630,7 +12631,7 @@ class ThorchainAction {
             });
             return {
                 hash,
-                url: yield wallet.getExplorerTxUrl(assetAmount.asset.chain, hash),
+                url: yield wallet.getExplorerTxUrl(xchainThorchain.THORChain, hash),
             };
         });
     }
@@ -12836,6 +12837,27 @@ class ThorchainAMM {
             });
         });
     }
+    /**
+     * Approve the Thorchain router to spend a certain amount in the asset chain.
+     * @param {ApproveParams} approveParams Parameters for approving the router to spend
+     * @returns {Promise<TxSubmitted>} Transaction hash and URL
+     */
+    approveRouterToSpend({ asset, amount }) {
+        return __awaiter$6(this, void 0, void 0, function* () {
+            // Get inbound details for the asset chain
+            const inboundDetails = yield this.thorchainQuery.getChainInboundDetails(asset.chain);
+            if (!inboundDetails.router)
+                throw Error(`Unknown router address for ${asset.chain}`);
+            // Perform approval
+            const tx = yield this.wallet.approve(asset, (amount === null || amount === void 0 ? void 0 : amount.baseAmount) ||
+                xchainUtil.baseAmount(xchainEvm.MAX_APPROVAL.toString(), yield this.thorchainQuery.thorchainCache.midgardQuery.getDecimalForAsset(asset)), inboundDetails.router);
+            // Return transaction hash and URL
+            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

package/lib/thorchain-amm.d.ts

@@ -1,7 +1,7 @@
 import { AddliquidityPosition, EstimateAddLP, EstimateAddSaver, EstimateWithdrawLP, EstimateWithdrawSaver, LoanCloseParams, LoanCloseQuote, LoanOpenParams, LoanOpenQuote, QuoteSwapParams, SaversPosition, SaversWithdraw, ThorchainQuery, TxDetails, WithdrawLiquidityPosition, getSaver } from '@xchainjs/xchain-thorchain-query';
 import { CryptoAmount } from '@xchainjs/xchain-util';
 import { Wallet } from '@xchainjs/xchain-wallet';
-import { IsApprovedParams, TxSubmitted } from './types';
+import { ApproveParams, IsApprovedParams, TxSubmitted } from './types';
 /**
  * THORChain Class for interacting with THORChain.
  * Recommended main class to use for swapping with THORChain
@@ -41,6 +41,12 @@ export declare class ThorchainAMM {
      * @returns {SwapSubmitted} - The transaction hash, URL of BlockExplorer, and expected wait time.
      */
     doSwap({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, toleranceBps, }: QuoteSwapParams): Promise<TxSubmitted>;
+    /**
+     * Approve the Thorchain router to spend a certain amount in the asset chain.
+     * @param {ApproveParams} approveParams Parameters for approving the router to spend
+     * @returns {Promise<TxSubmitted>} Transaction hash and URL
+     */
+    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

package/lib/types.d.ts

@@ -110,3 +110,7 @@ export type IsApprovedParams = {
     amount: CryptoAmount;
     address: Address;
 };
+export type ApproveParams = {
+    asset: Asset;
+    amount: CryptoAmount | undefined;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -24,7 +24,7 @@
     "url": "git@github.com:xchainjs/xchainjs-lib.git"
   },
   "scripts": {
-    "clean": "rimraf --glob ./lib/**",
+    "clean": "rm -rf .turbo && rm -rf lib",
     "build": "yarn clean && rollup -c",
     "test": "jest",
     "e2e": "jest --config jest.config.e2e.js",
@@ -44,6 +44,7 @@
     "@xchainjs/xchain-cosmos": "1.0.1",
     "@xchainjs/xchain-doge": "0.7.12",
     "@xchainjs/xchain-ethereum": "0.31.6",
+    "@xchainjs/xchain-evm": "0.4.5",
     "@xchainjs/xchain-litecoin": "0.13.11",
     "@xchainjs/xchain-thorchain": "1.0.4",
     "@xchainjs/xchain-thorchain-query": "0.7.7",
@@ -58,7 +59,6 @@
     "@xchainjs/xchain-client": "^0.16.2",
     "@xchainjs/xchain-crypto": "^0.3.1",
     "@xchainjs/xchain-thornode": "^0.3.11",
-    "@xchainjs/xchain-evm": "^0.4.5",
     "@xchainjs/xchain-midgard": "^0.5.2",
     "@xchainjs/xchain-utxo-providers": "^0.2.12",
     "axios": "^1.3.6",
@@ -100,4 +100,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}