@shapeshiftoss/caip 5.0.1 → 5.2.1

package/dist/adapters/index.d.ts

@@ -4,3 +4,4 @@ export * from './yearn';
 export * from './osmosis';
 export * from './gem';
 export * from './banxa';
+export * from './thortrading';

package/dist/adapters/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./yearn"), exports);
 __exportStar(require("./osmosis"), exports);
 __exportStar(require("./gem"), exports);
 __exportStar(require("./banxa"), exports);
+__exportStar(require("./thortrading"), exports);

package/dist/adapters/thortrading/index.d.ts

@@ -0,0 +1,6 @@
+import { AssetId } from './../../assetId/assetId';
+export declare const poolAssetIdToAssetId: (id: string) => AssetId | undefined;
+export declare const assetIdToPoolAssetId: ({ assetId, symbol }: {
+    assetId: AssetId;
+    symbol?: string | undefined;
+}) => string | undefined;

package/dist/adapters/thortrading/index.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetIdToPoolAssetId = exports.poolAssetIdToAssetId = void 0;
+const assetId_1 = require("../../assetId/assetId");
+const constants_1 = require("../../constants");
+const constants_2 = require("./../../constants");
+// naming convention for regex variables are taken from thorchian docs
+// https://dev.thorchain.org/thorchain-dev/memos#asset-notation
+// https://regex101.com/r/MAj4WA/1
+const thorIdRegex = /(?<chain>[A-Za-z]+)\.(?<ticker>[A-Za-z]+)(-(?<id>[A-Za-z0-9]+))?/;
+/*
+ * Note: this only works with thorchain assets we support
+ * see https://dev.thorchain.org/thorchain-dev/memos#asset-notation for reference
+ *
+ * We are also not supporting asset abbreviations using fuzzy logic at this time
+ * see https://dev.thorchain.org/thorchain-dev/memos#asset-abbreviations
+ */
+const poolAssetIdToAssetId = (id) => {
+    var _a;
+    const matches = (_a = thorIdRegex.exec(id)) === null || _a === void 0 ? void 0 : _a.groups;
+    // To avoid any case sensitive issues, uppercase both chain and ticker.
+    const chain = matches === null || matches === void 0 ? void 0 : matches.chain.toUpperCase();
+    const ticker = matches === null || matches === void 0 ? void 0 : matches.ticker.toUpperCase();
+    const contractAddress = matches === null || matches === void 0 ? void 0 : matches.id;
+    switch (chain) {
+        case 'ETH': {
+            if (ticker === 'ETH')
+                return constants_1.ethAssetId;
+            // We make Eth contract addresses lower case to simplify comparisons
+            const assetReference = contractAddress === null || contractAddress === void 0 ? void 0 : contractAddress.toLowerCase();
+            if (!assetReference)
+                return undefined;
+            const chainId = constants_1.ethChainId;
+            const assetNamespace = 'erc20';
+            try {
+                return (0, assetId_1.toAssetId)({ chainId, assetNamespace, assetReference });
+            }
+            catch (e) {
+                console.error(e);
+                return undefined;
+            }
+        }
+        case 'BTC': {
+            return constants_1.btcAssetId;
+        }
+        default: {
+            return undefined;
+        }
+    }
+};
+exports.poolAssetIdToAssetId = poolAssetIdToAssetId;
+const assetIdToPoolAssetId = ({ assetId, symbol }) => {
+    try {
+        const { chainId, assetReference } = (0, assetId_1.fromAssetId)(assetId);
+        // https://dev.thorchain.org/thorchain-dev/memos#asset-notation
+        switch (chainId) {
+            case constants_1.ethChainId: {
+                if (assetId === constants_1.ethAssetId)
+                    return 'ETH.ETH';
+                if (!symbol)
+                    return undefined;
+                // this is predicated on the assumption that the symbol from the asset service
+                // and the contract address are static, correct, and won't ever change. Midgard
+                // also returns the asset notation with the assetReference in uppercase format,
+                // so we will keep that consistent here and uppercase it.
+                return `ETH.${symbol}-${assetReference.toUpperCase()}`;
+            }
+            case constants_2.btcChainId: {
+                return 'BTC.BTC';
+            }
+            default: {
+                return undefined;
+            }
+        }
+    }
+    catch (e) {
+        return undefined;
+    }
+};
+exports.assetIdToPoolAssetId = assetIdToPoolAssetId;

package/dist/assetId/assetId.js

@@ -72,16 +72,20 @@ const fromAssetId = (assetId) => {
     var _a;
     if (!(0, typeGuards_1.isAssetId)(assetId))
         throw new Error(`fromAssetId: invalid AssetId: ${assetId}`);
-    const matches = (_a = utils_1.parseAssetIdRegExp.exec(assetId)) !== null && _a !== void 0 ? _a : [];
+    const matches = (_a = utils_1.parseAssetIdRegExp.exec(assetId)) === null || _a === void 0 ? void 0 : _a.groups;
+    if (!matches)
+        throw new Error(`fromAssetId: could not parse AssetId: ${assetId}`);
     // These should never throw because isAssetId() would have already caught it, but they help with type inference
-    (0, typeGuards_1.assertIsChainNamespace)(matches[1]);
-    (0, typeGuards_1.assertIsChainReference)(matches[2]);
-    (0, typeGuards_1.assertIsAssetNamespace)(matches[3]);
-    const chainNamespace = matches[1];
-    const chainReference = matches[2];
-    const assetNamespace = matches[3];
+    (0, typeGuards_1.assertIsChainNamespace)(matches.chainNamespace);
+    (0, typeGuards_1.assertIsChainReference)(matches.chainReference);
+    (0, typeGuards_1.assertIsAssetNamespace)(matches.assetNamespace);
+    const chainNamespace = matches.chainNamespace;
+    const chainReference = matches.chainReference;
+    const assetNamespace = matches.assetNamespace;
     const shouldLowercaseAssetReference = assetNamespace && ['erc20', 'erc721'].includes(assetNamespace);
-    const assetReference = shouldLowercaseAssetReference ? (0, toLower_1.default)(matches[4]) : matches[4];
+    const assetReference = shouldLowercaseAssetReference
+        ? (0, toLower_1.default)(matches.assetReference)
+        : matches.assetReference;
     (0, typeGuards_1.assertIsChainReference)(chainReference);
     (0, typeGuards_1.assertIsChainNamespace)(chainNamespace);
     const chainId = (0, chainId_1.toChainId)({ chainNamespace, chainReference });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/caip",
-  "version": "5.0.1",
+  "version": "5.2.1",
   "description": "CAIP Implementation",
   "homepage": "",
   "license": "MIT",
@@ -31,10 +31,10 @@
     "type-check": "tsc --project ./tsconfig.build.json --noEmit"
   },
   "peerDependencies": {
-    "@shapeshiftoss/types": "3.1.3"
+    "@shapeshiftoss/types": "^4.3.1"
   },
   "devDependencies": {
-    "@shapeshiftoss/types": "3.1.3",
+    "@shapeshiftoss/types": "^4.3.1",
     "@yfi/sdk": "^1.0.30",
     "axios": "^0.26.1",
     "ts-node": "^10.7.0"