@shapeshiftoss/swapper 9.14.0 → 9.15.0

package/dist/api.d.ts

@@ -129,10 +129,14 @@ export declare type ExecuteTradeInput<C extends ChainId> = {
 export declare type TradeResult = {
     tradeId: string;
 };
-export declare type ApproveInfiniteInput<C extends ChainId> = {
+export declare type ApproveInput<C extends ChainId> = {
     quote: TradeQuote<C>;
     wallet: HDWallet;
 };
+export declare type ApproveInfiniteInput<C extends ChainId> = ApproveInput<C>;
+export declare type ApproveAmountInput<C extends ChainId> = ApproveInput<C> & {
+    amount?: string;
+};
 export declare type ApprovalNeededInput<C extends ChainId> = {
     quote: TradeQuote<C>;
     wallet: HDWallet;
@@ -163,6 +167,7 @@ export declare type TradeTxs = {
 export declare enum SwapErrorTypes {
     ALLOWANCE_REQUIRED_FAILED = "ALLOWANCE_REQUIRED_FAILED",
     APPROVE_INFINITE_FAILED = "APPROVE_INFINITE_FAILED",
+    APPROVE_AMOUNT_FAILED = "APPROVE_AMOUNT_FAILED",
     BUILD_TRADE_FAILED = "BUILD_TRADE_FAILED",
     CHECK_APPROVAL_FAILED = "CHECK_APPROVAL_FAILED",
     EXECUTE_TRADE_FAILED = "EXECUTE_TRADE_FAILED",
@@ -187,7 +192,7 @@ export declare enum SwapErrorTypes {
     TRADE_FAILED = "TRADE_FAILED"
 }
 export interface Swapper<T extends ChainId> {
-    /** Human readable swapper name */
+    /** Human-readable swapper name */
     readonly name: string;
     /** perform any necessary async initialization */
     initialize?(): Promise<void>;
@@ -217,6 +222,11 @@ export interface Swapper<T extends ChainId> {
      * Get the txid of an approve infinite transaction
      */
     approveInfinite(args: ApproveInfiniteInput<T>): Promise<string>;
+    /**
+     * Get the txid of an approve amount transaction
+     * If no amount is specified the sell amount of the quote will be used
+     */
+    approveAmount(args: ApproveAmountInput<T>): Promise<string>;
     /**
      * Get supported buyAssetId's by sellAssetId
      */

package/dist/api.js

@@ -18,6 +18,7 @@ var SwapErrorTypes;
 (function (SwapErrorTypes) {
     SwapErrorTypes["ALLOWANCE_REQUIRED_FAILED"] = "ALLOWANCE_REQUIRED_FAILED";
     SwapErrorTypes["APPROVE_INFINITE_FAILED"] = "APPROVE_INFINITE_FAILED";
+    SwapErrorTypes["APPROVE_AMOUNT_FAILED"] = "APPROVE_AMOUNT_FAILED";
     SwapErrorTypes["BUILD_TRADE_FAILED"] = "BUILD_TRADE_FAILED";
     SwapErrorTypes["CHECK_APPROVAL_FAILED"] = "CHECK_APPROVAL_FAILED";
     SwapErrorTypes["EXECUTE_TRADE_FAILED"] = "EXECUTE_TRADE_FAILED";

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

@@ -21,6 +21,7 @@ export declare class CowSwapper implements Swapper<KnownChainIds.EthereumMainnet
     executeTrade(args: ExecuteTradeInput<KnownChainIds.EthereumMainnet>): Promise<TradeResult>;
     approvalNeeded(args: ApprovalNeededInput<KnownChainIds.EthereumMainnet>): Promise<ApprovalNeededOutput>;
     approveInfinite(args: ApproveInfiniteInput<KnownChainIds.EthereumMainnet>): Promise<string>;
+    approveAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(assetIds: AssetId[]): AssetId[];
     getTradeTxs(args: TradeResult): Promise<TradeTxs>;

package/dist/swappers/cow/CowSwapper.js

@@ -52,6 +52,11 @@ class CowSwapper {
     async approveInfinite(args) {
         return (0, cowApproveInfinite_1.cowApproveInfinite)(this.deps, args);
     }
+    async approveAmount() {
+        throw new api_1.SwapError('CowSwapper: approveAmount unimplemented', {
+            code: api_1.SwapErrorTypes.RESPONSE_ERROR
+        });
+    }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds = [], sellAssetId } = args;
         if ((0, caip_1.fromAssetId)(sellAssetId).assetNamespace !== 'erc20' ||

package/dist/swappers/osmosis/OsmosisSwapper.d.ts

@@ -15,6 +15,7 @@ export declare class OsmosisSwapper implements Swapper<ChainId> {
     }): Promise<MinMaxOutput>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
+    approveAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): string[];
     filterAssetIdsBySellable(): AssetId[];
     buildTrade(args: BuildTradeInput): Promise<Trade<ChainId>>;

package/dist/swappers/osmosis/OsmosisSwapper.js

@@ -51,6 +51,11 @@ class OsmosisSwapper {
             code: api_1.SwapErrorTypes.RESPONSE_ERROR
         });
     }
+    async approveAmount() {
+        throw new api_1.SwapError('Osmosis: approveAmount unimplemented', {
+            code: api_1.SwapErrorTypes.RESPONSE_ERROR
+        });
+    }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds = [], sellAssetId } = args;
         if (!this.supportedAssetIds.includes(sellAssetId))

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

@@ -14,6 +14,7 @@ export declare class TestSwapper implements Swapper<ChainId> {
     getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
+    approveAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(): AssetId[];
     buildTrade(): Promise<Trade<ChainId>>;

package/dist/swappers/test/TestSwapper.js

@@ -31,6 +31,11 @@ class TestSwapper {
     async approveInfinite() {
         throw new Error('TestSwapper: approveInfinite unimplemented');
     }
+    async approveAmount() {
+        throw new api_1.SwapError('TestSwapper: approveAmount unimplemented', {
+            code: api_1.SwapErrorTypes.RESPONSE_ERROR
+        });
+    }
     filterBuyAssetsBySellAssetId(args) {
         const { sellAssetId } = args;
         if (!this.supportAssets.includes(sellAssetId))

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

@@ -17,6 +17,7 @@ export declare class ThorchainSwapper implements Swapper<ChainId> {
     getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     approvalNeeded(input: ApprovalNeededInput<KnownChainIds.EthereumMainnet>): Promise<ApprovalNeededOutput>;
     approveInfinite(input: ApproveInfiniteInput<KnownChainIds.EthereumMainnet>): Promise<string>;
+    approveAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(): AssetId[];
     buildTrade(input: BuildTradeInput): Promise<Trade<ChainId>>;

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -85,6 +85,11 @@ class ThorchainSwapper {
     async approveInfinite(input) {
         return (0, thorTradeApproveInfinite_1.thorTradeApproveInfinite)({ deps: this.deps, input });
     }
+    async approveAmount() {
+        throw new api_1.SwapError('ThorchainSwapper: approveAmount unimplemented', {
+            code: api_1.SwapErrorTypes.RESPONSE_ERROR
+        });
+    }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds = [], sellAssetId } = args;
         if (!this.supportedSellAssetIds.includes(sellAssetId))

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

@@ -1,6 +1,6 @@
 import { Asset } from '@shapeshiftoss/asset-service';
 import { AssetId, ChainId } from '@shapeshiftoss/caip';
-import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, EvmSupportedChainIds, GetEvmTradeQuoteInput, Swapper, SwapperType, TradeQuote, TradeResult, TradeTxs } from '../../api';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveAmountInput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, EvmSupportedChainIds, GetEvmTradeQuoteInput, Swapper, SwapperType, TradeQuote, TradeResult, TradeTxs } from '../../api';
 import { ZrxExecuteTradeInput, ZrxSwapperDeps, ZrxTrade } from './types';
 export declare class ZrxSwapper<T extends EvmSupportedChainIds> implements Swapper<T> {
     readonly name = "0x";
@@ -14,6 +14,7 @@ export declare class ZrxSwapper<T extends EvmSupportedChainIds> implements Swapp
     executeTrade(args: ZrxExecuteTradeInput<T>): Promise<TradeResult>;
     approvalNeeded(args: ApprovalNeededInput<T>): Promise<ApprovalNeededOutput>;
     approveInfinite(args: ApproveInfiniteInput<T>): Promise<string>;
+    approveAmount(args: ApproveAmountInput<T>): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(assetIds?: AssetId[]): AssetId[];
     getTradeTxs(tradeResult: TradeResult): Promise<TradeTxs>;

package/dist/swappers/zrx/ZrxSwapper.js

@@ -7,7 +7,7 @@ const getZrxTradeQuote_1 = require("./getZrxTradeQuote/getZrxTradeQuote");
 const blacklist_1 = require("./utils/blacklist");
 const helpers_1 = require("./utils/helpers/helpers");
 const zrxApprovalNeeded_1 = require("./zrxApprovalNeeded/zrxApprovalNeeded");
-const zrxApproveInfinite_1 = require("./zrxApproveInfinite/zrxApproveInfinite");
+const zrxApprove_1 = require("./zrxApprove/zrxApprove");
 const zrxBuildTrade_1 = require("./zrxBuildTrade/zrxBuildTrade");
 const zrxExecuteTrade_1 = require("./zrxExecuteTrade/zrxExecuteTrade");
 class ZrxSwapper {
@@ -44,7 +44,10 @@ class ZrxSwapper {
         return (0, zrxApprovalNeeded_1.zrxApprovalNeeded)(this.deps, args);
     }
     async approveInfinite(args) {
-        return (0, zrxApproveInfinite_1.zrxApproveInfinite)(this.deps, args);
+        return (0, zrxApprove_1.zrxApproveInfinite)(this.deps, args);
+    }
+    async approveAmount(args) {
+        return (0, zrxApprove_1.zrxApproveAmount)(this.deps, args);
     }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds = [], sellAssetId } = args;

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

@@ -0,0 +1,4 @@
+import { ApproveAmountInput, ApproveInfiniteInput, EvmSupportedChainIds } from '../../../api';
+import { ZrxSwapperDeps } from '../types';
+export declare function zrxApproveAmount<T extends EvmSupportedChainIds>(deps: ZrxSwapperDeps, args: ApproveAmountInput<T>): Promise<string>;
+export declare function zrxApproveInfinite<T extends EvmSupportedChainIds>(deps: ZrxSwapperDeps, args: ApproveInfiniteInput<T>): Promise<string>;

package/dist/swappers/zrx/zrxApprove/zrxApprove.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zrxApproveInfinite = exports.zrxApproveAmount = void 0;
+const api_1 = require("../../../api");
+const erc20_abi_1 = require("../../utils/abi/erc20-abi");
+const constants_1 = require("../../utils/constants");
+const helpers_1 = require("../../utils/helpers/helpers");
+const constants_2 = require("../utils/constants");
+const grantAllowanceForAmount = async ({ adapter, web3 }, { quote, wallet }, approvalAmount) => {
+    const approvalQuote = {
+        ...quote,
+        sellAmount: approvalAmount,
+        feeData: {
+            ...quote.feeData,
+            chainSpecific: {
+                ...quote.feeData.chainSpecific,
+                // 0x approvals are cheaper than trades, but we don't have dynamic quote data for them.
+                // Instead, we use a hardcoded gasLimit estimate in place of the estimatedGas in the 0x quote response.
+                estimatedGas: constants_1.APPROVAL_GAS_LIMIT
+            }
+        }
+    };
+    return await (0, helpers_1.grantAllowance)({
+        quote: approvalQuote,
+        wallet,
+        adapter,
+        erc20Abi: erc20_abi_1.erc20Abi,
+        web3
+    });
+};
+async function zrxApproveAmount(deps, args) {
+    var _a;
+    try {
+        const sellAmount = args.quote.sellAmount;
+        // If no amount is specified we use the quotes sell amount
+        const approvalAmount = (_a = args.amount) !== null && _a !== void 0 ? _a : sellAmount;
+        return grantAllowanceForAmount(deps, args, approvalAmount);
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[zrxApproveAmount]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.APPROVE_AMOUNT_FAILED
+        });
+    }
+}
+exports.zrxApproveAmount = zrxApproveAmount;
+async function zrxApproveInfinite(deps, args) {
+    try {
+        return grantAllowanceForAmount(deps, args, constants_2.MAX_ALLOWANCE);
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[zrxApproveInfinite]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.APPROVE_INFINITE_FAILED
+        });
+    }
+}
+exports.zrxApproveInfinite = zrxApproveInfinite;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "9.14.0",
+  "version": "9.15.0",
   "description": "An interface and implementations to trade coins via various protocols",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",

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

@@ -1,3 +0,0 @@
-import { ApproveInfiniteInput, EvmSupportedChainIds } from '../../../api';
-import { ZrxSwapperDeps } from '../types';
-export declare function zrxApproveInfinite<T extends EvmSupportedChainIds>({ adapter, web3 }: ZrxSwapperDeps, { quote, wallet }: ApproveInfiniteInput<T>): Promise<string>;

package/dist/swappers/zrx/zrxApproveInfinite/zrxApproveInfinite.js

@@ -1,42 +0,0 @@
-"use strict";
-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 constants_1 = require("../../utils/constants");
-const helpers_1 = require("../../utils/helpers/helpers");
-const constants_2 = require("../utils/constants");
-async function zrxApproveInfinite({ adapter, web3 }, { quote, wallet }) {
-    try {
-        const approvalQuote = {
-            ...quote,
-            sellAmount: constants_2.MAX_ALLOWANCE,
-            feeData: {
-                ...quote.feeData,
-                chainSpecific: {
-                    ...quote.feeData.chainSpecific,
-                    // 0x approvals are cheaper than trades, but we don't have dynamic quote data for them.
-                    // Instead, we use a hardcoded gasLimit estimate in place of the estimatedGas in the 0x quote response.
-                    estimatedGas: constants_1.APPROVAL_GAS_LIMIT
-                }
-            }
-        };
-        const allowanceGrantRequired = await (0, helpers_1.grantAllowance)({
-            quote: approvalQuote,
-            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('[zrxApproveInfinite]', {
-            cause: e,
-            code: api_1.SwapErrorTypes.APPROVE_INFINITE_FAILED
-        });
-    }
-}
-exports.zrxApproveInfinite = zrxApproveInfinite;