@shapeshiftoss/swapper 5.1.3 → 5.2.0

package/README.md

@@ -1,4 +1,4 @@
-## ShapeShift Swapper
+# @shapeshiftoss/swapper
 
 ## Getting Started
 
@@ -10,16 +10,16 @@ yarn add @shapeshiftoss/swapper
 
 ### Swapper CLI
 - Copy the `sample.env` to `.env`
-```
+```sh
 cp sample.env .env
 ```
 
 - Usage:
-```
+```sh
 $ swapcli [sellSymbol] [buySymbol] [sellAmount](denominated in sell asset, not wei)
 ```
 ie:
-```
+```sh
 $ swapcli ETH USDC 0.001
 ```
 

package/dist/api.d.ts

@@ -122,6 +122,8 @@ export declare enum SwapErrorTypes {
     VALIDATION_FAILED = "VALIDATION_FAILED"
 }
 export interface Swapper {
+    /** perform any necessary async initialization */
+    initialize(): Promise<void>;
     /** Returns the swapper type */
     getType(): SwapperType;
     /**

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

@@ -7,9 +7,10 @@ import { BuyAssetBySellIdInput, Swapper, Trade, TradeQuote } from '../../api';
  */
 export declare class TestSwapper implements Swapper {
     supportAssets: string[];
+    initialize(): Promise<void>;
     getType(): SwapperType;
     constructor();
-    getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
+    getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;

package/dist/swappers/test/TestSwapper.js

@@ -14,6 +14,9 @@ class TestSwapper {
             'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'
         ];
     }
+    // noop for test
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async initialize() { }
     getType() {
         return types_1.SwapperType.Test;
     }

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

@@ -3,7 +3,8 @@ import { ApprovalNeededOutput, Asset, ExecQuoteOutput, GetMinMaxInput, MinMaxOut
 import { Swapper, Trade, TradeQuote } from '../../api';
 export declare class ThorchainSwapper implements Swapper {
     getType(): SwapperType;
-    getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
+    initialize(): Promise<void>;
+    getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -6,6 +6,9 @@ class ThorchainSwapper {
     getType() {
         return types_1.SwapperType.Thorchain;
     }
+    // TODO populate supported assets from midgard
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async initialize() { }
     getUsdRate(input) {
         console.info(input);
         throw new Error('ThorchainSwapper: getUsdRate unimplemented');

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

@@ -10,6 +10,7 @@ const helpers_1 = require("../utils/helpers/helpers");
 async function ZrxApprovalNeeded({ adapterManager, web3 }, { quote, wallet }) {
     var _a, _b;
     const { sellAsset } = quote;
+    const { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(sellAsset.assetId);
     try {
         if (sellAsset.chainId !== 'eip155:1') {
             throw new api_1.SwapError('[ZrxApprovalNeeded] - sellAsset chainId is not supported', {
@@ -25,8 +26,8 @@ async function ZrxApprovalNeeded({ adapterManager, web3 }, { quote, wallet }) {
         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', {
+        if (!quote.allowanceContract) {
+            throw new api_1.SwapError('[ZrxApprovalNeeded] - allowanceTarget is required', {
                 code: api_1.SwapErrorTypes.VALIDATION_FAILED,
                 details: { chainId: sellAsset.chainId }
             });
@@ -34,7 +35,7 @@ async function ZrxApprovalNeeded({ adapterManager, web3 }, { quote, wallet }) {
         const allowanceResult = await (0, helpers_1.getERC20Allowance)({
             web3,
             erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
-            tokenId: quote.sellAsset.tokenId,
+            sellAssetErc20Address,
             spenderAddress: quote.allowanceContract,
             ownerAddress: receiveAddress
         });

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

@@ -11,10 +11,11 @@ export declare class ZrxSwapper implements Swapper {
     static swapperName: string;
     deps: ZrxSwapperDeps;
     constructor(deps: ZrxSwapperDeps);
+    initialize(): Promise<void>;
     getType(): SwapperType;
     buildTrade(args: BuildTradeInput): Promise<ZrxTrade<SupportedChainIds>>;
     getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<SupportedChainIds>>;
-    getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
+    getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<ExecQuoteOutput>;
     approvalNeeded(args: ApprovalNeededInput<SupportedChainIds>): Promise<ApprovalNeededOutput>;

package/dist/swappers/zrx/ZrxSwapper.js

@@ -14,6 +14,9 @@ class ZrxSwapper {
     constructor(deps) {
         this.deps = deps;
     }
+    // noop for zrx
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async initialize() { }
     getType() {
         return types_1.SwapperType.Zrx;
     }

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getZrxTradeQuote = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
 const api_1 = require("../../../api");
 const getZrxMinMax_1 = require("../getZrxMinMax/getZrxMinMax");
 const bignumber_1 = require("../utils/bignumber");
@@ -17,9 +18,11 @@ async function getZrxTradeQuote(input) {
                 details: { buyAssetChainId: buyAsset.chainId, sellAssetChainId: sellAsset.chainId }
             });
         }
+        const { assetReference: sellAssetErc20Address, assetNamespace: sellAssetNamespace } = (0, caip_1.fromAssetId)(sellAsset.assetId);
+        const { assetReference: buyAssetErc20Address, assetNamespace: buyAssetNamespace } = (0, caip_1.fromAssetId)(buyAsset.assetId);
         const useSellAmount = !!sellAmount;
-        const buyToken = buyAsset.tokenId || buyAsset.symbol;
-        const sellToken = sellAsset.tokenId || sellAsset.symbol;
+        const buyToken = buyAssetNamespace === 'erc20' ? buyAssetErc20Address : buyAsset.symbol;
+        const sellToken = sellAssetNamespace === 'erc20' ? sellAssetErc20Address : 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 : sellAmount);
@@ -53,7 +56,7 @@ async function getZrxTradeQuote(input) {
                 chainSpecific: {
                     estimatedGas: estimatedGas.toString(),
                     gasPrice: data.gasPrice,
-                    approvalFee: sellAsset.tokenId &&
+                    approvalFee: sellAssetErc20Address &&
                         (0, bignumber_1.bnOrZero)(constants_1.APPROVAL_GAS_LIMIT).multipliedBy((0, bignumber_1.bnOrZero)(data.gasPrice)).toString()
                 }
             },

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

@@ -16,7 +16,7 @@ export declare type GetAllowanceRequiredArgs = {
 export declare type GetERC20AllowanceArgs = {
     erc20AllowanceAbi: AbiItem[];
     web3: Web3;
-    tokenId: string;
+    sellAssetErc20Address: string;
     ownerAddress: string;
     spenderAddress: string;
 };
@@ -36,8 +36,8 @@ declare type GrantAllowanceArgs = {
  * @param amount
  */
 export declare const normalizeAmount: (amount: string | number | BigNumber) => string;
-export declare const getERC20Allowance: ({ erc20AllowanceAbi, web3, tokenId, ownerAddress, spenderAddress }: GetERC20AllowanceArgs) => Promise<any>;
+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 getUsdRate: (input: Pick<Asset, 'symbol' | 'tokenId'>) => Promise<string>;
+export declare const getUsdRate: (input: Pick<Asset, 'symbol' | 'assetId'>) => Promise<string>;
 export declare const grantAllowance: ({ quote, wallet, adapterManager, erc20Abi, web3 }: GrantAllowanceArgs) => Promise<string>;
 export {};

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.grantAllowance = exports.getUsdRate = exports.getAllowanceRequired = exports.getERC20Allowance = exports.normalizeAmount = 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");
@@ -17,8 +18,8 @@ const normalizeAmount = (amount) => {
     return (0, bignumber_1.bnOrZero)(amount).toNumber().toLocaleString('fullwide', { useGrouping: false });
 };
 exports.normalizeAmount = normalizeAmount;
-const getERC20Allowance = async ({ erc20AllowanceAbi, web3, tokenId, ownerAddress, spenderAddress }) => {
-    const erc20Contract = new web3.eth.Contract(erc20AllowanceAbi, tokenId);
+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;
@@ -29,18 +30,13 @@ const getAllowanceRequired = async ({ receiveAddress, allowanceContract, sellAss
         }
         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 { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(sellAsset.assetId);
         const allowanceOnChain = await (0, exports.getERC20Allowance)({
             web3,
             erc20AllowanceAbi,
             ownerAddress,
             spenderAddress,
-            tokenId
+            sellAssetErc20Address
         });
         if (allowanceOnChain === '0')
             return (0, bignumber_1.bnOrZero)(sellAmount);
@@ -64,16 +60,17 @@ const getAllowanceRequired = async ({ receiveAddress, allowanceContract, sellAss
 };
 exports.getAllowanceRequired = getAllowanceRequired;
 const getUsdRate = async (input) => {
-    const { symbol, tokenId } = input;
+    const { symbol, assetId } = input;
+    const { assetReference: erc20Address, assetNamespace } = (0, caip_1.fromAssetId)(assetId);
     try {
         const USDC_CONTRACT_ADDRESS = '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48';
-        if ((tokenId === null || tokenId === void 0 ? void 0 : tokenId.toLowerCase()) === USDC_CONTRACT_ADDRESS)
+        if ((erc20Address === null || erc20Address === void 0 ? void 0 : erc20Address.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
+                sellToken: assetNamespace === 'erc20' ? erc20Address : symbol
             }
         });
         const price = (0, bignumber_1.bnOrZero)(rateResponse.data.price);
@@ -96,13 +93,9 @@ exports.getUsdRate = getUsdRate;
 const grantAllowance = async ({ quote, wallet, adapterManager, erc20Abi, web3 }) => {
     var _a, _b, _c, _d, _e;
     try {
-        if (!quote.sellAsset.tokenId) {
-            throw new api_1.SwapError('[grantAllowance] - sellAsset.tokenId is required', {
-                code: api_1.SwapErrorTypes.VALIDATION_FAILED
-            });
-        }
+        const { assetReference: sellAssetErc20Address } = (0, caip_1.fromAssetId)(quote.sellAsset.assetId);
         const adapter = await adapterManager.byChainId('eip155:1');
-        const erc20Contract = new web3.eth.Contract(erc20Abi, quote.sellAsset.tokenId);
+        const erc20Contract = new web3.eth.Contract(erc20Abi, sellAssetErc20Address);
         const approveTx = erc20Contract.methods
             .approve(quote.allowanceContract, quote.sellAmount)
             .encodeABI();
@@ -110,11 +103,11 @@ const grantAllowance = async ({ quote, wallet, adapterManager, erc20Abi, web3 })
         const bip44Params = adapter.buildBIP44Params({ accountNumber });
         const { txToSign } = await adapter.buildSendTransaction({
             wallet,
-            to: quote.sellAsset.tokenId,
+            to: sellAssetErc20Address,
             bip44Params,
             value: '0',
             chainSpecific: {
-                erc20ContractAddress: quote.sellAsset.tokenId,
+                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)
             }

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

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
@@ -36,8 +37,10 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
     var _a, _b, _c;
     const { sellAsset, buyAsset, sellAmount, slippage, sellAssetAccountId, buyAssetAccountId, wallet } = input;
     try {
-        const buyToken = buyAsset.tokenId || buyAsset.symbol;
-        const sellToken = sellAsset.tokenId || sellAsset.symbol;
+        const { assetReference: buyAssetErc20Address, assetNamespace: buyAssetNamespace } = (0, caip_1.fromAssetId)(buyAsset.assetId);
+        const { assetReference: sellAssetErc20Address, assetNamespace: sellAssetNamespace } = (0, caip_1.fromAssetId)(sellAsset.assetId);
+        const buyToken = buyAssetNamespace === 'erc20' ? buyAssetErc20Address : buyAsset.symbol;
+        const sellToken = sellAssetNamespace === 'erc20' ? sellAssetErc20Address : sellAsset.symbol;
         if (buyAsset.chainId !== 'eip155:1') {
             throw new __1.SwapError('[ZrxBuildTrade] - buyAsset must be on chainId eip155:1', {
                 code: __1.SwapErrorTypes.VALIDATION_FAILED,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "5.1.3",
+  "version": "5.2.0",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -30,19 +30,19 @@
     "web3": "^1.6.1"
   },
   "peerDependencies": {
-    "@shapeshiftoss/asset-service": "^3.0.0",
-    "@shapeshiftoss/caip": "^4.0.1",
-    "@shapeshiftoss/chain-adapters": "^4.0.0",
+    "@shapeshiftoss/asset-service": "^4.2.4",
+    "@shapeshiftoss/caip": "^5.0.0",
+    "@shapeshiftoss/chain-adapters": "^4.3.3",
     "@shapeshiftoss/hdwallet-core": "1.20.0",
-    "@shapeshiftoss/types": "^4.0.0",
+    "@shapeshiftoss/types": "^4.3.1",
     "@shapeshiftoss/errors": "^1.1.0"
   },
   "devDependencies": {
-    "@shapeshiftoss/asset-service": "^3.0.0",
-    "@shapeshiftoss/caip": "^4.0.1",
-    "@shapeshiftoss/chain-adapters": "^4.0.0",
+    "@shapeshiftoss/asset-service": "^4.2.4",
+    "@shapeshiftoss/caip": "^5.0.0",
+    "@shapeshiftoss/chain-adapters": "^4.3.3",
     "@shapeshiftoss/hdwallet-core": "^1.20.0",
-    "@shapeshiftoss/types": "^4.1.0",
+    "@shapeshiftoss/types": "^4.3.1",
     "@shapeshiftoss/errors": "^1.1.0",
     "@types/readline-sync": "^1.4.4",
     "readline-sync": "^1.4.10",