@shapeshiftoss/swapper 17.0.1 → 17.1.0

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

@@ -0,0 +1,3 @@
+import { ChainId } from '@shapeshiftoss/caip';
+export declare const isValidMemoAddress: (chainId: ChainId, thorId: string, address: string) => boolean;
+export declare const assertIsValidMemo: (memo: string) => void;

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

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsValidMemo = exports.isValidMemoAddress = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
+const multicoin_address_validator_1 = __importDefault(require("multicoin-address-validator"));
+const api_1 = require("../../../../api");
+const thorChainAssetToChainId = new Map([
+    ['ETH', caip_1.ethChainId],
+    ['AVAX', caip_1.avalancheChainId],
+    ['BTC', caip_1.btcChainId],
+    ['BCH', caip_1.bchChainId],
+    ['LTC', caip_1.ltcChainId],
+    ['BNB', caip_1.binanceChainId],
+    ['DOGE', caip_1.dogeChainId],
+    ['GAIA', caip_1.cosmosChainId],
+    ['RUNE', caip_1.thorchainChainId],
+]);
+const isValidMemoAddress = (chainId, thorId, address) => {
+    switch (true) {
+        case thorId.startsWith('ETH.'):
+        case thorId.startsWith('AVAX.'):
+        case thorId.startsWith('BTC.'):
+        case thorId.startsWith('BCH.'):
+        case thorId.startsWith('LTC.'):
+        case thorId.startsWith('BNB.'):
+        case thorId.startsWith('DOGE.'): {
+            const chainLabel = (0, chain_adapters_1.chainIdToChainLabel)(chainId);
+            return multicoin_address_validator_1.default.validate(address, chainLabel);
+        }
+        case thorId.startsWith('GAIA.'):
+            return address.startsWith('cosmos');
+        case thorId.startsWith('RUNE.'):
+            return address.startsWith('thor');
+        default:
+            return false;
+    }
+};
+exports.isValidMemoAddress = isValidMemoAddress;
+const assertIsValidMemo = (memo) => {
+    // BTC (and likely other utxo coins) can only support up to 80 character (byte) memos
+    const MAX_MEMO_LENGTH = 80;
+    const MEMO_PART_DELIMITER = ':';
+    const POOL_PART_DELIMITER = '.';
+    const memoParts = memo.split(MEMO_PART_DELIMITER);
+    const pool = memoParts[1];
+    const address = memoParts[2];
+    const buyAssetChainId = thorChainAssetToChainId.get(pool.split(POOL_PART_DELIMITER)[0]);
+    const isAddressValid = buyAssetChainId
+        ? (0, exports.isValidMemoAddress)(buyAssetChainId, pool, address)
+        : undefined;
+    if (!isAddressValid) {
+        throw new api_1.SwapError(`[makeSwapMemo] - memo ${memo} invalid`, {
+            code: api_1.SwapErrorType.MAKE_MEMO_FAILED,
+        });
+    }
+    if (memo.length > MAX_MEMO_LENGTH) {
+        throw new api_1.SwapError(`[makeSwapMemo] - memo length exceeds ${MAX_MEMO_LENGTH} characters`, {
+            code: api_1.SwapErrorType.MAKE_MEMO_FAILED,
+        });
+    }
+};
+exports.assertIsValidMemo = assertIsValidMemo;

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

@@ -1,9 +1,20 @@
 /**
- * @returns thorchain memo shortened to a max of 80 characters as described:
- * https://dev.thorchain.org/thorchain-dev/memos#mechanism-for-transaction-intent
+ * definition of THORChain asset notation
+ * https://dev.thorchain.org/thorchain-dev/concepts/memos#asset-notation
+ *
+ * e.g. BTC/BTC (bitcoin synth) - unaffected by this function
+ * e.g. ETH.USDT-0xdac17f958d2ee523a2206206994597c13d831ec7 (usdt on ethereum) - abbreviated by this function
  */
