@shapeshiftoss/swapper 7.1.0 → 7.3.0

package/dist/api.d.ts

@@ -151,6 +151,7 @@ export declare enum SwapErrorTypes {
     UNSUPPORTED_PAIR = "UNSUPPORTED_PAIR",
     USD_RATE_FAILED = "USD_RATE_FAILED",
     UNSUPPORTED_CHAIN = "UNSUPPORTED_CHAIN",
+    UNSUPPORTED_NAMESPACE = "UNSUPPORTED_NAMESPACE",
     VALIDATION_FAILED = "VALIDATION_FAILED",
     MAKE_MEMO_FAILED = "MAKE_MEMO_FAILED",
     PRICE_RATIO_FAILED = "PRICE_RATIO_FAILED",

package/dist/api.js

@@ -28,6 +28,7 @@ var SwapErrorTypes;
     SwapErrorTypes["UNSUPPORTED_PAIR"] = "UNSUPPORTED_PAIR";
     SwapErrorTypes["USD_RATE_FAILED"] = "USD_RATE_FAILED";
     SwapErrorTypes["UNSUPPORTED_CHAIN"] = "UNSUPPORTED_CHAIN";
+    SwapErrorTypes["UNSUPPORTED_NAMESPACE"] = "UNSUPPORTED_NAMESPACE";
     SwapErrorTypes["VALIDATION_FAILED"] = "VALIDATION_FAILED";
     SwapErrorTypes["MAKE_MEMO_FAILED"] = "MAKE_MEMO_FAILED";
     SwapErrorTypes["PRICE_RATIO_FAILED"] = "PRICE_RATIO_FAILED";

package/dist/swappers/cow/CowApprovalNeeded/CowApprovalNeeded.d.ts

@@ -0,0 +1,3 @@
+import { ApprovalNeededInput, ApprovalNeededOutput } from '../../../api';
+import { CowSwapperDeps } from '../CowSwapper';
+export declare function CowApprovalNeeded({ adapter, web3 }: CowSwapperDeps, { quote, wallet }: ApprovalNeededInput<'eip155:1'>): Promise<ApprovalNeededOutput>;

package/dist/swappers/cow/CowApprovalNeeded/CowApprovalNeeded.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CowApprovalNeeded = 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 COW_SWAP_VAULT_RELAYER_ADDRESS = '0xc92e8bdf79f0507f65a392b0ab4667716bfe0110';
+async function CowApprovalNeeded({ adapter, web3 }, { quote, wallet }) {
+    const { sellAsset } = quote;
+    const { assetReference: sellAssetErc20Address, assetNamespace } = (0, caip_1.fromAssetId)(sellAsset.assetId);
+    try {
+        if (assetNamespace !== 'erc20') {
+            throw new api_1.SwapError('[CowApprovalNeeded] - unsupported asset namespace', {
+                code: api_1.SwapErrorTypes.UNSUPPORTED_NAMESPACE,
+                details: { assetNamespace }
+            });
+        }
+        const receiveAddress = await adapter.getAddress({ wallet });
+        const allowanceResult = await (0, helpers_1.getERC20Allowance)({
+            web3,
+            erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
+            sellAssetErc20Address,
+            spenderAddress: COW_SWAP_VAULT_RELAYER_ADDRESS,
+            ownerAddress: receiveAddress
+        });
+        const allowanceOnChain = (0, bignumber_1.bnOrZero)(allowanceResult);
+        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('[CowApprovalNeeded]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.CHECK_APPROVAL_FAILED
+        });
+    }
+}
+exports.CowApprovalNeeded = CowApprovalNeeded;

package/dist/swappers/cow/CowApproveInfinite/CowApproveInfinite.d.ts

@@ -0,0 +1,3 @@
+import { ApproveInfiniteInput } from '../../../api';
+import { CowSwapperDeps } from '../CowSwapper';
+export declare function CowApproveInfinite({ adapter, web3 }: CowSwapperDeps, { quote, wallet }: ApproveInfiniteInput<'eip155:1'>): Promise<string>;

