@shapeshiftoss/swapper 7.2.0 → 7.3.1

package/dist/swappers/thorchain/ThorchainSwapper.d.ts

@@ -1,6 +1,6 @@
 import { AssetId, ChainId } from '@shapeshiftoss/caip';
 import type { Asset } from '@shapeshiftoss/types';
-import { ApprovalNeededOutput, BuyAssetBySellIdInput, ExecuteTradeInput, GetTradeQuoteInput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
+import { ApprovalNeededInput, ApprovalNeededOutput, BuyAssetBySellIdInput, ExecuteTradeInput, GetTradeQuoteInput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
 import { ThorchainSwapperDeps } from './types';
 export declare class ThorchainSwapper implements Swapper<ChainId> {
     private swapSupportedChainIds;
@@ -10,7 +10,7 @@ export declare class ThorchainSwapper implements Swapper<ChainId> {
     initialize(): Promise<void>;
     getType(): SwapperType;
     getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
-    approvalNeeded(): Promise<ApprovalNeededOutput>;
+    approvalNeeded(input: ApprovalNeededInput<'eip155:1'>): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(): AssetId[];

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -4,6 +4,7 @@ exports.ThorchainSwapper = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const api_1 = require("../../api");
 const getTradeQuote_1 = require("./getThorTradeQuote/getTradeQuote");
+const thorTradeApprovalNeeded_1 = require("./thorTradeApprovalNeeded/thorTradeApprovalNeeded");
 const getUsdRate_1 = require("./utils/getUsdRate/getUsdRate");
 const thorService_1 = require("./utils/thorService");
 class ThorchainSwapper {
@@ -40,8 +41,8 @@ class ThorchainSwapper {
     getUsdRate(input) {
         return (0, getUsdRate_1.getUsdRate)({ deps: this.deps, input });
     }
-    async approvalNeeded() {
-        throw new Error('ThorchainSwapper: approvalNeeded unimplemented');
+    async approvalNeeded(input) {
+        return (0, thorTradeApprovalNeeded_1.thorTradeApprovalNeeded)({ deps: this.deps, input });
     }
     async approveInfinite() {
         throw new Error('ThorchainSwapper: approveInfinite unimplemented');

package/dist/swappers/thorchain/getThorTradeQuote/getTradeQuote.js

@@ -22,7 +22,7 @@ const getThorTradeQuote = async ({ deps, input }) => {
         const sellAssetChainId = (0, caip_1.toChainId)({ chainReference, chainNamespace });
         const adapter = deps.adapterManager.get(sellAssetChainId);
         if (!adapter)
-            throw new api_1.SwapError(`[getThorTxInfo] - No chain adapter found for ${sellAssetChainId}.`, {
+            throw new api_1.SwapError(`[getThorTradeQuote] - No chain adapter found for ${sellAssetChainId}.`, {
                 code: api_1.SwapErrorTypes.UNSUPPORTED_CHAIN,
                 details: { sellAssetChainId }
             });
@@ -51,7 +51,7 @@ const getThorTradeQuote = async ({ deps, input }) => {
                         sellAssetReference: sellAssetErc20Address
                     });
                 default:
-                    throw new api_1.SwapError('[getThorTxInfo] - Asset chainId is not supported.', {
+                    throw new api_1.SwapError('[getThorTradeQuote] - Asset chainId is not supported.', {
                         code: api_1.SwapErrorTypes.UNSUPPORTED_CHAIN,
                         details: { sellAssetChainId }
                     });
@@ -61,7 +61,7 @@ const getThorTradeQuote = async ({ deps, input }) => {
         const buyAssetId = buyAsset.assetId;
         const feeAssetId = (0, caip_1.getFeeAssetIdFromAssetId)(buyAssetId);
         if (!feeAssetId)
-            throw new api_1.SwapError(`[getThorTxInfo] - No feeAssetId found for ${buyAssetId}.`, {
+            throw new api_1.SwapError(`[getThorTradeQuote] - No feeAssetId found for ${buyAssetId}.`, {
                 code: api_1.SwapErrorTypes.VALIDATION_FAILED,
                 details: { buyAssetId }
             });

package/dist/swappers/thorchain/thorTradeApprovalNeeded/thorTradeApprovalNeeded.d.ts

@@ -0,0 +1,6 @@
+import { ApprovalNeededInput, ApprovalNeededOutput } from '../../../api';
+import { ThorchainSwapperDeps } from '../types';
+export declare const thorTradeApprovalNeeded: ({ deps, input }: {
+    deps: ThorchainSwapperDeps;
+    input: ApprovalNeededInput<'eip155:1'>;
+}) => Promise<ApprovalNeededOutput>;

package/dist/swappers/thorchain/thorTradeApprovalNeeded/thorTradeApprovalNeeded.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.thorTradeApprovalNeeded = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const api_1 = require("../../../api");
+const erc20Allowance_abi_1 = require("../../utils/abi/erc20Allowance-abi");
+const bignumber_1 = require("../../utils/bignumber");
+const helpers_1 = require("../../utils/helpers/helpers");
+const thorTradeApprovalNeeded = async ({ deps, input }) => {
+    var _a;
+    try {
+        const { quote, wallet } = input;
+        const { sellAsset } = quote;
+        const { adapterManager, web3 } = deps;
+        const { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(sellAsset.assetId);
+        const { chainNamespace } = (0, caip_1.fromChainId)(sellAsset.chainId);
+        if (chainNamespace !== 'eip155') {
+            throw new api_1.SwapError('[thorTradeApprovalNeeded] - sellAsset chain namespace is not supported', {
+                code: api_1.SwapErrorTypes.UNSUPPORTED_CHAIN,
+                details: { chainNamespace }
+            });
+        }
+        // No approval needed for selling a fee asset
+        if (sellAsset.assetId === (0, caip_1.getFeeAssetIdFromAssetId)(sellAsset.assetId)) {
+            return { approvalNeeded: false };
+        }
+        const accountNumber = quote.sellAssetAccountNumber;
+        const adapter = adapterManager.get(sellAsset.chainId);
+        if (!adapter)
+            throw new api_1.SwapError(`[thorTradeApprovalNeeded] - no chain adapter found for chain Id: ${sellAsset.chainId}`, {
+                code: api_1.SwapErrorTypes.UNSUPPORTED_CHAIN,
+                details: { chainId: sellAsset.chainId }
+            });
+        const bip44Params = adapter.buildBIP44Params({ accountNumber });
+        const receiveAddress = await adapter.getAddress({ wallet, bip44Params });
+        if (!quote.allowanceContract) {
+            throw new api_1.SwapError('[thorTradeApprovalNeeded] - allowanceTarget is required', {
+                code: api_1.SwapErrorTypes.VALIDATION_FAILED,
+                details: { chainId: sellAsset.chainId }
+            });
+        }
+        const allowanceResult = await (0, helpers_1.getERC20Allowance)({
+            web3,
+            erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
+            sellAssetErc20Address,
+            spenderAddress: quote.allowanceContract,
+            ownerAddress: receiveAddress
+        });
+        const allowanceOnChain = (0, bignumber_1.bnOrZero)(allowanceResult);
+        if (!((_a = quote.feeData.chainSpecific) === null || _a === void 0 ? void 0 : _a.gasPrice))
+            throw new api_1.SwapError('[thorTradeApprovalNeeded] - no gas price with quote', {
+                code: api_1.SwapErrorTypes.RESPONSE_ERROR,
+                details: { feeData: quote.feeData }
+            });
+        return {
+            approvalNeeded: allowanceOnChain.lte((0, bignumber_1.bnOrZero)(quote.sellAmount))
+        };
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[thorTradeApprovalNeeded]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.CHECK_APPROVAL_FAILED
+        });
+    }
+};
+exports.thorTradeApprovalNeeded = thorTradeApprovalNeeded;

package/dist/swappers/thorchain/types.d.ts

@@ -1,4 +1,5 @@
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
+import Web3 from 'web3';
 export declare type PoolResponse = {
     asset: string;
     assetDepth: string;
@@ -24,4 +25,5 @@ export declare type InboundResponse = {
 export declare type ThorchainSwapperDeps = {
     midgardUrl: string;
     adapterManager: ChainAdapterManager;
+    web3: Web3;
 };

package/dist/swappers/thorchain/utils/test-data/setupThorswapDeps.d.ts

@@ -0,0 +1,2 @@
+import { ThorchainSwapperDeps } from '../../types';
+export declare const setupThorswapDeps: () => ThorchainSwapperDeps;

package/dist/swappers/thorchain/utils/test-data/setupThorswapDeps.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupThorswapDeps = void 0;
+const web3_1 = __importDefault(require("web3"));
+jest.mock('web3');
+const setupThorswapDeps = () => {
+    const feeData = {
+        fast: {
+            txFee: '1',
+            chainSpecific: { approvalFee: '1', gasLimit: '1', gasPrice: '1' },
+            tradeFee: '2'
+        }
+    };
+    const adapterManager = new Map([
+        [
+            'eip155:1',
+            {
+                buildBIP44Params: jest.fn(() => ({ purpose: 44, coinType: 60, accountNumber: 0 })),
+                getAddress: jest.fn(() => Promise.resolve('0xthisIsMyAddress')),
+                getFeeData: jest.fn(() => feeData)
+            }
+        ]
+    ]);
+    const midgardUrl = 'localhost:3000';
+    const ethNodeUrl = 'http://localhost:1000';
+    const web3Provider = new web3_1.default.providers.HttpProvider(ethNodeUrl);
+    return { adapterManager, midgardUrl, web3: new web3_1.default(web3Provider) };
+};
+exports.setupThorswapDeps = setupThorswapDeps;

package/dist/swappers/utils/test-data/setupDeps.js

@@ -31,6 +31,7 @@ const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
 const unchained = __importStar(require("@shapeshiftoss/unchained-client"));
 const web3_1 = __importDefault(require("web3"));
 jest.mock('@shapeshiftoss/chain-adapters');
+jest.mock('web3');
 const setupDeps = () => {
     const ethChainAdapter = new chain_adapters_1.ethereum.ChainAdapter({
         providers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "7.2.0",
+  "version": "7.3.1",
   "description": "An interface and implementations to trade coins via various protocols",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -31,7 +31,7 @@
   },
   "peerDependencies": {
     "@shapeshiftoss/asset-service": "^5.0.0",
-    "@shapeshiftoss/caip": "^5.3.0",
+    "@shapeshiftoss/caip": "^6.0.1",
     "@shapeshiftoss/chain-adapters": "^6.0.1",
     "@shapeshiftoss/errors": "^1.1.1",
     "@shapeshiftoss/hdwallet-core": "^1.23.0",
@@ -39,13 +39,14 @@
   },
   "devDependencies": {
     "@shapeshiftoss/asset-service": "^5.0.0",
-    "@shapeshiftoss/caip": "^5.3.0",
+    "@shapeshiftoss/caip": "^6.0.1",
     "@shapeshiftoss/chain-adapters": "^6.0.1",
     "@shapeshiftoss/errors": "^1.1.1",
     "@shapeshiftoss/hdwallet-core": "^1.23.0",
     "@shapeshiftoss/types": "^5.0.0",
     "@types/readline-sync": "^1.4.4",
     "readline-sync": "^1.4.10",
-    "web3-utils": "^1.7.3"
+    "web3-utils": "^1.7.3",
+    "@shapeshiftoss/unchained-client": "^9.0.0"
   }
 }