@shapeshiftoss/swapper 5.2.3 → 5.3.0

package/dist/api.d.ts

@@ -141,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 */

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "5.2.3",
+  "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",