package/dist/swappers/cow/CowApproveInfinite/CowApproveInfinite.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CowApproveInfinite = void 0;
+const api_1 = require("../../../api");
+const erc20_abi_1 = require("../../utils/abi/erc20-abi");
+const helpers_1 = require("../../utils/helpers/helpers");
+const constants_1 = require("../utils/constants");
+async function CowApproveInfinite({ adapter, web3 }, { quote, wallet }) {
+    try {
+        const allowanceGrantRequired = await (0, helpers_1.grantAllowance)({
+            quote: {
+                ...quote,
+                sellAmount: constants_1.MAX_ALLOWANCE
+            },
+            wallet,
+            adapter,
+            erc20Abi: erc20_abi_1.erc20Abi,
+            web3
+        });
+        return allowanceGrantRequired;
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[CowApproveInfinite]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.APPROVE_INFINITE_FAILED
+        });
+    }
+}
+exports.CowApproveInfinite = CowApproveInfinite;

package/dist/swappers/cow/CowSwapper.d.ts

@@ -1,21 +1,25 @@
-import { AssetId, ChainId } from '@shapeshiftoss/caip';
+import { AssetId } from '@shapeshiftoss/caip';
+import { ethereum } from '@shapeshiftoss/chain-adapters';
 import { Asset } from '@shapeshiftoss/types';
+import Web3 from 'web3';
 import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetTradeQuoteInput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
 export declare type CowSwapperDeps = {
     apiUrl: string;
+    adapter: ethereum.ChainAdapter;
+    web3: Web3;
 };
