@shapeshiftoss/swapper 5.2.1 → 5.3.0

package/dist/api.d.ts

@@ -90,7 +90,7 @@ export declare type ExecuteTradeInput<C extends SupportedChainIds> = {
     wallet: HDWallet;
 };
 export declare type TradeResult = {
-    txid: string;
+    tradeId: string;
 };
 export declare type ApproveInfiniteInput<C extends SupportedChainIds> = {
     quote: TradeQuote<C>;
@@ -122,6 +122,10 @@ export declare enum SwapperType {
     Thorchain = "Thorchain",
     Test = "Test"
 }
+export declare type TradeTxs = {
+    sellTxid: string;
+    buyTxid?: string;
+};
 export declare enum SwapErrorTypes {
     ALLOWANCE_REQUIRED_FAILED = "ALLOWANCE_REQUIRED_FAILED",
     APPROVE_INFINITE_FAILED = "APPROVE_INFINITE_FAILED",
@@ -137,7 +141,8 @@ export declare enum SwapErrorTypes {
     UNSUPPORTED_PAIR = "UNSUPPORTED_PAIR",
     USD_RATE_FAILED = "USD_RATE_FAILED",
     UNSUPPORTED_CHAIN = "UNSUPPORTED_CHAIN",
-    VALIDATION_FAILED = "VALIDATION_FAILED"
+    VALIDATION_FAILED = "VALIDATION_FAILED",
+    MAKE_MEMO_FAILED = "MAKE_MEMO_FAILED"
 }
 export interface Swapper {
     /** perform any necessary async initialization */
@@ -180,5 +185,6 @@ export interface Swapper {
      * Get supported sell assetIds
      */
     filterAssetIdsBySellable(assetIds: AssetId[]): AssetId[];
+    getTradeTxs(tradeResult: TradeResult): Promise<TradeTxs>;
 }
 export {};

package/dist/api.js

@@ -27,4 +27,5 @@ var SwapErrorTypes;
     SwapErrorTypes["USD_RATE_FAILED"] = "USD_RATE_FAILED";
     SwapErrorTypes["UNSUPPORTED_CHAIN"] = "UNSUPPORTED_CHAIN";
     SwapErrorTypes["VALIDATION_FAILED"] = "VALIDATION_FAILED";
+    SwapErrorTypes["MAKE_MEMO_FAILED"] = "MAKE_MEMO_FAILED";
 })(SwapErrorTypes = exports.SwapErrorTypes || (exports.SwapErrorTypes = {}));

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

@@ -1,6 +1,6 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
-import { ApprovalNeededOutput, BuyAssetBySellIdInput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult } from '../../api';
+import { ApprovalNeededOutput, BuyAssetBySellIdInput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
 /**
  * Playground for testing different scenarios of multiple swappers in the manager.
  * Meant for local testing only
@@ -19,4 +19,5 @@ export declare class TestSwapper implements Swapper {
     buildTrade(): Promise<Trade<SupportedChainIds>>;
     getTradeQuote(): Promise<TradeQuote<SupportedChainIds>>;
     executeTrade(): Promise<TradeResult>;
+    getTradeTxs(): Promise<TradeTxs>;
 }

package/dist/swappers/test/TestSwapper.js

@@ -9,7 +9,7 @@ const api_1 = require("../../api");
 class TestSwapper {
     constructor() {
         this.supportAssets = [
-            'bip122:000000000933ea01ad0ee984209779ba/slip44:0',
+            'bip122:000000000019d6689c085ae165831e93/slip44:0',
             'cosmos:cosmoshub-4/slip44:118',
             'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'
         ];
@@ -52,5 +52,8 @@ class TestSwapper {
     async executeTrade() {
         throw new Error('TestSwapper: executeTrade unimplemented');
     }
+    async getTradeTxs() {
+        throw new Error('TestSwapper: executeTrade unimplemented');
+    }
 }
 exports.TestSwapper = TestSwapper;

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

@@ -1,6 +1,6 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
-import { ApprovalNeededOutput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult } from '../../api';
+import { ApprovalNeededOutput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
 export declare class ThorchainSwapper implements Swapper {
     getType(): SwapperType;
     initialize(): Promise<void>;
@@ -13,4 +13,5 @@ export declare class ThorchainSwapper implements Swapper {
     buildTrade(): Promise<Trade<SupportedChainIds>>;
     getTradeQuote(): Promise<TradeQuote<SupportedChainIds>>;
     executeTrade(): Promise<TradeResult>;
+    getTradeTxs(): Promise<TradeTxs>;
 }

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -38,5 +38,8 @@ class ThorchainSwapper {
     async executeTrade() {
         throw new Error('ThorchainSwapper: executeTrade unimplemented');
     }
+    async getTradeTxs() {
+        throw new Error('ThorchainSwapper: executeTrade unimplemented');
+    }
 }
 exports.ThorchainSwapper = ThorchainSwapper;

package/dist/swappers/thorchain/utils/makeSwapMemo.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @returns thorchain memo shortened to a max of 80 characters as described:
+ * https://dev.thorchain.org/thorchain-dev/memos#mechanism-for-transaction-intent
+ */
+export declare const makeSwapMemo: ({ buyAssetId, destinationAddress, limit }: {
+    buyAssetId: string;
+    destinationAddress: string;
+    limit: string;
+}) => string;

package/dist/swappers/thorchain/utils/makeSwapMemo.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeSwapMemo = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const api_1 = require("../../../api");
+// BTC (and likely other utxo coins) can only support up to 80 character memos
+const MAX_LENGTH = 80;
+/**
+ * @returns thorchain memo shortened to a max of 80 characters as described:
+ * https://dev.thorchain.org/thorchain-dev/memos#mechanism-for-transaction-intent
+ */
+const makeSwapMemo = ({ buyAssetId, destinationAddress, limit }) => {
+    const thorId = caip_1.adapters.assetIdToPoolAssetId({ assetId: buyAssetId });
+    if (!thorId)
+        throw new api_1.SwapError('[makeSwapMemo] - undefined thorId for given buyAssetId', {
+            code: api_1.SwapErrorTypes.MAKE_MEMO_FAILED,
+            details: { buyAssetId }
+        });
+    const memo = `s:${thorId}:${destinationAddress}:${limit}`;
+    if (memo.length <= MAX_LENGTH)
+        return memo;
+    const abbreviationAmount = memo.length - MAX_LENGTH;
+    if (abbreviationAmount > 39)
+        throw new api_1.SwapError('[makeSwapMemo] - too much abbreviation for accurate matching', {
+            code: api_1.SwapErrorTypes.MAKE_MEMO_FAILED
+        });
+    // delimeter between ticker and id allowing us to abbreviate the id: https://dev.thorchain.org/thorchain-dev/memos#asset-notation
+    const delimeterIndex = memo.indexOf('-') + 1;
+    if (!delimeterIndex) {
+        throw new api_1.SwapError('[makeSwapMemo] - unable to abbreviate asset, no delimeter found', {
+            code: api_1.SwapErrorTypes.MAKE_MEMO_FAILED
+        });
+    }
+    return memo.replace(memo.slice(delimeterIndex, delimeterIndex + abbreviationAmount), '');
+};
+exports.makeSwapMemo = makeSwapMemo;

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

@@ -2,7 +2,7 @@ import { AssetId } from '@shapeshiftoss/caip';
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
 import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
 import Web3 from 'web3';
-import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetMinMaxInput, GetTradeQuoteInput, MinMaxOutput, Swapper, SwapperType, TradeQuote, TradeResult, ZrxTrade } from '../../api';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetMinMaxInput, GetTradeQuoteInput, MinMaxOutput, Swapper, SwapperType, TradeQuote, TradeResult, TradeTxs, ZrxTrade } from '../../api';
 export declare type ZrxSwapperDeps = {
     adapterManager: ChainAdapterManager;
     web3: Web3;
@@ -22,4 +22,5 @@ export declare class ZrxSwapper implements Swapper {
     approveInfinite(args: ApproveInfiniteInput<SupportedChainIds>): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(assetIds?: AssetId[]): AssetId[];
+    getTradeTxs(tradeResult: TradeResult): Promise<TradeTxs>;
 }

package/dist/swappers/zrx/ZrxSwapper.js

@@ -50,6 +50,12 @@ class ZrxSwapper {
     filterAssetIdsBySellable(assetIds = []) {
         return assetIds.filter((id) => id.startsWith('eip155:1') && !blacklist_1.UNSUPPORTED_ASSETS.includes(id));
     }
+    async getTradeTxs(tradeResult) {
+        return {
+            sellTxid: tradeResult.tradeId,
+            buyTxid: tradeResult.tradeId
+        };
+    }
 }
 exports.ZrxSwapper = ZrxSwapper;
 ZrxSwapper.swapperName = 'ZrxSwapper';

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

@@ -30,14 +30,14 @@ async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
         if (wallet.supportsOfflineSigning()) {
             const signedTx = await adapter.signTransaction({ txToSign: txWithQuoteData, wallet });
             const txid = await adapter.broadcastTransaction(signedTx);
-            return { txid };
+            return { tradeId: txid };
         }
         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 };
+            return { tradeId: txid };
         }
         else {
             throw new api_1.SwapError('[zrxExecuteTrade]', {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "5.2.1",
+  "version": "5.3.0",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -31,7 +31,7 @@
   },
   "peerDependencies": {
     "@shapeshiftoss/asset-service": "^4.2.4",
-    "@shapeshiftoss/caip": "^5.0.0",
+    "@shapeshiftoss/caip": "^5.2.1",
     "@shapeshiftoss/chain-adapters": "^4.3.3",
     "@shapeshiftoss/hdwallet-core": "1.20.0",
     "@shapeshiftoss/types": "^4.3.1",
@@ -39,7 +39,7 @@
   },
   "devDependencies": {
     "@shapeshiftoss/asset-service": "^4.2.4",
-    "@shapeshiftoss/caip": "^5.0.0",
+    "@shapeshiftoss/caip": "^5.2.1",
     "@shapeshiftoss/chain-adapters": "^4.3.3",
     "@shapeshiftoss/hdwallet-core": "^1.20.0",
     "@shapeshiftoss/types": "^4.3.1",