@shapeshiftoss/swapper 2.2.1 → 3.0.0

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { CAIP19 } from '@shapeshiftoss/caip';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SendMaxAmountInput, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SwapperType } from '@shapeshiftoss/types';
 export declare type SupportedAssetInput = {
     assetIds: CAIP19[];
 };
@@ -23,11 +23,11 @@ export interface Swapper {
     /**
      * Get a Quote along with an unsigned transaction that can be signed and broadcast to execute the swap
      **/
-    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes, SwapperType>>;
+    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes>>;
     /**
      * Get a basic quote (rate) for a trading pair
      */
-    getQuote(input: GetQuoteInput, wallet?: HDWallet): Promise<Quote<ChainTypes, SwapperType>>;
+    getQuote(input: GetQuoteInput, wallet?: HDWallet): Promise<Quote<ChainTypes>>;
     /**
      * Get the usd rate from either the assets symbol or tokenId
      */
@@ -43,19 +43,15 @@ export interface Swapper {
     /**
      * Execute a quote built with buildQuoteTx by signing and broadcasting
      */
-    executeQuote(args: ExecQuoteInput<ChainTypes, SwapperType>): Promise<ExecQuoteOutput>;
+    executeQuote(args: ExecQuoteInput<ChainTypes>): Promise<ExecQuoteOutput>;
     /**
      * Get a boolean if a quote needs approval
      */
-    approvalNeeded(args: ApprovalNeededInput<ChainTypes, SwapperType>): Promise<ApprovalNeededOutput>;
+    approvalNeeded(args: ApprovalNeededInput<ChainTypes>): Promise<ApprovalNeededOutput>;
     /**
      * Get the txid of an approve infinite transaction
      */
-    approveInfinite(args: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
-    /**
-     * Get max swap balance (minus fees) for sell asset
-     */
-    getSendMaxAmount(args: SendMaxAmountInput): Promise<string>;
+    approveInfinite(args: ApproveInfiniteInput<ChainTypes>): Promise<string>;
     /**
      * Get supported buyAssetId's by sellAssetId
      */

package/dist/swappers/test/TestSwapper.d.ts

@@ -9,15 +9,14 @@ export declare class TestSwapper implements Swapper {
     supportAssets: string[];
     getType(): SwapperType;
     constructor();
-    getQuote(): Promise<Quote<ChainTypes, SwapperType>>;
-    buildQuoteTx(): Promise<Quote<ChainTypes, SwapperType>>;
+    getQuote(): Promise<Quote<ChainTypes>>;
+    buildQuoteTx(): Promise<Quote<ChainTypes>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
     executeQuote(): Promise<ExecQuoteOutput>;
     getDefaultPair(): [CAIP19, CAIP19];
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
-    getSendMaxAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
     filterAssetIdsBySellable(): CAIP19[];
 }

package/dist/swappers/test/TestSwapper.js

@@ -43,9 +43,6 @@ class TestSwapper {
     async approveInfinite() {
         throw new Error('TestSwapper: approveInfinite unimplemented');
     }
-    async getSendMaxAmount() {
-        throw new Error('TestSwapper: getSendMaxAmount unimplemented');
-    }
     filterBuyAssetsBySellAssetId(args) {
         const { sellAssetId } = args;
         if (!this.supportAssets.includes(sellAssetId))

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

@@ -3,15 +3,14 @@ import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetQuoteInput
 import { Swapper } from '../../api';
 export declare class ThorchainSwapper implements Swapper {
     getType(): SwapperType;
-    getQuote(): Promise<Quote<ChainTypes, SwapperType>>;
-    buildQuoteTx(): Promise<Quote<ChainTypes, SwapperType>>;
+    getQuote(): Promise<Quote<ChainTypes>>;
+    buildQuoteTx(): Promise<Quote<ChainTypes>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
     executeQuote(): Promise<ExecQuoteOutput>;
     getDefaultPair(): [CAIP19, CAIP19];
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
-    getSendMaxAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(): CAIP19[];
     filterAssetIdsBySellable(): CAIP19[];
 }

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -32,9 +32,6 @@ class ThorchainSwapper {
     async approveInfinite() {
         throw new Error('ThorchainSwapper: approveInfinite unimplemented');
     }
-    async getSendMaxAmount() {
-        throw new Error('ThorchainSwapper: getSendMaxAmount unimplemented');
-    }
     filterBuyAssetsBySellAssetId() {
         return [];
     }

package/dist/swappers/zrx/ZrxApprovalNeeded/ZrxApprovalNeeded.d.ts

@@ -1,3 +1,3 @@
-import { ApprovalNeededInput, ApprovalNeededOutput, ChainTypes, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededInput, ApprovalNeededOutput, ChainTypes } from '@shapeshiftoss/types';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function ZrxApprovalNeeded({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApprovalNeededInput<ChainTypes, SwapperType>): Promise<ApprovalNeededOutput>;
+export declare function ZrxApprovalNeeded({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApprovalNeededInput<ChainTypes>): Promise<ApprovalNeededOutput>;

package/dist/swappers/zrx/ZrxApproveInfinite/ZrxApproveInfinite.d.ts

@@ -1,3 +1,3 @@
-import { ApproveInfiniteInput, ChainTypes, SwapperType } from '@shapeshiftoss/types';
+import { ApproveInfiniteInput, ChainTypes } from '@shapeshiftoss/types';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function ZrxApproveInfinite({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
+export declare function ZrxApproveInfinite({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApproveInfiniteInput<ChainTypes>): Promise<string>;

package/dist/swappers/zrx/ZrxBuildQuoteTx/ZrxBuildQuoteTx.d.ts

@@ -1,3 +1,3 @@
-import { BuildQuoteTxInput, ChainTypes, Quote, SwapperType } from '@shapeshiftoss/types';
+import { BuildQuoteTxInput, ChainTypes, Quote } from '@shapeshiftoss/types';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function ZrxBuildQuoteTx({ adapterManager, web3 }: ZrxSwapperDeps, { input, wallet }: BuildQuoteTxInput): Promise<Quote<ChainTypes, SwapperType>>;
+export declare function ZrxBuildQuoteTx({ adapterManager, web3 }: ZrxSwapperDeps, { input, wallet }: BuildQuoteTxInput): Promise<Quote<ChainTypes>>;

package/dist/swappers/zrx/ZrxExecuteQuote/ZrxExecuteQuote.d.ts

@@ -1,3 +1,3 @@
-import { ChainTypes, ExecQuoteInput, ExecQuoteOutput, SwapperType } from '@shapeshiftoss/types';
+import { ChainTypes, ExecQuoteInput, ExecQuoteOutput } from '@shapeshiftoss/types';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function ZrxExecuteQuote({ adapterManager }: ZrxSwapperDeps, { quote, wallet }: ExecQuoteInput<ChainTypes.Ethereum, SwapperType>): Promise<ExecQuoteOutput>;
+export declare function ZrxExecuteQuote({ adapterManager }: ZrxSwapperDeps, { quote, wallet }: ExecQuoteInput<ChainTypes.Ethereum>): Promise<ExecQuoteOutput>;

package/dist/swappers/zrx/ZrxSwapper.d.ts

@@ -1,6 +1,6 @@
 import { CAIP19 } from '@shapeshiftoss/caip';
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
-import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SendMaxAmountInput, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SwapperType } from '@shapeshiftoss/types';
 import Web3 from 'web3';
 import { BuyAssetBySellIdInput, Swapper } from '../../api';
 export declare type ZrxSwapperDeps = {
@@ -15,15 +15,14 @@ export declare class ZrxSwapper implements Swapper {
     deps: ZrxSwapperDeps;
     constructor(deps: ZrxSwapperDeps);
     getType(): SwapperType;
-    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes, SwapperType>>;
-    getQuote(input: GetQuoteInput): Promise<Quote<ChainTypes, SwapperType>>;
+    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes>>;
+    getQuote(input: GetQuoteInput): Promise<Quote<ChainTypes>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
     getDefaultPair(): [CAIP19, CAIP19];
-    executeQuote(args: ExecQuoteInput<ChainTypes, SwapperType>): Promise<ExecQuoteOutput>;
-    approvalNeeded(args: ApprovalNeededInput<ChainTypes, SwapperType>): Promise<ApprovalNeededOutput>;
-    approveInfinite(args: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
-    getSendMaxAmount(args: SendMaxAmountInput): Promise<string>;
+    executeQuote(args: ExecQuoteInput<ChainTypes>): Promise<ExecQuoteOutput>;
+    approvalNeeded(args: ApprovalNeededInput<ChainTypes>): Promise<ApprovalNeededOutput>;
+    approveInfinite(args: ApproveInfiniteInput<ChainTypes>): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
     filterAssetIdsBySellable(assetIds: CAIP19[]): CAIP19[];
 }

package/dist/swappers/zrx/ZrxSwapper.js

@@ -4,7 +4,6 @@ exports.ZrxSwapper = exports.ZrxError = void 0;
 const types_1 = require("@shapeshiftoss/types");
 const getZrxMinMax_1 = require("./getZrxMinMax/getZrxMinMax");
 const getZrxQuote_1 = require("./getZrxQuote/getZrxQuote");
-const getZrxSendMaxAmount_1 = require("./getZrxSendMaxAmount/getZrxSendMaxAmount");
 const helpers_1 = require("./utils/helpers/helpers");
 const ZrxApprovalNeeded_1 = require("./ZrxApprovalNeeded/ZrxApprovalNeeded");
 const ZrxApproveInfinite_1 = require("./ZrxApproveInfinite/ZrxApproveInfinite");
@@ -50,9 +49,6 @@ class ZrxSwapper {
     async approveInfinite(args) {
         return (0, ZrxApproveInfinite_1.ZrxApproveInfinite)(this.deps, args);
     }
-    async getSendMaxAmount(args) {
-        return (0, getZrxSendMaxAmount_1.getZrxSendMaxAmount)(this.deps, args);
-    }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds, sellAssetId } = args;
         // TODO: pending changes to caip lib, we may want to import caip2 value instead.

package/dist/swappers/zrx/getZrxQuote/getZrxQuote.d.ts

@@ -1,2 +1,2 @@
-import { ChainTypes, GetQuoteInput, Quote, SwapperType } from '@shapeshiftoss/types';
-export declare function getZrxQuote(input: GetQuoteInput): Promise<Quote<ChainTypes.Ethereum, SwapperType>>;
+import { ChainTypes, GetQuoteInput, Quote } from '@shapeshiftoss/types';
+export declare function getZrxQuote(input: GetQuoteInput): Promise<Quote<ChainTypes.Ethereum>>;

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

@@ -1,11 +1,11 @@
 import { ChainAdapter } from '@shapeshiftoss/chain-adapters';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import { Asset, ChainTypes, Quote, SwapperType } from '@shapeshiftoss/types';
+import { Asset, ChainTypes, Quote } from '@shapeshiftoss/types';
 import BigNumber from 'bignumber.js';
 import Web3 from 'web3';
 import { AbiItem } from 'web3-utils';
 export declare type GetAllowanceRequiredArgs = {
-    quote: Quote<ChainTypes, SwapperType>;
+    quote: Quote<ChainTypes>;
     web3: Web3;
     erc20AllowanceAbi: AbiItem[];
 };
@@ -17,7 +17,7 @@ export declare type GetERC20AllowanceArgs = {
     spenderAddress: string;
 };
 declare type GrantAllowanceArgs = {
-    quote: Quote<ChainTypes, SwapperType>;
+    quote: Quote<ChainTypes>;
     wallet: HDWallet;
     adapter: ChainAdapter<ChainTypes.Ethereum>;
     erc20Abi: AbiItem[];

package/dist/swappers/zrx/utils/test-data/assets.js

@@ -4,6 +4,8 @@ exports.FOX = exports.WETH = exports.BTC = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 exports.BTC = {
+    assetId: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+    chainId: 'bip122:000000000019d6689c085ae165831e93',
     caip19: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
     caip2: 'bip122:000000000019d6689c085ae165831e93',
     name: 'bitcoin',
@@ -24,6 +26,8 @@ exports.BTC = {
     symbol: 'BTC'
 };
 exports.WETH = {
+    assetId: 'eip155:1/erc20:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+    chainId: 'eip155:1',
     caip19: 'eip155:1/erc20:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
     caip2: 'eip155:1',
     name: 'WETH',
@@ -45,6 +49,8 @@ exports.WETH = {
     symbol: 'WETH'
 };
 exports.FOX = {
+    assetId: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d',
+    chainId: 'eip155:1',
     caip19: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d',
     caip2: 'eip155:1',
     name: 'FOX',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",

package/dist/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.d.ts

@@ -1,3 +0,0 @@
-import { SendMaxAmountInput } from '@shapeshiftoss/types';
-import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function getZrxSendMaxAmount({ adapterManager }: ZrxSwapperDeps, { wallet, quote, sellAssetAccountId, feeEstimateKey }: SendMaxAmountInput): Promise<string>;

package/dist/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.js

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getZrxSendMaxAmount = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const types_1 = require("@shapeshiftoss/types");
-const bignumber_js_1 = __importDefault(require("bignumber.js"));
-const api_1 = require("../../../api");
-const bignumber_1 = require("../utils/bignumber");
-const constants_1 = require("../utils/constants");
-async function getZrxSendMaxAmount({ adapterManager }, { wallet, quote, sellAssetAccountId, feeEstimateKey = types_1.chainAdapters.FeeDataKey.Average }) {
-    var _a, _b, _c;
-    const adapter = adapterManager.byChain(types_1.ChainTypes.Ethereum);
-    const bip44Params = adapter.buildBIP44Params({
-        accountNumber: (0, bignumber_1.bnOrZero)(sellAssetAccountId).toNumber()
-    });
-    const ethAddress = await adapter.getAddress({ wallet, bip44Params });
-    const account = await adapter.getAccount(ethAddress);
-    if (!quote.sellAsset) {
-        throw new api_1.SwapError('quote.sellAsset is required');
-    }
-    const tokenId = (_a = quote.sellAsset) === null || _a === void 0 ? void 0 : _a.tokenId;
-    let balance;
-    if (tokenId) {
-        balance = (_c = (_b = account.chainSpecific.tokens) === null || _b === void 0 ? void 0 : _b.find((token) => {
-            return caip_1.caip19.fromCAIP19(token.caip19).assetReference === tokenId.toLowerCase();
-        })) === null || _c === void 0 ? void 0 : _c.balance;
-    }
-    else {
-        balance = account.balance;
-    }
-    if (!balance) {
-        throw new api_1.SwapError(`No balance found for ${tokenId ? quote.sellAsset.symbol : 'ETH'}`);
-    }
-    // return the erc20 token balance. No need to subtract the fee.
-    if (tokenId && new bignumber_js_1.default(balance).gt(0)) {
-        return balance;
-    }
-    if (!quote.txData) {
-        throw new api_1.SwapError('quote.txData is required to get correct fee estimate');
-    }
-    const feeEstimates = await adapter.getFeeData({
-        to: quote.depositAddress,
-        value: (0, bignumber_1.bnOrZero)(quote.sellAmount).toString(),
-        chainSpecific: {
-            from: ethAddress,
-            contractData: quote.txData
-        }
-    });
-    const estimatedFee = feeEstimates[feeEstimateKey].txFee;
-    // (ryankk) We need to pad the fee for ETH max sends because the fee estimate is based off
-    // of a minimum quote value (quote.sellAmount) and not the users full ETH balance.
-    const paddedFee = new bignumber_js_1.default(estimatedFee).times(constants_1.ETH_FEE_ESTIMATE_PADDING);
-    const sendMaxAmount = new bignumber_js_1.default(balance).minus(paddedFee);
-    // gte covers if sendMaxAmount is NaN
-    if (!sendMaxAmount.gte(0)) {
-        throw new api_1.SwapError('ETH balance is less than estimated fee');
-    }
-    return sendMaxAmount.toString();
-}
-exports.getZrxSendMaxAmount = getZrxSendMaxAmount;