@shapeshiftoss/swapper 4.1.2 → 5.0.1

package/dist/api.d.ts

@@ -1,6 +1,28 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
 import { ApprovalNeededOutput, Asset, ChainSpecific, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SupportedChainIds, SwapperType } from '@shapeshiftoss/types';
+export declare const SwapError: {
+    new <V extends {
+        cause?: unknown;
+        details?: Record<string, unknown> | undefined;
+        code?: string | undefined;
+    }>(message?: string | undefined, options?: V | undefined): {
+        details: V extends {
+            details: infer R;
+        } ? R : undefined;
+        "__#1@#code"?: string | undefined;
+        code: string | undefined;
+        readonly cause: V extends {
+            cause: infer R_1;
+        } ? R_1 : undefined;
+        name: string;
+        message: string;
+        stack?: string | undefined;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
 export declare type SupportedAssetInput = {
     assetIds: AssetId[];
 };
@@ -80,7 +102,22 @@ export declare type ApprovalNeededInput<C extends SupportedChainIds> = {
     quote: TradeQuote<C>;
     wallet: HDWallet;
 };
-export declare class SwapError extends Error {
+export declare enum SwapErrorTypes {
+    ALLOWANCE_REQUIRED_FAILED = "ALLOWANCE_REQUIRED_FAILED",
+    CHECK_APPROVAL_FAILED = "CHECK_APPROVAL_FAILED",
+    APPROVE_INFINITE_FAILED = "APPROVE_INFINITE_FAILED",
+    BUILD_TRADE_FAILED = "BUILD_TRADE_FAILED",
+    EXECUTE_TRADE_FAILED = "EXECUTE_TRADE_FAILED",
+    GRANT_ALLOWANCE_FAILED = "GRANT_ALLOWANCE_FAILED",
+    MANAGER_ERROR = "MANAGER_ERROR",
+    MIN_MAX_FAILED = "MIN_MAX_FAILED",
+    SIGN_AND_BROADCAST_FAILED = "SIGN_AND_BROADCAST_FAILED",
+    TRADE_QUOTE_FAILED = "TRADE_QUOTE_FAILED",
+    UNSUPPORTED_PAIR = "UNSUPPORTED_PAIR",
+    USD_RATE_FAILED = "USD_RATE_FAILED",
+    UNSUPPORTED_CHAIN = "UNSUPPORTED_CHAIN",
+    VALIDATION_FAILED = "VALIDATION_FAILED",
+    RESPONSE_ERROR = "RESPONSE_ERROR"
 }
 export interface Swapper {
     /** Returns the swapper type */

package/dist/api.js

@@ -1,6 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SwapError = void 0;
-class SwapError extends Error {
-}
-exports.SwapError = SwapError;
+exports.SwapErrorTypes = exports.SwapError = void 0;
+const errors_1 = require("@shapeshiftoss/errors");
+exports.SwapError = (0, errors_1.createErrorClass)('SwapError');
+// Swap Errors
+var SwapErrorTypes;
+(function (SwapErrorTypes) {
+    SwapErrorTypes["ALLOWANCE_REQUIRED_FAILED"] = "ALLOWANCE_REQUIRED_FAILED";
+    SwapErrorTypes["CHECK_APPROVAL_FAILED"] = "CHECK_APPROVAL_FAILED";
+    SwapErrorTypes["APPROVE_INFINITE_FAILED"] = "APPROVE_INFINITE_FAILED";
+    SwapErrorTypes["BUILD_TRADE_FAILED"] = "BUILD_TRADE_FAILED";
+    SwapErrorTypes["EXECUTE_TRADE_FAILED"] = "EXECUTE_TRADE_FAILED";
+    SwapErrorTypes["GRANT_ALLOWANCE_FAILED"] = "GRANT_ALLOWANCE_FAILED";
+    SwapErrorTypes["MANAGER_ERROR"] = "MANAGER_ERROR";
+    SwapErrorTypes["MIN_MAX_FAILED"] = "MIN_MAX_FAILED";
+    SwapErrorTypes["SIGN_AND_BROADCAST_FAILED"] = "SIGN_AND_BROADCAST_FAILED";
+    SwapErrorTypes["TRADE_QUOTE_FAILED"] = "TRADE_QUOTE_FAILED";
+    SwapErrorTypes["UNSUPPORTED_PAIR"] = "UNSUPPORTED_PAIR";
+    SwapErrorTypes["USD_RATE_FAILED"] = "USD_RATE_FAILED";
+    SwapErrorTypes["UNSUPPORTED_CHAIN"] = "UNSUPPORTED_CHAIN";
+    SwapErrorTypes["VALIDATION_FAILED"] = "VALIDATION_FAILED";
+    SwapErrorTypes["RESPONSE_ERROR"] = "RESPONSE_ERROR";
+})(SwapErrorTypes = exports.SwapErrorTypes || (exports.SwapErrorTypes = {}));

package/dist/manager/SwapperManager.d.ts

@@ -1,8 +1,5 @@
 import { SwapperType } from '@shapeshiftoss/types';
 import { BuyAssetBySellIdInput, ByPairInput, SupportedSellAssetsInput, Swapper } from '..';
-export declare class SwapperError extends Error {
-    constructor(message: string);
-}
 export declare class SwapperManager {
     swappers: Map<SwapperType, Swapper>;
     constructor();

package/dist/manager/SwapperManager.js

@@ -3,18 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SwapperManager = exports.SwapperError = void 0;
+exports.SwapperManager = void 0;
 const uniq_1 = __importDefault(require("lodash/uniq"));
-class SwapperError extends Error {
-    constructor(message) {
-        super(message);
-        this.message = `SwapperError:${message}`;
-    }
-}
-exports.SwapperError = SwapperError;
+const api_1 = require("../api");
 function validateSwapper(swapper) {
     if (!(typeof swapper === 'object' && typeof swapper.getType === 'function'))
-        throw new SwapperError('validateSwapper - invalid swapper instance');
+        throw new api_1.SwapError('[validateSwapper] - invalid swapper instance', {
+            code: api_1.SwapErrorTypes.MANAGER_ERROR
+        });
 }
 // TODO: remove me
 class SwapperManager {
@@ -30,7 +26,10 @@ class SwapperManager {
     addSwapper(swapperType, swapperInstance) {
         const swapper = this.swappers.get(swapperType);
         if (swapper)
-            throw new SwapperError(`addSwapper - ${swapperType} already exists`);
+            throw new api_1.SwapError('[addSwapper] - swapper already exists', {
+                code: api_1.SwapErrorTypes.MANAGER_ERROR,
+                details: { swapperType }
+            });
         validateSwapper(swapperInstance);
         this.swappers.set(swapperType, swapperInstance);
         return this;
@@ -43,7 +42,10 @@ class SwapperManager {
     getSwapper(swapperType) {
         const swapper = this.swappers.get(swapperType);
         if (!swapper)
-            throw new SwapperError(`getSwapper - ${swapperType} doesn't exist`);
+            throw new api_1.SwapError('[getSwapper] - swapperType doesnt exist', {
+                code: api_1.SwapErrorTypes.MANAGER_ERROR,
+                details: { swapperType }
+            });
         return swapper;
     }
     /**
@@ -54,7 +56,10 @@ class SwapperManager {
     removeSwapper(swapperType) {
         const swapper = this.swappers.get(swapperType);
         if (!swapper)
-            throw new SwapperError(`removeSwapper - ${swapperType} doesn't exist`);
+            throw new api_1.SwapError('[removeSwapper] - swapperType doesnt exist', {
+                code: api_1.SwapErrorTypes.MANAGER_ERROR,
+                details: { swapperType }
+            });
         this.swappers.delete(swapperType);
         return this;
     }

package/dist/swappercli.js

@@ -14,7 +14,7 @@ const web3_1 = __importDefault(require("web3"));
 const SwapperManager_1 = require("./manager/SwapperManager");
 const ZrxSwapper_1 = require("./swappers/zrx/ZrxSwapper");
 dotenv_1.default.config();
-const { UNCHAINED_HTTP_API = 'http://localhost:31300', UNCHAINED_WS_API = 'wss://localhost:31300', ETH_NODE_URL = 'http://localhost:3000', DEVICE_ID = 'device123', MNEMONIC = 'salon adapt foil saddle orient make page zero cheese marble test catalog' } = process.env;
+const { UNCHAINED_HTTP_API = 'http://localhost:31300', UNCHAINED_WS_API = 'wss://localhost:31300', ETH_NODE_URL = 'http://localhost:3000', DEVICE_ID = 'device123', MNEMONIC = 'all all all all all all all all all all all all' } = process.env;
 const toBaseUnit = (amount, precision) => {
     return new bignumber_js_1.default(amount)
         .multipliedBy(new bignumber_js_1.default(10).exponentiatedBy(new bignumber_js_1.default(precision)))
@@ -86,13 +86,22 @@ const main = async () => {
     manager.addSwapper(types_1.SwapperType.Zrx, zrxSwapper);
     const swapper = manager.getSwapper(types_1.SwapperType.Zrx);
     const sellAmountBase = toBaseUnit(sellAmount, sellAsset.precision);
-    const quote = await swapper.getTradeQuote({
-        sellAsset,
-        buyAsset,
-        sellAmount: sellAmountBase,
-        sellAssetAccountId: '0',
-        sendMax: false
-    });
+    let quote;
+    try {
+        quote = await swapper.getTradeQuote({
+            sellAsset,
+            buyAsset,
+            sellAmount: sellAmountBase,
+            sellAssetAccountId: '0',
+            sendMax: false
+        });
+    }
+    catch (e) {
+        console.error(e);
+    }
+    if (!quote) {
+        return;
+    }
     console.info('quote = ', JSON.stringify(quote));
     if (!quote.success) {
         console.error('Obtaining the quote failed: ', quote.statusReason);

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

@@ -9,31 +9,53 @@ const helpers_1 = require("../utils/helpers/helpers");
 async function ZrxApprovalNeeded({ adapterManager, web3 }, { quote, wallet }) {
     var _a, _b;
     const { sellAsset } = quote;
-    if (sellAsset.chainId !== 'eip155:1') {
-        throw new api_1.SwapError('ZrxSwapper:ZrxApprovalNeeded only Ethereum chain type is supported');
+    try {
+        if (sellAsset.chainId !== 'eip155:1') {
+            throw new api_1.SwapError('[ZrxApprovalNeeded] - sellAsset chainId is not supported', {
+                code: api_1.SwapErrorTypes.UNSUPPORTED_CHAIN,
+                details: { chainId: sellAsset.chainId }
+            });
+        }
+        // No approval needed for trading eth itself
+        if (sellAsset.assetId === 'eip155:1/slip44:60') {
+            return { approvalNeeded: false };
+        }
+        const accountNumber = (0, bignumber_1.bnOrZero)(quote.sellAssetAccountId).toNumber();
+        const adapter = await adapterManager.byChainId(sellAsset.chainId);
+        const bip44Params = adapter.buildBIP44Params({ accountNumber });
+        const receiveAddress = await adapter.getAddress({ wallet, bip44Params });
+        if (!quote.sellAsset.tokenId || !quote.allowanceContract) {
+            throw new api_1.SwapError('[ZrxApprovalNeeded] - tokenId and allowanceTarget are required', {
+                code: api_1.SwapErrorTypes.VALIDATION_FAILED,
+                details: { chainId: sellAsset.chainId }
+            });
+        }
+        const allowanceResult = await (0, helpers_1.getERC20Allowance)({
+            web3,
+            erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
+            tokenId: quote.sellAsset.tokenId,
+            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('[ZrxApprovalNeeded] - 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)),
+            gas: constants_1.APPROVAL_GAS_LIMIT,
+            gasPrice: (_b = quote.feeData.chainSpecific) === null || _b === void 0 ? void 0 : _b.gasPrice
+        };
     }
-    if (sellAsset.symbol === 'ETH') {
-        return { approvalNeeded: false };
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[ZrxApprovalNeeded]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.CHECK_APPROVAL_FAILED
+        });
     }
-    const accountNumber = quote.sellAssetAccountId ? Number(quote.sellAssetAccountId) : 0;
-    const adapter = await adapterManager.byChainId(sellAsset.chainId);
-    const bip44Params = adapter.buildBIP44Params({ accountNumber });
-    const receiveAddress = await adapter.getAddress({ wallet, bip44Params });
-    if (!quote.sellAsset.tokenId || !quote.allowanceContract) {
-        throw new api_1.SwapError('ZrxApprovalNeeded - tokenId and allowanceTarget are required');
-    }
-    const allowanceResult = await (0, helpers_1.getERC20Allowance)({
-        web3,
-        erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
-        tokenId: quote.sellAsset.tokenId,
-        spenderAddress: quote.allowanceContract,
-        ownerAddress: receiveAddress
-    });
-    const allowanceOnChain = (0, bignumber_1.bnOrZero)(allowanceResult);
-    return {
-        approvalNeeded: allowanceOnChain.lte((0, bignumber_1.bnOrZero)(quote.sellAmount)),
-        gas: constants_1.APPROVAL_GAS_LIMIT,
-        gasPrice: (_b = (_a = quote === null || quote === void 0 ? void 0 : quote.feeData) === null || _a === void 0 ? void 0 : _a.chainSpecific) === null || _b === void 0 ? void 0 : _b.gasPrice
-    };
 }
 exports.ZrxApprovalNeeded = ZrxApprovalNeeded;

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

@@ -1,21 +1,31 @@
 "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");
 async function ZrxApproveInfinite({ adapterManager, web3 }, { quote, wallet }) {
-    const allowanceGrantRequired = await (0, helpers_1.grantAllowance)({
-        quote: {
-            ...quote,
-            allowanceContract: quote.allowanceContract,
-            sellAmount: constants_1.MAX_ALLOWANCE
-        },
-        wallet,
-        adapterManager,
-        erc20Abi: erc20_abi_1.erc20Abi,
-        web3
-    });
-    return allowanceGrantRequired;
+    try {
+        const allowanceGrantRequired = await (0, helpers_1.grantAllowance)({
+            quote: {
+                ...quote,
+                sellAmount: constants_1.MAX_ALLOWANCE
+            },
+            wallet,
+            adapterManager,
+            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;

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

@@ -7,9 +7,6 @@ export declare type ZrxSwapperDeps = {
     adapterManager: ChainAdapterManager;
     web3: Web3;
 };
-export declare class ZrxError extends Error {
-    constructor(message: string);
-}
 export declare class ZrxSwapper implements Swapper {
     static swapperName: string;
     deps: ZrxSwapperDeps;

package/dist/swappers/zrx/ZrxSwapper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZrxSwapper = exports.ZrxError = void 0;
+exports.ZrxSwapper = void 0;
 const types_1 = require("@shapeshiftoss/types");
 const getZrxMinMax_1 = require("./getZrxMinMax/getZrxMinMax");
 const getZrxTradeQuote_1 = require("./getZrxTradeQuote/getZrxTradeQuote");
@@ -9,13 +9,6 @@ const ZrxApprovalNeeded_1 = require("./ZrxApprovalNeeded/ZrxApprovalNeeded");
 const ZrxApproveInfinite_1 = require("./ZrxApproveInfinite/ZrxApproveInfinite");
 const zrxBuildTrade_1 = require("./zrxBuildTrade/zrxBuildTrade");
 const zrxExecuteTrade_1 = require("./zrxExecuteTrade/zrxExecuteTrade");
-class ZrxError extends Error {
-    constructor(message) {
-        super(message);
-        this.message = `ZrxError:${message}`;
-    }
-}
-exports.ZrxError = ZrxError;
 class ZrxSwapper {
     constructor(deps) {
         this.deps = deps;

package/dist/swappers/zrx/getZrxMinMax/getZrxMinMax.js

@@ -1,22 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getZrxMinMax = void 0;
+const api_1 = require("../../../api");
 const bignumber_1 = require("../utils/bignumber");
 const constants_1 = require("../utils/constants");
 const helpers_1 = require("../utils/helpers/helpers");
-const ZrxSwapper_1 = require("../ZrxSwapper");
 const getZrxMinMax = async (sellAsset, buyAsset) => {
-    if (sellAsset.chainId !== 'eip155:1' || buyAsset.chainId !== 'eip155:1') {
-        throw new ZrxSwapper_1.ZrxError('getZrxMinMax - must be eth assets');
+    try {
+        if (sellAsset.chainId !== 'eip155:1' || buyAsset.chainId !== 'eip155:1') {
+            throw new api_1.SwapError('[getZrxMinMax]', { code: api_1.SwapErrorTypes.UNSUPPORTED_PAIR });
+        }
+        const usdRate = await (0, helpers_1.getUsdRate)({ ...sellAsset });
+        const minimum = (0, bignumber_1.bn)(1).dividedBy((0, bignumber_1.bnOrZero)(usdRate)).toString(); // $1 worth of the sell token.
+        const maximum = constants_1.MAX_ZRX_TRADE; // Arbitrarily large value. 10e+28 here.
+        return {
+            minimum,
+            maximum
+        };
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[getZrxMinMax]', { cause: e, code: api_1.SwapErrorTypes.MIN_MAX_FAILED });
     }
-    const usdRate = await (0, helpers_1.getUsdRate)({
-        symbol: sellAsset.symbol,
-        tokenId: sellAsset.tokenId
-    });
-    const minimum = (0, bignumber_1.bn)(1).dividedBy((0, bignumber_1.bnOrZero)(usdRate)).toString();
-    return {
-        minimum,
-        maximum: constants_1.MAX_ZRX_TRADE // Arbitrarily large value. 10e+28 here.
-    };
 };
 exports.getZrxMinMax = getZrxMinMax;

package/dist/swappers/zrx/getZrxTradeQuote/getZrxTradeQuote.js

@@ -1,31 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getZrxTradeQuote = void 0;
+const api_1 = require("../../../api");
 const getZrxMinMax_1 = require("../getZrxMinMax/getZrxMinMax");
 const bignumber_1 = require("../utils/bignumber");
 const constants_1 = require("../utils/constants");
 const helpers_1 = require("../utils/helpers/helpers");
 const zrxService_1 = require("../utils/zrxService");
-const ZrxSwapper_1 = require("../ZrxSwapper");
 async function getZrxTradeQuote(input) {
-    var _a, _b, _c, _d, _e, _f, _g;
-    const { sellAsset, buyAsset, sellAmount, sellAssetAccountId } = input;
-    if (!buyAsset) {
-        throw new ZrxSwapper_1.ZrxError('getQuote - Missing buyAsset');
-    }
-    if (!sellAsset) {
-        throw new ZrxSwapper_1.ZrxError('getQuote - Missing sellAsset');
-    }
-    if (buyAsset.chainId !== 'eip155:1' || sellAsset.chainId !== 'eip155:1') {
-        throw new ZrxSwapper_1.ZrxError('getQuote - Both assets need to be on the Ethereum chain to use Zrx');
-    }
-    const useSellAmount = !!sellAmount;
-    const buyToken = buyAsset.tokenId || buyAsset.symbol;
-    const sellToken = sellAsset.tokenId || sellAsset.symbol;
-    const { minimum, maximum } = await (0, getZrxMinMax_1.getZrxMinMax)(sellAsset, buyAsset);
-    const minQuoteSellAmount = (0, bignumber_1.bnOrZero)(minimum).times((0, bignumber_1.bn)(10).exponentiatedBy(sellAsset.precision));
-    const normalizedSellAmount = (0, helpers_1.normalizeAmount)((0, bignumber_1.bnOrZero)(sellAmount).eq(0) ? minQuoteSellAmount.toString() : sellAmount);
+    var _a;
     try {
+        const { sellAsset, buyAsset, sellAmount, sellAssetAccountId } = input;
+        if (buyAsset.chainId !== 'eip155:1' || sellAsset.chainId !== 'eip155:1') {
+            throw new api_1.SwapError('[getZrxTradeQuote] - Both assets need to be on the Ethereum chain to use Zrx', {
+                code: api_1.SwapErrorTypes.UNSUPPORTED_PAIR,
+                details: { buyAssetChainId: buyAsset.chainId, sellAssetChainId: sellAsset.chainId }
+            });
+        }
+        const useSellAmount = !!sellAmount;
+        const buyToken = buyAsset.tokenId || buyAsset.symbol;
+        const sellToken = sellAsset.tokenId || sellAsset.symbol;
+        const { minimum, maximum } = await (0, getZrxMinMax_1.getZrxMinMax)(sellAsset, buyAsset);
+        const minQuoteSellAmount = (0, bignumber_1.bnOrZero)(minimum).times((0, bignumber_1.bn)(10).exponentiatedBy(sellAsset.precision));
+        const normalizedSellAmount = (0, helpers_1.normalizeAmount)((0, bignumber_1.bnOrZero)(sellAmount).eq(0) ? minQuoteSellAmount.toString() : sellAmount);
         /**
          * /swap/v1/price
          * params: {
@@ -70,25 +67,9 @@ async function getZrxTradeQuote(input) {
         };
     }
     catch (e) {
-        const statusReason = ((_e = (_d = (_c = (_b = e === null || e === void 0 ? void 0 : e.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.validationErrors) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.reason) ||
-            ((_g = (_f = e === null || e === void 0 ? void 0 : e.response) === null || _f === void 0 ? void 0 : _f.data) === null || _g === void 0 ? void 0 : _g.reason) ||
-            'Unknown Error';
-        // This hackyness will go away when we correctly handle errors
-        return {
-            success: false,
-            statusReason,
-            maximum: '0',
-            minimum: '0',
-            rate: '0',
-            feeData: { fee: '0', chainSpecific: {} },
-            buyAmount: '0',
-            sellAmount: '0',
-            sources: [],
-            allowanceContract: '0',
-            buyAsset,
-            sellAsset,
-            sellAssetAccountId
-        };
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[getZrxTradeQuote]', { cause: e, code: api_1.SwapErrorTypes.TRADE_QUOTE_FAILED });
     }
 }
 exports.getZrxTradeQuote = getZrxTradeQuote;

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.grantAllowance = exports.getUsdRate = exports.getAllowanceRequired = exports.getERC20Allowance = exports.normalizeAmount = void 0;
 const web3_utils_1 = require("web3-utils");
 const api_1 = require("../../../../api");
-const ZrxSwapper_1 = require("../../ZrxSwapper");
 const bignumber_1 = require("../bignumber");
 const zrxService_1 = require("../zrxService");
 /**
@@ -26,64 +25,91 @@ const getERC20Allowance = async ({ erc20AllowanceAbi, web3, tokenId, ownerAddres
 };
 exports.getERC20Allowance = getERC20Allowance;
 const getAllowanceRequired = async ({ receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi }) => {
-    if (sellAsset.symbol === 'ETH') {
-        return (0, bignumber_1.bn)(0);
-    }
-    const ownerAddress = receiveAddress;
-    const spenderAddress = allowanceContract;
-    const tokenId = sellAsset.tokenId;
-    if (!ownerAddress || !spenderAddress || !tokenId) {
-        throw new api_1.SwapError('getAllowanceRequired - receiveAddress, allowanceContract and tokenId are required');
-    }
-    const allowanceOnChain = await (0, exports.getERC20Allowance)({
-        web3,
-        erc20AllowanceAbi,
-        ownerAddress,
-        spenderAddress,
-        tokenId
-    });
-    if (allowanceOnChain === '0') {
-        return (0, bignumber_1.bnOrZero)(sellAmount);
+    try {
+        if (sellAsset.assetId === 'eip155:1/slip44:60') {
+            return (0, bignumber_1.bn)(0);
+        }
+        const ownerAddress = receiveAddress;
+        const spenderAddress = allowanceContract;
+        const tokenId = sellAsset.tokenId;
+        if (!tokenId) {
+            throw new api_1.SwapError('[getAllowanceRequired] - sellAsset.tokenId is required', {
+                code: api_1.SwapErrorTypes.VALIDATION_FAILED
+            });
+        }
+        const allowanceOnChain = await (0, exports.getERC20Allowance)({
+            web3,
+            erc20AllowanceAbi,
+            ownerAddress,
+            spenderAddress,
+            tokenId
+        });
+        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;
     }
-    if (!allowanceOnChain) {
-        throw new api_1.SwapError(`No allowance data for ${allowanceContract} to ${receiveAddress}`);
+    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
+        });
     }
-    const allowanceRequired = (0, bignumber_1.bnOrZero)(sellAmount).minus(allowanceOnChain);
-    return allowanceRequired.lt(0) ? (0, bignumber_1.bn)(0) : allowanceRequired;
 };
 exports.getAllowanceRequired = getAllowanceRequired;
 const getUsdRate = async (input) => {
     const { symbol, tokenId } = input;
-    if (symbol === 'USDC')
-        return '1'; // Will break if comparing against usdc
-    const rateResponse = await zrxService_1.zrxService.get('/swap/v1/price', {
-        params: {
-            buyToken: 'USDC',
-            buyAmount: '1000000000',
-            sellToken: tokenId || symbol
-        }
-    });
-    const price = (0, bignumber_1.bnOrZero)(rateResponse.data.price);
-    if (!price.gt(0))
-        throw new ZrxSwapper_1.ZrxError('getUsdRate - Failed to get price data');
-    return (0, bignumber_1.bn)(1).dividedBy(price).toString();
+    try {
+        const USDC_CONTRACT_ADDRESS = '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48';
+        if ((tokenId === null || tokenId === void 0 ? void 0 : tokenId.toLowerCase()) === USDC_CONTRACT_ADDRESS)
+            return '1'; // Will break if comparing against usdc
+        const rateResponse = await zrxService_1.zrxService.get('/swap/v1/price', {
+            params: {
+                buyToken: USDC_CONTRACT_ADDRESS,
+                buyAmount: '1000000000',
+                sellToken: tokenId || symbol
+            }
+        });
+        const price = (0, bignumber_1.bnOrZero)(rateResponse.data.price);
+        if (!price.gt(0))
+            throw new api_1.SwapError('[getUsdRate] - Failed to get price data', {
+                code: api_1.SwapErrorTypes.RESPONSE_ERROR
+            });
+        return (0, bignumber_1.bn)(1).dividedBy(price).toString();
+    }
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[getUsdRate]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.USD_RATE_FAILED
+        });
+    }
 };
 exports.getUsdRate = getUsdRate;
 const grantAllowance = async ({ quote, wallet, adapterManager, erc20Abi, web3 }) => {
     var _a, _b, _c, _d, _e;
-    if (!quote.sellAsset.tokenId) {
-        throw new Error('sellAsset.tokenId is required');
-    }
-    const adapter = await adapterManager.byChainId('eip155:1');
-    const erc20Contract = new web3.eth.Contract(erc20Abi, quote.sellAsset.tokenId);
-    const approveTx = erc20Contract.methods
-        .approve(quote.allowanceContract, quote.sellAmount)
-        .encodeABI();
-    const bip44Params = adapter.buildBIP44Params({
-        accountNumber: Number(quote.sellAssetAccountId) || 0
-    });
-    let grantAllowanceTxToSign, signedTx, broadcastedTxId;
     try {
+        if (!quote.sellAsset.tokenId) {
+            throw new api_1.SwapError('[grantAllowance] - sellAsset.tokenId is required', {
+                code: api_1.SwapErrorTypes.VALIDATION_FAILED
+            });
+        }
+        const adapter = await adapterManager.byChainId('eip155:1');
+        const erc20Contract = new web3.eth.Contract(erc20Abi, quote.sellAsset.tokenId);
+        const approveTx = erc20Contract.methods
+            .approve(quote.allowanceContract, quote.sellAmount)
+            .encodeABI();
+        const accountNumber = (0, bignumber_1.bnOrZero)(quote.sellAssetAccountId).toNumber();
+        const bip44Params = adapter.buildBIP44Params({ accountNumber });
         const { txToSign } = await adapter.buildSendTransaction({
             wallet,
             to: quote.sellAsset.tokenId,
@@ -95,46 +121,35 @@ const grantAllowance = async ({ quote, wallet, adapterManager, erc20Abi, web3 })
                 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)
             }
         });
-        grantAllowanceTxToSign = {
+        const grantAllowanceTxToSign = {
             ...txToSign,
             data: approveTx
         };
-    }
-    catch (error) {
-        throw new Error(`grantAllowance - buildSendTransaction: ${error}`);
-    }
-    if (wallet.supportsOfflineSigning()) {
-        try {
-            signedTx = await adapter.signTransaction({ txToSign: grantAllowanceTxToSign, wallet });
+        if (wallet.supportsOfflineSigning()) {
+            const signedTx = await adapter.signTransaction({ txToSign: grantAllowanceTxToSign, wallet });
+            const broadcastedTxId = await adapter.broadcastTransaction(signedTx);
+            return broadcastedTxId;
         }
-        catch (error) {
-            throw new api_1.SwapError(`grantAllowance - signTransaction error: ${error}`);
-        }
-        if (!signedTx) {
-            throw new api_1.SwapError(`grantAllowance - Signed transaction is required: ${signedTx}`);
-        }
-        try {
-            broadcastedTxId = await adapter.broadcastTransaction(signedTx);
-        }
-        catch (error) {
-            throw new api_1.SwapError(`grantAllowance - broadcastTransaction error: ${error}`);
-        }
-        return broadcastedTxId;
-    }
-    else if (wallet.supportsBroadcast() && adapter.signAndBroadcastTransaction) {
-        try {
-            broadcastedTxId = await ((_e = adapter.signAndBroadcastTransaction) === null || _e === void 0 ? void 0 : _e.call(adapter, {
+        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;
         }
-        catch (error) {
-            throw new api_1.SwapError(`grantAllowance - signAndBroadcastTransaction error: ${error}`);
+        else {
+            throw new api_1.SwapError('[grantAllowance] - invalid HDWallet config', {
+                code: api_1.SwapErrorTypes.SIGN_AND_BROADCAST_FAILED
+            });
         }
-        return broadcastedTxId;
     }
-    else {
-        throw new api_1.SwapError('grantAllowance - invalid HDWallet config');
+    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/assets.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 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',
@@ -12,7 +11,7 @@ exports.BTC = {
     network: types_1.NetworkTypes.MAINNET,
     precision: 8,
     slip44: 44,
-    contractType: caip_1.AssetNamespace.ERC20,
+    contractType: 'erc20',
     color: '#FFFFFF',
     secondaryColor: '#FFFFFF',
     icon: 'https://assets.coincap.io/assets/icons/btc@2x.png',
@@ -32,7 +31,7 @@ exports.WETH = {
     network: types_1.NetworkTypes.MAINNET,
     precision: 18,
     tokenId: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
-    contractType: caip_1.AssetNamespace.ERC20,
+    contractType: 'erc20',
     color: '#FFFFFF',
     secondaryColor: '#FFFFFF',
     icon: 'https://assets.coingecko.com/coins/images/2518/thumb/weth.png?1628852295',
@@ -53,7 +52,7 @@ exports.FOX = {
     network: types_1.NetworkTypes.MAINNET,
     precision: 18,
     tokenId: '0xc770eefad204b5180df6a14ee197d99d808ee52d',
-    contractType: caip_1.AssetNamespace.ERC20,
+    contractType: 'erc20',
     color: '#FFFFFF',
     secondaryColor: '#FFFFFF',
     icon: 'https://assets.coincap.io/assets/icons/fox@2x.png',

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

@@ -33,30 +33,21 @@ const constants_1 = require("../utils/constants");
 const helpers_1 = require("../utils/helpers/helpers");
 const zrxService_1 = require("../utils/zrxService");
 async function zrxBuildTrade({ adapterManager, web3 }, input) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    var _a, _b, _c;
     const { sellAsset, buyAsset, sellAmount, slippage, sellAssetAccountId, buyAssetAccountId, wallet } = input;
-    if (!sellAssetAccountId || !buyAssetAccountId) {
-        throw new __1.SwapError('ZrxSwapper:ZrxBuildTrade Both sellAssetAccountId and buyAssetAccountId are required');
-    }
-    const buyToken = buyAsset.tokenId || buyAsset.symbol || buyAsset.network;
-    const sellToken = sellAsset.tokenId || sellAsset.symbol || sellAsset.network;
-    if (!buyToken) {
-        throw new __1.SwapError('ZrxSwapper:ZrxBuildTrade One of buyAssetContract or buyAssetSymbol or buyAssetNetwork are required');
-    }
-    if (!sellToken) {
-        throw new __1.SwapError('ZrxSwapper:ZrxBuildTrade One of sellAssetContract or sellAssetSymbol or sellAssetNetwork are required');
-    }
-    if (buyAsset.chainId !== 'eip155:1') {
-        throw new __1.SwapError('ZrxSwapper:ZrxBuildTrade buyAsset must be on chainId eip155:1');
-    }
-    const adapter = adapterManager.byChain(buyAsset.chain);
-    const bip44Params = adapter.buildBIP44Params({ accountNumber: Number(buyAssetAccountId) });
-    const receiveAddress = await adapter.getAddress({ wallet, bip44Params });
-    if ((0, bignumber_1.bnOrZero)(slippage).gt(constants_1.MAX_SLIPPAGE)) {
-        throw new __1.SwapError(`ZrxSwapper:ZrxBuildTrade slippage value of ${slippage} is greater than max slippage value of ${constants_1.MAX_SLIPPAGE}`);
-    }
-    const slippagePercentage = slippage ? (0, bignumber_1.bnOrZero)(slippage).div(100).toString() : constants_1.DEFAULT_SLIPPAGE;
     try {
+        const buyToken = buyAsset.tokenId || buyAsset.symbol;
+        const sellToken = sellAsset.tokenId || sellAsset.symbol;
+        if (buyAsset.chainId !== 'eip155:1') {
+            throw new __1.SwapError('[ZrxBuildTrade] - buyAsset must be on chainId eip155:1', {
+                code: __1.SwapErrorTypes.VALIDATION_FAILED,
+                details: { chainId: sellAsset.chainId }
+            });
+        }
+        const adapter = await adapterManager.byChainId(buyAsset.chainId);
+        const bip44Params = adapter.buildBIP44Params({ accountNumber: Number(buyAssetAccountId) });
+        const receiveAddress = await adapter.getAddress({ wallet, bip44Params });
+        const slippagePercentage = slippage ? (0, bignumber_1.bnOrZero)(slippage).div(100).toString() : constants_1.DEFAULT_SLIPPAGE;
         /**
          * /swap/v1/quote
          * params: {
@@ -137,27 +128,11 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
         return trade;
     }
     catch (e) {
-        // eslint-disable-next-line no-console
-        const statusReason = ((_g = (_f = (_e = (_d = e === null || e === void 0 ? void 0 : e.response) === null || _d === void 0 ? void 0 : _d.data) === null || _e === void 0 ? void 0 : _e.validationErrors) === null || _f === void 0 ? void 0 : _f[0]) === null || _g === void 0 ? void 0 : _g.reason) ||
-            ((_j = (_h = e === null || e === void 0 ? void 0 : e.response) === null || _h === void 0 ? void 0 : _h.data) === null || _j === void 0 ? void 0 : _j.reason) ||
-            'Unknown Error';
-        // This hackyness will go away when we correctly handle errors
-        return {
-            sellAsset,
-            buyAsset,
-            success: false,
-            statusReason,
-            sellAmount: '0',
-            buyAmount: '0',
-            depositAddress: '',
-            allowanceContract: '',
-            receiveAddress: '',
-            sellAssetAccountId,
-            txData: '',
-            rate: '0',
-            feeData: { fee: '0', chainSpecific: {} },
-            sources: []
-        };
+        if (e instanceof __1.SwapError)
+            throw e;
+        throw new __1.SwapError('[ZrxBuildTrade]', {
+            code: __1.SwapErrorTypes.BUILD_TRADE_FAILED
+        });
     }
 }
 exports.zrxBuildTrade = zrxBuildTrade;

package/dist/swappers/zrx/zrxExecuteTrade/zrxExecuteTrade.js

@@ -3,30 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.zrxExecuteTrade = void 0;
 const web3_utils_1 = require("web3-utils");
 const api_1 = require("../../../api");
+const bignumber_1 = require("../utils/bignumber");
 async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
     var _a, _b, _c, _d, _e, _f;
     const { sellAsset } = trade;
-    if (!sellAsset.symbol) {
-        throw new api_1.SwapError('ZrxSwapper:ZrxExecuteTrade sellAssetSymbol is required');
-    }
-    if (!trade.sellAssetAccountId) {
-        throw new api_1.SwapError('ZrxSwapper:ZrxExecuteTrade sellAssetAccountId is required');
-    }
-    if (!trade.sellAmount) {
-        throw new api_1.SwapError('ZrxSwapper:ZrxExecuteTrade sellAmount is required');
-    }
-    if (!trade.depositAddress) {
-        throw new api_1.SwapError('ZrxSwapper:ZrxExecuteTrade depositAddress is required');
-    }
-    // value is 0 for erc20s
-    const value = sellAsset.symbol === 'ETH' ? trade.sellAmount : '0';
-    const adapter = adapterManager.byChain(sellAsset.chain);
-    const bip44Params = adapter.buildBIP44Params({
-        accountNumber: Number(trade.sellAssetAccountId)
-    });
-    let buildTxResponse, signedTx, txid;
     try {
-        buildTxResponse = await adapter.buildSendTransaction({
+        // value is 0 for erc20s
+        const value = sellAsset.assetId === 'eip155:1/slip44:60' ? trade.sellAmount : '0';
+        const adapter = await adapterManager.byChainId(sellAsset.chainId);
+        const bip44Params = adapter.buildBIP44Params({
+            accountNumber: (0, bignumber_1.bnOrZero)(trade.sellAssetAccountId).toNumber()
+        });
+        const buildTxResponse = await adapter.buildSendTransaction({
             value,
             wallet,
             to: trade.depositAddress,
@@ -36,41 +24,33 @@ async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
             },
             bip44Params
         });
-    }
-    catch (error) {
-        throw new api_1.SwapError(`ZrxExecuteTrade - buildSendTransaction error: ${error}`);
-    }
-    const { txToSign } = buildTxResponse;
-    const txWithQuoteData = { ...txToSign, data: (_e = trade.txData) !== null && _e !== void 0 ? _e : '' };
-    if (wallet.supportsOfflineSigning()) {
-        try {
-            signedTx = await adapter.signTransaction({ txToSign: txWithQuoteData, wallet });
+        const { txToSign } = buildTxResponse;
+        const txWithQuoteData = { ...txToSign, data: (_e = trade.txData) !== null && _e !== void 0 ? _e : '' };
+        if (wallet.supportsOfflineSigning()) {
+            const signedTx = await adapter.signTransaction({ txToSign: txWithQuoteData, wallet });
+            const txid = await adapter.broadcastTransaction(signedTx);
+            return { txid };
         }
-        catch (error) {
-            throw new api_1.SwapError(`ZrxExecuteTrade - signTransaction error: ${error}`);
+        else if (wallet.supportsBroadcast() && adapter.signAndBroadcastTransaction) {
+            const txid = await ((_f = adapter.signAndBroadcastTransaction) === null || _f === void 0 ? void 0 : _f.call(adapter, {
+                txToSign: txWithQuoteData,
+                wallet
+            }));
+            return { txid };
         }
-        if (!signedTx) {
-            throw new api_1.SwapError(`ZrxExecuteTrade - Signed transaction is required: ${signedTx}`);
+        else {
+            throw new api_1.SwapError('[zrxExecuteTrade]', {
+                code: api_1.SwapErrorTypes.SIGN_AND_BROADCAST_FAILED
+            });
         }
-        try {
-            txid = await adapter.broadcastTransaction(signedTx);
-        }
-        catch (error) {
-            throw new api_1.SwapError(`ZrxExecuteTrade - broadcastTransaction error: ${error}`);
-        }
-        return { txid };
-    }
-    else if (wallet.supportsBroadcast() && adapter.signAndBroadcastTransaction) {
-        try {
-            txid = await ((_f = adapter.signAndBroadcastTransaction) === null || _f === void 0 ? void 0 : _f.call(adapter, { txToSign: txWithQuoteData, wallet }));
-        }
-        catch (error) {
-            throw new api_1.SwapError(`ZrxExecuteTrade - signAndBroadcastTransaction error: ${error}`);
-        }
-        return { txid };
     }
-    else {
-        throw new api_1.SwapError('ZrxExecuteTrade - invalid HDWallet config');
+    catch (e) {
+        if (e instanceof api_1.SwapError)
+            throw e;
+        throw new api_1.SwapError('[zrxExecuteTrade]', {
+            cause: e,
+            code: api_1.SwapErrorTypes.EXECUTE_TRADE_FAILED
+        });
     }
 }
 exports.zrxExecuteTrade = zrxExecuteTrade;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "4.1.2",
+  "version": "5.0.1",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -30,18 +30,20 @@
     "web3": "^1.6.1"
   },
   "peerDependencies": {
-    "@shapeshiftoss/asset-service": "^2.0.0",
-    "@shapeshiftoss/caip": "^3.0.0",
-    "@shapeshiftoss/chain-adapters": "^3.0.0",
+    "@shapeshiftoss/asset-service": "^3.0.0",
+    "@shapeshiftoss/caip": "^4.0.0",
+    "@shapeshiftoss/chain-adapters": "^4.0.0",
     "@shapeshiftoss/hdwallet-core": "1.20.0",
-    "@shapeshiftoss/types": "^4.0.0"
+    "@shapeshiftoss/types": "^4.0.0",
+    "@shapeshiftoss/errors": "^1.1.0"
   },
   "devDependencies": {
-    "@shapeshiftoss/asset-service": "^2.0.0",
-    "@shapeshiftoss/caip": "^3.0.0",
-    "@shapeshiftoss/chain-adapters": "^3.0.0",
+    "@shapeshiftoss/asset-service": "^3.0.0",
+    "@shapeshiftoss/caip": "^4.0.0",
+    "@shapeshiftoss/chain-adapters": "^4.0.0",
     "@shapeshiftoss/hdwallet-core": "^1.20.0",
-    "@shapeshiftoss/types": "^4.0.0",
+    "@shapeshiftoss/types": "^4.1.0",
+    "@shapeshiftoss/errors": "^1.1.0",
     "@types/readline-sync": "^1.4.4",
     "readline-sync": "^1.4.10",
     "web3-utils": "^1.5.2"