-export declare const makeSwapMemo: ({ buyAssetId, destinationAddress, limit, }: {
+export declare const abbreviateThorAssetId: (fullThorAssetId: string) => string;
+declare type MakeSwapMemoArgs = {
     buyAssetId: string;
     destinationAddress: string;
     limit: string;
-}) => string;
+};
+declare type MakeSwapMemo = (args: MakeSwapMemoArgs) => string;
+/**
+ * @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: MakeSwapMemo;
+export {};

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

@@ -1,22 +1,55 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeSwapMemo = void 0;
+exports.makeSwapMemo = exports.abbreviateThorAssetId = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const api_1 = require("../../../../api");
 const constants_1 = require("../constants");
-// BTC (and likely other utxo coins) can only support up to 80 character memos
-const MAX_LENGTH = 80;
+const assertIsValidMemo_1 = require("./assertIsValidMemo");
+/**
+ * definition of THORChain asset notation
+ * https://dev.thorchain.org/thorchain-dev/concepts/memos#asset-notation
+ *
+ * e.g. BTC/BTC (bitcoin synth) - unaffected by this function
+ * e.g. ETH.USDT-0xdac17f958d2ee523a2206206994597c13d831ec7 (usdt on ethereum) - abbreviated by this function
+ */
+const abbreviateThorAssetId = (fullThorAssetId) => {
+    const CONTRACT_ADDRESS_DELIMITER = '-';
+    const [existingPrefix, contractAddress] = fullThorAssetId.split(CONTRACT_ADDRESS_DELIMITER);
+    // we can't shorten any asset that doesn't have a contract address
+    if (!contractAddress)
+        return fullThorAssetId;
+    /**
+     * https://dev.thorchain.org/thorchain-dev/concepts/memos#asset-abbreviations
+     *
+     * ETH.USDT
+     * ETH.USDT-ec7                                         // 3 characters  - "short"
+     * ETH.USDT-6994597c13d831ec7                           // 17 characters - "medium"
+     * ETH.USDT-0xdac17f958d2ee523a2206206994597c13d831ec7  // 26 characters - "long"
+     */
+    /**
+     * for the purposes of future proofing, let's use the shortest permissible format for contract addresses
+     * this has (26 + 10)^3 = 46,656 of entropy, and per the docs, the deepest pool will be used upon a collision
+     */
+    const SHORT_ABBREVIATION_LENGTH = 3;
+    // take the last n characters of the contract address (negative slice takes last n characters)
+    const shortenedContractAddress = contractAddress.slice(-SHORT_ABBREVIATION_LENGTH);
+    // and put it back together with the existing prefix
+    return [existingPrefix, shortenedContractAddress].join(CONTRACT_ADDRESS_DELIMITER);
+};
+exports.abbreviateThorAssetId = abbreviateThorAssetId;
 // use symbol of thor Asset?
 const runeThorId = 'RUNE';
 /**
  * @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 makeSwapMemo = ({ buyAssetId, destinationAddress, limit }) => {
     const isRune = buyAssetId === caip_1.thorchainAssetId;
-    const thorId = isRune ? runeThorId : caip_1.adapters.assetIdToPoolAssetId({ assetId: buyAssetId });
-    if (!thorId)
-        throw new api_1.SwapError('[makeSwapMemo] - undefined thorId for given buyAssetId', {
+    const fullThorAssetId = isRune
+        ? runeThorId
+        : caip_1.adapters.assetIdToPoolAssetId({ assetId: buyAssetId });
+    if (!fullThorAssetId)
+        throw new api_1.SwapError('[makeSwapMemo] - undefined thorAssetId for given buyAssetId', {
             code: api_1.SwapErrorType.MAKE_MEMO_FAILED,
             details: { buyAssetId },
         });
@@ -27,21 +60,9 @@ const makeSwapMemo = ({ buyAssetId, destinationAddress, limit, }) => {
     const parsedDestinationAddress = destinationAddress.includes('bitcoincash:')
         ? destinationAddress.replace('bitcoincash:', '')
         : destinationAddress;
-    const memo = `s:${thorId}:${parsedDestinationAddress}:${limit}:${constants_1.THORCHAIN_AFFILIATE_NAME}:${constants_1.THORCHAIN_AFFILIATE_BIPS}`;
-    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.SwapErrorType.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.SwapErrorType.MAKE_MEMO_FAILED,
-        });
-    }
-    return memo.replace(memo.slice(delimeterIndex, delimeterIndex + abbreviationAmount), '');
+    const abbreviatedThorAssetId = (0, exports.abbreviateThorAssetId)(fullThorAssetId);
+    const memo = `s:${abbreviatedThorAssetId}:${parsedDestinationAddress}:${limit}:${constants_1.THORCHAIN_AFFILIATE_NAME}:${constants_1.THORCHAIN_AFFILIATE_BIPS}`;
+    (0, assertIsValidMemo_1.assertIsValidMemo)(memo);
+    return memo;
 };
 exports.makeSwapMemo = makeSwapMemo;

package/package.json

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