-export declare class CowSwapper implements Swapper<ChainId> {
+export declare class CowSwapper implements Swapper<'eip155:1'> {
     static swapperName: string;
     deps: CowSwapperDeps;
     constructor(deps: CowSwapperDeps);
     initialize(): Promise<void>;
     getType(): SwapperType;
-    buildTrade(args: BuildTradeInput): Promise<Trade<ChainId>>;
-    getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<ChainId>>;
+    buildTrade(args: BuildTradeInput): Promise<Trade<'eip155:1'>>;
+    getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<'eip155:1'>>;
     getUsdRate(input: Asset): Promise<string>;
-    executeTrade(args: ExecuteTradeInput<ChainId>): Promise<TradeResult>;
-    approvalNeeded(args: ApprovalNeededInput<ChainId>): Promise<ApprovalNeededOutput>;
-    approveInfinite(args: ApproveInfiniteInput<ChainId>): Promise<string>;
+    executeTrade(args: ExecuteTradeInput<'eip155:1'>): Promise<TradeResult>;
+    approvalNeeded(args: ApprovalNeededInput<'eip155:1'>): Promise<ApprovalNeededOutput>;
+    approveInfinite(args: ApproveInfiniteInput<'eip155:1'>): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(assetIds: AssetId[]): AssetId[];
     getTradeTxs(): Promise<TradeTxs>;

package/dist/swappers/cow/CowSwapper.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CowSwapper = void 0;
 const api_1 = require("../../api");
+const CowApprovalNeeded_1 = require("./CowApprovalNeeded/CowApprovalNeeded");
+const CowApproveInfinite_1 = require("./CowApproveInfinite/CowApproveInfinite");
 const blacklist_1 = require("./utils/blacklist");
 const helpers_1 = require("./utils/helpers/helpers");
 class CowSwapper {
@@ -29,12 +31,10 @@ class CowSwapper {
         throw new Error('CowSwapper: executeTrade unimplemented');
     }
     async approvalNeeded(args) {
-        console.info(args);
-        throw new Error('CowSwapper: approvalNeeded unimplemented');
+        return (0, CowApprovalNeeded_1.CowApprovalNeeded)(this.deps, args);
     }
     async approveInfinite(args) {
-        console.info(args);
-        throw new Error('CowSwapper: approveInfinite unimplemented');
+        return (0, CowApproveInfinite_1.CowApproveInfinite)(this.deps, args);
     }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds = [], sellAssetId } = args;

package/dist/swappers/cow/utils/constants.d.ts

@@ -1 +1,2 @@
+export declare const MAX_ALLOWANCE = "100000000000000000000000000";
 export declare const MAX_COWSWAP_TRADE = "100000000000000000000000000";

package/dist/swappers/index.d.ts

@@ -1,3 +1,4 @@
 export * from './zrx/ZrxSwapper';
 export * from './thorchain/ThorchainSwapper';
 export * from './test/TestSwapper';
+export * from './cow/CowSwapper';

package/dist/swappers/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./zrx/ZrxSwapper"), exports);
 __exportStar(require("./thorchain/ThorchainSwapper"), exports);
 __exportStar(require("./test/TestSwapper"), exports);
+__exportStar(require("./cow/CowSwapper"), exports);

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/helpers/helpers.d.ts

@@ -1,7 +1,40 @@
+import { ethereum } from '@shapeshiftoss/chain-adapters';
+import { HDWallet } from '@shapeshiftoss/hdwallet-core';
+import { Asset } from '@shapeshiftoss/types';
+import BigNumber from 'bignumber.js';
+import Web3 from 'web3';
+import { AbiItem } from 'web3-utils';
+import { TradeQuote } from '../../../api';
 import { BN } from '../bignumber';
+export declare type GetAllowanceRequiredArgs = {
+    receiveAddress: string;
+    allowanceContract: string;
+    sellAsset: Asset;
+    sellAmount: string;
+    web3: Web3;
+    erc20AllowanceAbi: AbiItem[];
+};
+export declare type GetERC20AllowanceArgs = {
+    erc20AllowanceAbi: AbiItem[];
+    web3: Web3;
+    sellAssetErc20Address: string;
+    ownerAddress: string;
+    spenderAddress: string;
+};
+declare type GrantAllowanceArgs = {
+    quote: TradeQuote<'eip155:1'>;
+    wallet: HDWallet;
+    adapter: ethereum.ChainAdapter;
+    erc20Abi: AbiItem[];
+    web3: Web3;
+};
+export declare const getERC20Allowance: ({ erc20AllowanceAbi, web3, sellAssetErc20Address, ownerAddress, spenderAddress }: GetERC20AllowanceArgs) => Promise<any>;
+export declare const getAllowanceRequired: ({ receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi }: GetAllowanceRequiredArgs) => Promise<BigNumber>;
+export declare const grantAllowance: ({ quote, wallet, adapter, erc20Abi, web3 }: GrantAllowanceArgs) => Promise<string>;
 /**
  * This function keeps 17 significant digits, so even if we try to trade 1 Billion of an
  * ETH or ERC20, we still keep 7 decimal places.
  * @param amount
  */
 export declare const normalizeAmount: (amount: string | number | BN) => string;
+export {};

package/dist/swappers/utils/helpers/helpers.js

@@ -1,7 +1,104 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeAmount = void 0;
+exports.normalizeAmount = exports.grantAllowance = exports.getAllowanceRequired = exports.getERC20Allowance = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const web3_utils_1 = require("web3-utils");
+const api_1 = require("../../../api");
 const bignumber_1 = require("../bignumber");
+const getERC20Allowance = async ({ erc20AllowanceAbi, web3, sellAssetErc20Address, ownerAddress, spenderAddress }) => {
+    const erc20Contract = new web3.eth.Contract(erc20AllowanceAbi, sellAssetErc20Address);
+    return erc20Contract.methods.allowance(ownerAddress, spenderAddress).call();
+};
+exports.getERC20Allowance = getERC20Allowance;
+const getAllowanceRequired = async ({ receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi }) => {
+    try {
+        if (sellAsset.assetId === 'eip155:1/slip44:60') {
+            return (0, bignumber_1.bn)(0);
+        }
+        const ownerAddress = receiveAddress;
+        const spenderAddress = allowanceContract;
+        const { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(sellAsset.assetId);
+        const allowanceOnChain = await (0, exports.getERC20Allowance)({
+            web3,
+            erc20AllowanceAbi,
+            ownerAddress,
+            spenderAddress,
+            sellAssetErc20Address
+        });
+        if (allowanceOnChain === '0')
+            return (0, bignumber_1.bnOrZero)(sellAmount);
+        if (!allowanceOnChain) {
+            throw new api_1.SwapError(`[getAllowanceRequired] - No allowance data`, {
+                details: { allowanceContract, receiveAddress },
+                code: api_1.SwapErrorTypes.RESPONSE_ERROR
+            });
+        }
+        const allowanceRequired = (0, bignumber_1.bnOrZero)(sellAmount).minus(allowanceOnChain);
+        return allowanceRequired.lt(0) ? (0, bignumber_1.bn)(0) : allowanceRequired;
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[getAllowanceRequired]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.ALLOWANCE_REQUIRED_FAILED
+        });
+    }
+};
+exports.getAllowanceRequired = getAllowanceRequired;
+const grantAllowance = async ({ quote, wallet, adapter, erc20Abi, web3 }) => {
+    var _a, _b, _c, _d, _e;
+    try {
+        const { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(quote.sellAsset.assetId);
+        const erc20Contract = new web3.eth.Contract(erc20Abi, sellAssetErc20Address);
+        const approveTx = erc20Contract.methods
+            .approve(quote.allowanceContract, quote.sellAmount)
+            .encodeABI();
+        const accountNumber = quote.sellAssetAccountNumber;
+        const bip44Params = adapter.buildBIP44Params({ accountNumber });
+        const { txToSign } = await adapter.buildSendTransaction({
+            wallet,
+            to: sellAssetErc20Address,
+            bip44Params,
+            value: '0',
+            chainSpecific: {
+                erc20ContractAddress: sellAssetErc20Address,
+                gasPrice: (0, web3_utils_1.numberToHex)(((_b = (_a = quote.feeData) === null || _a === void 0 ? void 0 : _a.chainSpecific) === null || _b === void 0 ? void 0 : _b.gasPrice) || 0),
+                gasLimit: (0, web3_utils_1.numberToHex)(((_d = (_c = quote.feeData) === null || _c === void 0 ? void 0 : _c.chainSpecific) === null || _d === void 0 ? void 0 : _d.estimatedGas) || 0)
+            }
+        });
+        const grantAllowanceTxToSign = {
+            ...txToSign,
+            data: approveTx
+        };
+        if (wallet.supportsOfflineSigning()) {
+            const signedTx = await adapter.signTransaction({ txToSign: grantAllowanceTxToSign, wallet });
+            const broadcastedTxId = await adapter.broadcastTransaction(signedTx);
+            return broadcastedTxId;
+        }
+        else if (wallet.supportsBroadcast() && adapter.signAndBroadcastTransaction) {
+            const broadcastedTxId = await ((_e = adapter.signAndBroadcastTransaction) === null || _e === void 0 ? void 0 : _e.call(adapter, {
+                txToSign: grantAllowanceTxToSign,
+                wallet
+            }));
+            return broadcastedTxId;
+        }
+        else {
+            throw new api_1.SwapError('[grantAllowance] - invalid HDWallet config', {
+                code: api_1.SwapErrorTypes.SIGN_AND_BROADCAST_FAILED
+            });
+        }
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[grantAllowance]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.GRANT_ALLOWANCE_FAILED
+        });
+    }
+};
+exports.grantAllowance = grantAllowance;
 /**
  * This function keeps 17 significant digits, so even if we try to trade 1 Billion of an
  * ETH or ERC20, we still keep 7 decimal places.

package/dist/swappers/{zrx/utils/test-data/setupZrxDeps.d.ts → utils/test-data/setupDeps.d.ts}

@@ -1,6 +1,6 @@
 import { ethereum } from '@shapeshiftoss/chain-adapters';
 import Web3 from 'web3';
-export declare const setupZrxDeps: () => {
+export declare const setupDeps: () => {
     web3: Web3;
     adapter: ethereum.ChainAdapter;
 };

package/dist/swappers/{zrx/utils/test-data/setupZrxDeps.js → utils/test-data/setupDeps.js}

@@ -26,12 +26,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupZrxDeps = void 0;
+exports.setupDeps = void 0;
 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');
-const setupZrxDeps = () => {
+jest.mock('web3');
+const setupDeps = () => {
     const ethChainAdapter = new chain_adapters_1.ethereum.ChainAdapter({
         providers: {
             ws: new unchained.ws.Client('wss://dev-api.ethereum.shapeshift.com'),
@@ -45,4 +46,4 @@ const setupZrxDeps = () => {
     const web3Provider = new web3_1.default.providers.HttpProvider(ethNodeUrl);
     return { web3: new web3_1.default(web3Provider), adapter: ethChainAdapter };
 };
-exports.setupZrxDeps = setupZrxDeps;
+exports.setupDeps = setupDeps;

package/dist/swappers/utils/test-data/setupSwapQuote.d.ts

@@ -0,0 +1,8 @@
+import { Asset } from '@shapeshiftoss/types';
+import { TradeQuote } from '../../../api';
+export declare const setupQuote: () => {
+    quoteInput: import("../../../api").CommonTradeInput;
+    tradeQuote: TradeQuote<"eip155:1">;
+    buyAsset: Asset;
+    sellAsset: Asset;
+};

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupQuote = void 0;
+const assets_1 = require("./assets");
+const setupQuote = () => {
+    const sellAsset = { ...assets_1.FOX };
+    const buyAsset = { ...assets_1.WETH };
+    const tradeQuote = {
+        buyAmount: '',
+        sellAmount: '1000000000000000000',
+        sellAsset,
+        buyAsset,
+        allowanceContract: 'allowanceContractAddress',
+        sellAssetAccountNumber: 0,
+        minimum: '0',
+        maximum: '999999999999',
+        feeData: { fee: '0', tradeFee: '0', chainSpecific: {} },
+        rate: '1',
+        sources: []
+    };
+    const quoteInput = {
+        sellAmount: '1000000000000000000',
+        sellAsset,
+        buyAsset,
+        sellAssetAccountNumber: 0,
+        sendMax: false
+    };
+    return { quoteInput, tradeQuote, buyAsset, sellAsset };
+};
+exports.setupQuote = setupQuote;

package/dist/swappers/zrx/ZrxApprovalNeeded/ZrxApprovalNeeded.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZrxApprovalNeeded = 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 erc20Allowance_abi_1 = require("../utils/abi/erc20Allowance-abi");
-const helpers_1 = require("../utils/helpers/helpers");
+const helpers_1 = require("../../utils/helpers/helpers");
 async function ZrxApprovalNeeded({ adapter, web3 }, { quote, wallet }) {
     var _a;
     const { sellAsset } = quote;

package/dist/swappers/zrx/ZrxApproveInfinite/ZrxApproveInfinite.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZrxApproveInfinite = void 0;
 const api_1 = require("../../../api");
-const erc20_abi_1 = require("../utils/abi/erc20-abi");
+const erc20_abi_1 = require("../../utils/abi/erc20-abi");
+const helpers_1 = require("../../utils/helpers/helpers");
 const constants_1 = require("../utils/constants");
-const helpers_1 = require("../utils/helpers/helpers");
 async function ZrxApproveInfinite({ adapter, web3 }, { quote, wallet }) {
     try {
         const allowanceGrantRequired = await (0, helpers_1.grantAllowance)({

package/dist/swappers/zrx/utils/helpers/helpers.d.ts

@@ -1,34 +1,2 @@
-import { ethereum } from '@shapeshiftoss/chain-adapters';
-import { HDWallet } from '@shapeshiftoss/hdwallet-core';
 import { Asset } from '@shapeshiftoss/types';
-import Web3 from 'web3';
-import { AbiItem } from 'web3-utils';
-import { TradeQuote } from '../../../../api';
-import { BN } from '../../../utils/bignumber';
-export declare type GetAllowanceRequiredArgs = {
-    receiveAddress: string;
-    allowanceContract: string;
-    sellAsset: Asset;
-    sellAmount: string;
-    web3: Web3;
-    erc20AllowanceAbi: AbiItem[];
-};
-export declare type GetERC20AllowanceArgs = {
-    erc20AllowanceAbi: AbiItem[];
-    web3: Web3;
-    sellAssetErc20Address: string;
-    ownerAddress: string;
-    spenderAddress: string;
-};
-declare type GrantAllowanceArgs = {
-    quote: TradeQuote<'eip155:1'>;
-    wallet: HDWallet;
-    adapter: ethereum.ChainAdapter;
-    erc20Abi: AbiItem[];
-    web3: Web3;
-};
-export declare const getERC20Allowance: ({ erc20AllowanceAbi, web3, sellAssetErc20Address, ownerAddress, spenderAddress }: GetERC20AllowanceArgs) => Promise<any>;
-export declare const getAllowanceRequired: ({ receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi }: GetAllowanceRequiredArgs) => Promise<BN>;
 export declare const getUsdRate: (asset: Asset) => Promise<string>;
-export declare const grantAllowance: ({ quote, wallet, adapter, erc20Abi, web3 }: GrantAllowanceArgs) => Promise<string>;
-export {};

package/dist/swappers/zrx/utils/helpers/helpers.js

@@ -1,52 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.grantAllowance = exports.getUsdRate = exports.getAllowanceRequired = exports.getERC20Allowance = void 0;
+exports.getUsdRate = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
-const web3_utils_1 = require("web3-utils");
 const api_1 = require("../../../../api");
 const bignumber_1 = require("../../../utils/bignumber");
 const zrxService_1 = require("../zrxService");
-const getERC20Allowance = async ({ erc20AllowanceAbi, web3, sellAssetErc20Address, ownerAddress, spenderAddress }) => {
-    const erc20Contract = new web3.eth.Contract(erc20AllowanceAbi, sellAssetErc20Address);
-    return erc20Contract.methods.allowance(ownerAddress, spenderAddress).call();
-};
-exports.getERC20Allowance = getERC20Allowance;
-const getAllowanceRequired = async ({ receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi }) => {
-    try {
-        if (sellAsset.assetId === 'eip155:1/slip44:60') {
-            return (0, bignumber_1.bn)(0);
-        }
-        const ownerAddress = receiveAddress;
-        const spenderAddress = allowanceContract;
-        const { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(sellAsset.assetId);
-        const allowanceOnChain = await (0, exports.getERC20Allowance)({
-            web3,
-            erc20AllowanceAbi,
-            ownerAddress,
-            spenderAddress,
-            sellAssetErc20Address
-        });
-        if (allowanceOnChain === '0')
-            return (0, bignumber_1.bnOrZero)(sellAmount);
-        if (!allowanceOnChain) {
-            throw new api_1.SwapError(`[getAllowanceRequired] - No allowance data`, {
-                details: { allowanceContract, receiveAddress },
-                code: api_1.SwapErrorTypes.RESPONSE_ERROR
-            });
-        }
-        const allowanceRequired = (0, bignumber_1.bnOrZero)(sellAmount).minus(allowanceOnChain);
-        return allowanceRequired.lt(0) ? (0, bignumber_1.bn)(0) : allowanceRequired;
-    }
-    catch (e) {
-        if (e instanceof api_1.SwapError)
-            throw e;
-        throw new api_1.SwapError('[getAllowanceRequired]', {
-            cause: e,
-            code: api_1.SwapErrorTypes.ALLOWANCE_REQUIRED_FAILED
-        });
-    }
-};
-exports.getAllowanceRequired = getAllowanceRequired;
 const getUsdRate = async (asset) => {
     const { assetReference: erc20Address, assetNamespace } = (0, caip_1.fromAssetId)(asset.assetId);
     const { symbol } = asset;
@@ -78,56 +36,3 @@ const getUsdRate = async (asset) => {
     }
 };
 exports.getUsdRate = getUsdRate;
-const grantAllowance = async ({ quote, wallet, adapter, erc20Abi, web3 }) => {
-    var _a, _b, _c, _d, _e;
-    try {
-        const { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(quote.sellAsset.assetId);
-        const erc20Contract = new web3.eth.Contract(erc20Abi, sellAssetErc20Address);
-        const approveTx = erc20Contract.methods
-            .approve(quote.allowanceContract, quote.sellAmount)
-            .encodeABI();
-        const accountNumber = quote.sellAssetAccountNumber;
-        const bip44Params = adapter.buildBIP44Params({ accountNumber });
-        const { txToSign } = await adapter.buildSendTransaction({
-            wallet,
-            to: sellAssetErc20Address,
-            bip44Params,
-            value: '0',
-            chainSpecific: {
-                erc20ContractAddress: sellAssetErc20Address,
-                gasPrice: (0, web3_utils_1.numberToHex)(((_b = (_a = quote.feeData) === null || _a === void 0 ? void 0 : _a.chainSpecific) === null || _b === void 0 ? void 0 : _b.gasPrice) || 0),
-                gasLimit: (0, web3_utils_1.numberToHex)(((_d = (_c = quote.feeData) === null || _c === void 0 ? void 0 : _c.chainSpecific) === null || _d === void 0 ? void 0 : _d.estimatedGas) || 0)
-            }
-        });
-        const grantAllowanceTxToSign = {
-            ...txToSign,
-            data: approveTx
-        };
-        if (wallet.supportsOfflineSigning()) {
-            const signedTx = await adapter.signTransaction({ txToSign: grantAllowanceTxToSign, wallet });
-            const broadcastedTxId = await adapter.broadcastTransaction(signedTx);
-            return broadcastedTxId;
-        }
-        else if (wallet.supportsBroadcast() && adapter.signAndBroadcastTransaction) {
-            const broadcastedTxId = await ((_e = adapter.signAndBroadcastTransaction) === null || _e === void 0 ? void 0 : _e.call(adapter, {
-                txToSign: grantAllowanceTxToSign,
-                wallet
-            }));
-            return broadcastedTxId;
-        }
-        else {
-            throw new api_1.SwapError('[grantAllowance] - invalid HDWallet config', {
-                code: api_1.SwapErrorTypes.SIGN_AND_BROADCAST_FAILED
-            });
-        }
-    }
-    catch (e) {
-        if (e instanceof api_1.SwapError)
-            throw e;
-        throw new api_1.SwapError('[grantAllowance]', {
-            cause: e,
-            code: api_1.SwapErrorTypes.GRANT_ALLOWANCE_FAILED
-        });
-    }
-};
-exports.grantAllowance = grantAllowance;

package/dist/swappers/zrx/utils/test-data/{setupSwapQuote.d.ts → setupZrxSwapQuote.d.ts}

@@ -1,12 +1,5 @@
 import { Asset } from '@shapeshiftoss/types';
-import { TradeQuote } from '../../../../api';
 import { ZrxQuoteResponse } from '../../types';
-export declare const setupQuote: () => {
-    quoteInput: import("../../../../api").CommonTradeInput;
-    tradeQuote: TradeQuote<"eip155:1">;
-    buyAsset: Asset;
-    sellAsset: Asset;
-};
 export declare const setupZrxTradeQuoteResponse: () => {
     quoteResponse: ZrxQuoteResponse;
     buyAsset: Asset;

package/dist/swappers/zrx/utils/test-data/{setupSwapQuote.js → setupZrxSwapQuote.js}

@@ -1,33 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupExecuteTrade = exports.setupBuildTrade = exports.setupZrxTradeQuoteResponse = exports.setupQuote = void 0;
+exports.setupExecuteTrade = exports.setupBuildTrade = exports.setupZrxTradeQuoteResponse = void 0;
 const assets_1 = require("../../../utils/test-data/assets");
-const setupQuote = () => {
-    const sellAsset = { ...assets_1.FOX };
-    const buyAsset = { ...assets_1.WETH };
-    const tradeQuote = {
-        buyAmount: '',
-        sellAmount: '1000000000000000000',
-        sellAsset,
-        buyAsset,
-        allowanceContract: 'allowanceContractAddress',
-        sellAssetAccountNumber: 0,
-        minimum: '0',
-        maximum: '999999999999',
-        feeData: { fee: '0', tradeFee: '0', chainSpecific: {} },
-        rate: '1',
-        sources: []
-    };
-    const quoteInput = {
-        sellAmount: '1000000000000000000',
-        sellAsset,
-        buyAsset,
-        sellAssetAccountNumber: 0,
-        sendMax: false
-    };
-    return { quoteInput, tradeQuote, buyAsset, sellAsset };
-};
-exports.setupQuote = setupQuote;
 const setupZrxTradeQuoteResponse = () => {
     const sellAsset = { ...assets_1.FOX };
     const buyAsset = { ...assets_1.WETH };

package/dist/swappers/zrx/zrxBuildTrade/zrxBuildTrade.js

@@ -27,13 +27,13 @@ exports.zrxBuildTrade = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const rax = __importStar(require("retry-axios"));
 const __1 = require("../../..");
+const erc20Allowance_abi_1 = require("../../utils/abi/erc20Allowance-abi");
 const bignumber_1 = require("../../utils/bignumber");
 const constants_1 = require("../../utils/constants");
 const helpers_1 = require("../../utils/helpers/helpers");
-const erc20Allowance_abi_1 = require("../utils/abi/erc20Allowance-abi");
+const helpers_2 = require("../../utils/helpers/helpers");
 const applyAxiosRetry_1 = require("../utils/applyAxiosRetry");
 const constants_2 = require("../utils/constants");
-const helpers_2 = require("../utils/helpers/helpers");
 const zrxService_1 = require("../utils/zrxService");
 async function zrxBuildTrade({ adapter, web3 }, input) {
     var _a, _b, _c;
@@ -81,7 +81,7 @@ async function zrxBuildTrade({ adapter, web3 }, input) {
             params: {
                 buyToken,
                 sellToken,
-                sellAmount: (0, helpers_1.normalizeAmount)(sellAmount),
+                sellAmount: (0, helpers_2.normalizeAmount)(sellAmount),
                 takerAddress: receiveAddress,
                 slippagePercentage,
                 skipValidation: false,
@@ -110,7 +110,7 @@ async function zrxBuildTrade({ adapter, web3 }, input) {
             buyAmount: data.buyAmount,
             sources: ((_a = data.sources) === null || _a === void 0 ? void 0 : _a.filter((s) => parseFloat(s.proportion) > 0)) || constants_2.DEFAULT_SOURCE
         };
-        const allowanceRequired = await (0, helpers_2.getAllowanceRequired)({
+        const allowanceRequired = await (0, helpers_1.getAllowanceRequired)({
             sellAsset,
             allowanceContract: data.allowanceTarget,
             receiveAddress,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "7.1.0",
+  "version": "7.3.0",
   "description": "An interface and implementations to trade coins via various protocols",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -46,6 +46,7 @@
     "@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"
   }
 }