@shapeshiftoss/swapper 5.3.0 → 5.6.0

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { AssetId } from '@shapeshiftoss/caip';
-import { HDWallet } from '@shapeshiftoss/hdwallet-core';
+import { BTCSignTx, ETHSignTx, HDWallet } from '@shapeshiftoss/hdwallet-core';
 import { Asset, ChainSpecific, SupportedChainIds } from '@shapeshiftoss/types';
 export declare const SwapError: {
     new <V extends {
@@ -85,6 +85,15 @@ export interface ZrxTrade<C extends SupportedChainIds> extends Trade<C> {
     txData: string;
     depositAddress: string;
 }
+export interface BtcThorTrade<C extends SupportedChainIds> extends Trade<C> {
+    chainId: 'bip122:000000000019d6689c085ae165831e93';
+    txData: BTCSignTx;
+}
+export interface EthThorTrade<C extends SupportedChainIds> extends Trade<C> {
+    chainId: 'eip155:1';
+    txData: ETHSignTx;
+}
+export declare type ThorTrade<C extends SupportedChainIds> = BtcThorTrade<C> | EthThorTrade<C>;
 export declare type ExecuteTradeInput<C extends SupportedChainIds> = {
     trade: Trade<C>;
     wallet: HDWallet;
@@ -120,6 +129,7 @@ export declare type ApprovalNeededOutput = {
 export declare enum SwapperType {
     Zrx = "0x",
     Thorchain = "Thorchain",
+    CowSwap = "CowSwap",
     Test = "Test"
 }
 export declare type TradeTxs = {
@@ -133,6 +143,7 @@ export declare enum SwapErrorTypes {
     CHECK_APPROVAL_FAILED = "CHECK_APPROVAL_FAILED",
     EXECUTE_TRADE_FAILED = "EXECUTE_TRADE_FAILED",
     GRANT_ALLOWANCE_FAILED = "GRANT_ALLOWANCE_FAILED",
+    INITIALIZE_FAILED = "INITIALIZE_FAILED",
     MANAGER_ERROR = "MANAGER_ERROR",
     MIN_MAX_FAILED = "MIN_MAX_FAILED",
     RESPONSE_ERROR = "RESPONSE_ERROR",

package/dist/api.js

@@ -7,6 +7,7 @@ var SwapperType;
 (function (SwapperType) {
     SwapperType["Zrx"] = "0x";
     SwapperType["Thorchain"] = "Thorchain";
+    SwapperType["CowSwap"] = "CowSwap";
     SwapperType["Test"] = "Test";
 })(SwapperType = exports.SwapperType || (exports.SwapperType = {}));
 // Swap Errors
@@ -18,6 +19,7 @@ var SwapErrorTypes;
     SwapErrorTypes["CHECK_APPROVAL_FAILED"] = "CHECK_APPROVAL_FAILED";
     SwapErrorTypes["EXECUTE_TRADE_FAILED"] = "EXECUTE_TRADE_FAILED";
     SwapErrorTypes["GRANT_ALLOWANCE_FAILED"] = "GRANT_ALLOWANCE_FAILED";
+    SwapErrorTypes["INITIALIZE_FAILED"] = "INITIALIZE_FAILED";
     SwapErrorTypes["MANAGER_ERROR"] = "MANAGER_ERROR";
     SwapErrorTypes["MIN_MAX_FAILED"] = "MIN_MAX_FAILED";
     SwapErrorTypes["RESPONSE_ERROR"] = "RESPONSE_ERROR";

package/dist/swappercli.js

@@ -13,6 +13,7 @@ const readline_sync_1 = __importDefault(require("readline-sync"));
 const web3_1 = __importDefault(require("web3"));
 const api_1 = require("./api");
 const SwapperManager_1 = require("./manager/SwapperManager");
+const ThorchainSwapper_1 = require("./swappers/thorchain/ThorchainSwapper");
 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 = 'all all all all all all all all all all all all' } = process.env;
@@ -82,9 +83,15 @@ const main = async () => {
     const web3Provider = new web3_1.default.providers.HttpProvider(ETH_NODE_URL);
     const web3 = new web3_1.default(web3Provider);
     const zrxSwapperDeps = { wallet, adapterManager, web3 };
+    const thorchainSwapperDeps = {
+        midgardUrl: 'https://midgard.thorchain.info/v2/pools'
+    };
     const manager = new SwapperManager_1.SwapperManager();
     const zrxSwapper = new ZrxSwapper_1.ZrxSwapper(zrxSwapperDeps);
+    const thorchainSwapper = new ThorchainSwapper_1.ThorchainSwapper(thorchainSwapperDeps);
+    await thorchainSwapper.initialize();
     manager.addSwapper(api_1.SwapperType.Zrx, zrxSwapper);
+    manager.addSwapper(api_1.SwapperType.Thorchain, thorchainSwapper);
     const swapper = await manager.getBestSwapper({
         sellAssetId: 'eip155:1/slip44:60',
         buyAssetId: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'

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

@@ -0,0 +1,18 @@
+import { AssetId } from '@shapeshiftoss/caip';
+import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetMinMaxInput, GetTradeQuoteInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
+export declare class CowSwapper implements Swapper {
+    static swapperName: string;
+    initialize(): Promise<void>;
+    getType(): SwapperType;
+    buildTrade(args: BuildTradeInput): Promise<Trade<SupportedChainIds>>;
+    getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<SupportedChainIds>>;
+    getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
+    getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
+    executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<TradeResult>;
+    approvalNeeded(args: ApprovalNeededInput<SupportedChainIds>): Promise<ApprovalNeededOutput>;
+    approveInfinite(args: ApproveInfiniteInput<SupportedChainIds>): Promise<string>;
+    filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
+    filterAssetIdsBySellable(assetIds: AssetId[]): AssetId[];
+    getTradeTxs(): Promise<TradeTxs>;
+}

package/dist/swappers/cow/CowSwapper.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CowSwapper = void 0;
+const api_1 = require("../../api");
+class CowSwapper {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async initialize() { }
+    getType() {
+        return api_1.SwapperType.CowSwap;
+    }
+    async buildTrade(args) {
+        console.info(args);
+        throw new Error('CowSwapper: buildTrade unimplemented');
+    }
+    async getTradeQuote(input) {
+        console.info(input);
+        throw new Error('CowSwapper: getTradeQuote unimplemented');
+    }
+    getUsdRate(input) {
+        console.info(input);
+        throw new Error('CowSwapper: getUsdRate unimplemented');
+    }
+    getMinMax(input) {
+        console.info(input);
+        throw new Error('CowSwapper: getMinMax unimplemented');
+    }
+    async executeTrade(args) {
+        console.info(args);
+        throw new Error('CowSwapper: executeTrade unimplemented');
+    }
+    async approvalNeeded(args) {
+        console.info(args);
+        throw new Error('CowSwapper: approvalNeeded unimplemented');
+    }
+    async approveInfinite(args) {
+        console.info(args);
+        throw new Error('CowSwapper: approveInfinite unimplemented');
+    }
+    filterBuyAssetsBySellAssetId(args) {
+        console.info(args);
+        return [];
+    }
+    filterAssetIdsBySellable(assetIds) {
+        console.info(assetIds);
+        return [];
+    }
+    async getTradeTxs() {
+        throw new Error('CowSwapper: executeTrade unimplemented');
+    }
+}
+exports.CowSwapper = CowSwapper;
+CowSwapper.swapperName = 'CowSwapper';

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

@@ -1,14 +1,20 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
-import { ApprovalNeededOutput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
+import { ApprovalNeededOutput, BuyAssetBySellIdInput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
+export declare type ThorchainSwapperDeps = {
+    midgardUrl: string;
+};
 export declare class ThorchainSwapper implements Swapper {
-    getType(): SwapperType;
+    private supportedAssetIds;
+    deps: ThorchainSwapperDeps;
+    constructor(deps: ThorchainSwapperDeps);
     initialize(): Promise<void>;
+    getType(): SwapperType;
     getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
-    filterBuyAssetsBySellAssetId(): AssetId[];
+    filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(): AssetId[];
     buildTrade(): Promise<Trade<SupportedChainIds>>;
     getTradeQuote(): Promise<TradeQuote<SupportedChainIds>>;

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -1,14 +1,39 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThorchainSwapper = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const axios_1 = __importDefault(require("axios"));
 const api_1 = require("../../api");
 class ThorchainSwapper {
+    constructor(deps) {
+        this.supportedAssetIds = [];
+        this.deps = deps;
+    }
+    async initialize() {
+        try {
+            const { data: responseData } = await axios_1.default.get(this.deps.midgardUrl);
+            const supportedAssetIds = responseData.reduce((acc, midgardPool) => {
+                const assetId = caip_1.adapters.poolAssetIdToAssetId(midgardPool.asset);
+                if (!assetId)
+                    return acc;
+                acc.push(assetId);
+                return acc;
+            }, []);
+            this.supportedAssetIds = supportedAssetIds;
+        }
+        catch (e) {
+            throw new api_1.SwapError('[thorchainInitialize]: initialize failed to set supportedAssetIds', {
+                code: api_1.SwapErrorTypes.INITIALIZE_FAILED,
+                cause: e
+            });
+        }
+    }
     getType() {
         return api_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');
@@ -23,11 +48,12 @@ class ThorchainSwapper {
     async approveInfinite() {
         throw new Error('ThorchainSwapper: approveInfinite unimplemented');
     }
-    filterBuyAssetsBySellAssetId() {
-        return [];
+    filterBuyAssetsBySellAssetId(args) {
+        const { assetIds = [], sellAssetId } = args;
+        return assetIds.filter((assetId) => this.supportedAssetIds.includes(assetId) && assetId !== sellAssetId);
     }
     filterAssetIdsBySellable() {
-        return [];
+        return this.supportedAssetIds;
     }
     async buildTrade() {
         throw new Error('ThorchainSwapper: buildTrade unimplemented');

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

@@ -0,0 +1,14 @@
+export declare type MidgardResponse = {
+    asset: string;
+    assetDepth: string;
+    assetPrice: string;
+    assetPriceUSD: string;
+    liquidityUnits: string;
+    poolAPY: string;
+    runeDepth: string;
+    status: string;
+    synthSupply: string;
+    synthUnits: string;
+    units: string;
+    volume24h: string;
+};

package/dist/swappers/thorchain/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/swappers/thorchain/utils/ethereum/routerAbi.d.ts

@@ -0,0 +1,2 @@
+import { AbiItem } from 'web3-utils';
+export declare const routerAbi: AbiItem[];

package/dist/swappers/thorchain/utils/ethereum/routerAbi.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routerAbi = void 0;
+/* eslint-disable */
+exports.routerAbi = [
+    {
+        "inputs": [{ "internalType": "address", "name": "rune", "type": "address" }],
+        "stateMutability": "nonpayable",
+        "type": "constructor"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            { "indexed": true, "internalType": "address", "name": "to", "type": "address" },
+            { "indexed": true, "internalType": "address", "name": "asset", "type": "address" },
+            { "indexed": false, "internalType": "uint256", "name": "amount", "type": "uint256" },
+            { "indexed": false, "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "Deposit",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            { "indexed": true, "internalType": "address", "name": "oldVault", "type": "address" },
+            { "indexed": true, "internalType": "address", "name": "newVault", "type": "address" },
+            { "indexed": false, "internalType": "address", "name": "asset", "type": "address" },
+            { "indexed": false, "internalType": "uint256", "name": "amount", "type": "uint256" },
+            { "indexed": false, "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "TransferAllowance",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            { "indexed": true, "internalType": "address", "name": "vault", "type": "address" },
+            { "indexed": true, "internalType": "address", "name": "to", "type": "address" },
+            { "indexed": false, "internalType": "address", "name": "asset", "type": "address" },
+            { "indexed": false, "internalType": "uint256", "name": "amount", "type": "uint256" },
+            { "indexed": false, "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "TransferOut",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            { "indexed": true, "internalType": "address", "name": "oldVault", "type": "address" },
+            { "indexed": true, "internalType": "address", "name": "newVault", "type": "address" },
+            {
+                "components": [
+                    { "internalType": "address", "name": "asset", "type": "address" },
+                    { "internalType": "uint256", "name": "amount", "type": "uint256" }
+                ],
+                "indexed": false,
+                "internalType": "struct THORChain_Router.Coin[]",
+                "name": "coins",
+                "type": "tuple[]"
+            },
+            { "indexed": false, "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "VaultTransfer",
+        "type": "event"
+    },
+    {
+        "inputs": [],
+        "name": "RUNE",
+        "outputs": [{ "internalType": "address", "name": "", "type": "address" }],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            { "internalType": "address payable", "name": "vault", "type": "address" },
+            { "internalType": "address", "name": "asset", "type": "address" },
+            { "internalType": "uint256", "name": "amount", "type": "uint256" },
+            { "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "deposit",
+        "outputs": [],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            { "internalType": "address payable", "name": "vault", "type": "address" },
+            { "internalType": "address", "name": "asset", "type": "address" },
+            { "internalType": "uint256", "name": "amount", "type": "uint256" },
+            { "internalType": "string", "name": "memo", "type": "string" },
+            { "internalType": "uint256", "name": "expiration", "type": "uint256" }
+        ],
+        "name": "depositWithExpiry",
+        "outputs": [],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            { "internalType": "address", "name": "router", "type": "address" },
+            { "internalType": "address payable", "name": "asgard", "type": "address" },
+            {
+                "components": [
+                    { "internalType": "address", "name": "asset", "type": "address" },
+                    { "internalType": "uint256", "name": "amount", "type": "uint256" }
+                ],
+                "internalType": "struct THORChain_Router.Coin[]",
+                "name": "coins",
+                "type": "tuple[]"
+            },
+            { "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "returnVaultAssets",
+        "outputs": [],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            { "internalType": "address", "name": "router", "type": "address" },
+            { "internalType": "address", "name": "newVault", "type": "address" },
+            { "internalType": "address", "name": "asset", "type": "address" },
+            { "internalType": "uint256", "name": "amount", "type": "uint256" },
+            { "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "transferAllowance",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            { "internalType": "address payable", "name": "to", "type": "address" },
+            { "internalType": "address", "name": "asset", "type": "address" },
+            { "internalType": "uint256", "name": "amount", "type": "uint256" },
+            { "internalType": "string", "name": "memo", "type": "string" }
+        ],
+        "name": "transferOut",
+        "outputs": [],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            { "internalType": "address", "name": "vault", "type": "address" },
+            { "internalType": "address", "name": "token", "type": "address" }
+        ],
+        "name": "vaultAllowance",
+        "outputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
+        "stateMutability": "view",
+        "type": "function"
+    }
+];

package/dist/swappers/thorchain/utils/ethereum/routerCalldata.d.ts

@@ -0,0 +1 @@
+export declare const deposit: (contractAddress: string, vault: string, asset: string, amount: string, memo: string) => Promise<any>;

package/dist/swappers/thorchain/utils/ethereum/routerCalldata.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deposit = void 0;
+const web3_1 = __importDefault(require("web3"));
+const routerAbi_1 = require("./routerAbi");
+const deposit = async (contractAddress, vault, asset, amount, memo) => {
+    const web3 = new web3_1.default();
+    const routerContract = new web3.eth.Contract(routerAbi_1.routerAbi, contractAddress);
+    const data = routerContract.methods.deposit(vault, asset, amount, memo).encodeABI();
+    return data;
+};
+exports.deposit = deposit;

package/dist/swappers/thorchain/utils/test-data/midgardResponse.d.ts

@@ -0,0 +1,14 @@
+export declare const midgardResponse: {
+    asset: string;
+    assetDepth: string;
+    assetPrice: string;
+    assetPriceUSD: string;
+    liquidityUnits: string;
+    poolAPY: string;
+    runeDepth: string;
+    status: string;
+    synthSupply: string;
+    synthUnits: string;
+    units: string;
+    volume24h: string;
+}[];

package/dist/swappers/thorchain/utils/test-data/midgardResponse.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.midgardResponse = void 0;
+exports.midgardResponse = [
+    {
+        asset: 'BTC.BTC',
+        assetDepth: '91027798705',
+        assetPrice: '10280.68095465986',
+        assetPriceUSD: '29850.505131750208',
+        liquidityUnits: '536055974608843',
+        poolAPY: '0.09305294391574037',
+        runeDepth: '935827756491105',
+        status: 'available',
+        synthSupply: '3281284823',
+        synthUnits: '9838954536080',
+        units: '545894929144923',
+        volume24h: '15031085906495'
+    },
+    {
+        asset: 'ETH.ETH',
+        assetDepth: '915018987646',
+        assetPrice: '676.2118757936507',
+        assetPriceUSD: '1963.4172247490626',
+        liquidityUnits: '273709963437801',
+        poolAPY: '0.10532151323548256',
+        runeDepth: '618746706022909',
+        status: 'available',
+        synthSupply: '3572065751',
+        synthUnits: '535301524652',
+        units: '274245264962453',
+        volume24h: '9890096673763'
+    },
+    {
+        asset: 'ETH.FOX-0XC770EEFAD204B5180DF6A14EE197D99D808EE52D',
+        assetDepth: '166650912393467',
+        assetPrice: '0.05303710198887871',
+        assetPriceUSD: '0.15399605260336216',
+        liquidityUnits: '10015457121887',
+        poolAPY: '0.2597568967423438',
+        runeDepth: '8838681437152',
+        status: 'available',
+        synthSupply: '17428372569375',
+        synthUnits: '552604585625',
+        units: '10568061707512',
+        volume24h: '251596933033'
+    }
+];

package/package.json

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