@shapeshiftoss/caip 2.2.5 → 2.5.0

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

@@ -4,3 +4,10 @@ export declare const getSupportedBanxaAssets: () => {
     CAIP19: string;
     ticker: string;
 }[];
+/**
+ * Convert a banxa asset identifier to a Banxa chain identifier for use in Banxa HTTP URLs
+ *
+ * @param {string} banxaAssetId - a Banxa asset string referencing a specific asset; e.g., 'atom'
+ * @returns {string} - a Banxa chain identifier; e.g., 'cosmos'
+ */
+export declare const getBanxaBlockchainFromBanxaAssetTicker: (banxaAssetId: string) => string;

package/dist/adapters/banxa/index.js

@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSupportedBanxaAssets = exports.CAIP19ToBanxaTicker = exports.banxaTickerToCAIP19 = void 0;
+exports.getBanxaBlockchainFromBanxaAssetTicker = exports.getSupportedBanxaAssets = exports.CAIP19ToBanxaTicker = exports.banxaTickerToCAIP19 = void 0;
 const entries_1 = __importDefault(require("lodash/entries"));
 const toLower_1 = __importDefault(require("lodash/toLower"));
+const caip2_1 = require("../../caip2/caip2");
+const caip19_1 = require("../../caip19/caip19");
 const CAIP19ToBanxaTickerMap = {
     'bip122:000000000019d6689c085ae165831e93/slip44:0': 'btc',
     'cosmos:cosmoshub-4/slip44:118': 'atom',
@@ -47,3 +49,28 @@ const getSupportedBanxaAssets = () => (0, entries_1.default)(CAIP19ToBanxaTicker
     ticker
 }));
 exports.getSupportedBanxaAssets = getSupportedBanxaAssets;
+/**
+ * map ChainIds to Banxa blockchain codes (ETH, BTC, COSMOS),
+ * since some Banxa assets could be on multiple chains and their default
+ * chain won't be exactly the same as ours.
+ */
+const chainIdToBanxaBlockchainCodeMap = {
+    'eip155:1': 'ETH',
+    'bip122:000000000019d6689c085ae165831e93': 'BTC',
+    'cosmos:cosmoshub-4': 'COSMOS'
+};
+/**
+ * Convert a banxa asset identifier to a Banxa chain identifier for use in Banxa HTTP URLs
+ *
+ * @param {string} banxaAssetId - a Banxa asset string referencing a specific asset; e.g., 'atom'
+ * @returns {string} - a Banxa chain identifier; e.g., 'cosmos'
+ */
+const getBanxaBlockchainFromBanxaAssetTicker = (banxaAssetId) => {
+    const assetCAIP19 = (0, exports.banxaTickerToCAIP19)(banxaAssetId.toLowerCase());
+    if (!assetCAIP19)
+        throw new Error(`getBanxaBlockchainFromBanxaAssetTicker: ${banxaAssetId} is not supported`);
+    const { chain, network } = (0, caip19_1.fromCAIP19)(assetCAIP19);
+    const chainId = (0, caip2_1.toCAIP2)({ network, chain });
+    return chainIdToBanxaBlockchainCodeMap[chainId];
+};
+exports.getBanxaBlockchainFromBanxaAssetTicker = getBanxaBlockchainFromBanxaAssetTicker;

package/dist/caip19/caip19.js

@@ -39,22 +39,6 @@ const validAssetNamespaces = Object.freeze({
         AssetNamespace.Slip44
     ]
 });
-const chainReferenceToNetworkType = Object.freeze({
-    [caip2_1.ChainReference.BitcoinMainnet]: types_1.NetworkTypes.MAINNET,
-    [caip2_1.ChainReference.BitcoinTestnet]: types_1.NetworkTypes.TESTNET,
-    [caip2_1.ChainReference.EthereumMainnet]: types_1.NetworkTypes.MAINNET,
-    [caip2_1.ChainReference.EthereumRopsten]: types_1.NetworkTypes.ETH_ROPSTEN,
-    [caip2_1.ChainReference.EthereumRinkeby]: types_1.NetworkTypes.ETH_RINKEBY,
-    [caip2_1.ChainReference.CosmosHubMainnet]: types_1.NetworkTypes.COSMOSHUB_MAINNET,
-    [caip2_1.ChainReference.CosmosHubVega]: types_1.NetworkTypes.COSMOSHUB_VEGA,
-    [caip2_1.ChainReference.OsmosisMainnet]: types_1.NetworkTypes.OSMOSIS_MAINNET,
-    [caip2_1.ChainReference.OsmosisTestnet]: types_1.NetworkTypes.OSMOSIS_TESTNET
-});
-const chainNamespaceToChainType = Object.freeze({
-    [caip2_1.ChainNamespace.Bitcoin]: types_1.ChainTypes.Bitcoin,
-    [caip2_1.ChainNamespace.Ethereum]: types_1.ChainTypes.Ethereum,
-    [caip2_1.ChainNamespace.Cosmos]: types_1.ChainTypes.Cosmos
-});
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function stringToEnum(obj, item) {
     var _a;
@@ -108,8 +92,8 @@ const fromCAIP19 = (caip19) => {
     const matches = (_a = parseCaip19RegExp.exec(caip19)) !== null && _a !== void 0 ? _a : [];
     // We're okay casting these strings to enums because we check to make sure
     // they are valid enum values
-    let chain = chainNamespaceToChainType[matches[1]];
-    const network = chainReferenceToNetworkType[matches[2]];
+    let chain = caip2_1.chainNamespaceToChainType[matches[1]];
+    const network = caip2_1.chainReferenceToNetworkType[matches[2]];
     const assetNamespace = stringToEnum(AssetNamespace, matches[3]);
     let assetReference = matches[4];
     if (chain && network && assetNamespace && assetReference) {

package/dist/caip2/caip2.d.ts

@@ -33,4 +33,7 @@ declare type FromCAIP2 = (caip2: string) => FromCAIP2Return;
 export declare const fromCAIP2: FromCAIP2;
 declare type IsCAIP2 = (caip2: string) => boolean;
 export declare const isCAIP2: IsCAIP2;
+export declare const chainReferenceToNetworkType: Record<ChainReference, NetworkTypes>;
+export declare const networkTypeToChainReference: Record<NetworkTypes, ChainReference>;
+export declare const chainNamespaceToChainType: Record<ChainNamespace, ChainTypes>;
 export {};

package/dist/caip2/caip2.js

@@ -1,8 +1,12 @@
 "use strict";
 // https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCAIP2 = exports.fromCAIP2 = exports.toCAIP2 = exports.ChainReference = exports.ChainNamespace = void 0;
+exports.chainNamespaceToChainType = exports.networkTypeToChainReference = exports.chainReferenceToNetworkType = exports.isCAIP2 = exports.fromCAIP2 = exports.toCAIP2 = exports.ChainReference = exports.ChainNamespace = void 0;
 const types_1 = require("@shapeshiftoss/types");
+const invert_1 = __importDefault(require("lodash/invert"));
 var ChainNamespace;
 (function (ChainNamespace) {
     ChainNamespace["Ethereum"] = "eip155";
@@ -210,3 +214,20 @@ const isCAIP2 = (caip2) => {
     throw new Error(`isCAIP2: invalid caip2 ${caip2}`);
 };
 exports.isCAIP2 = isCAIP2;
+exports.chainReferenceToNetworkType = Object.freeze({
+    [ChainReference.BitcoinMainnet]: types_1.NetworkTypes.MAINNET,
+    [ChainReference.BitcoinTestnet]: types_1.NetworkTypes.TESTNET,
+    [ChainReference.EthereumMainnet]: types_1.NetworkTypes.MAINNET,
+    [ChainReference.EthereumRopsten]: types_1.NetworkTypes.ETH_ROPSTEN,
+    [ChainReference.EthereumRinkeby]: types_1.NetworkTypes.ETH_RINKEBY,
+    [ChainReference.CosmosHubMainnet]: types_1.NetworkTypes.COSMOSHUB_MAINNET,
+    [ChainReference.CosmosHubVega]: types_1.NetworkTypes.COSMOSHUB_VEGA,
+    [ChainReference.OsmosisMainnet]: types_1.NetworkTypes.OSMOSIS_MAINNET,
+    [ChainReference.OsmosisTestnet]: types_1.NetworkTypes.OSMOSIS_TESTNET
+});
+exports.networkTypeToChainReference = (0, invert_1.default)(exports.chainReferenceToNetworkType);
+exports.chainNamespaceToChainType = Object.freeze({
+    [ChainNamespace.Bitcoin]: types_1.ChainTypes.Bitcoin,
+    [ChainNamespace.Ethereum]: types_1.ChainTypes.Ethereum,
+    [ChainNamespace.Cosmos]: types_1.ChainTypes.Cosmos
+});

package/dist/index.d.ts

@@ -3,6 +3,6 @@ import * as caip2 from './caip2/caip2';
 import * as caip10 from './caip10/caip10';
 import * as caip19 from './caip19/caip19';
 export { adapters, caip2, caip19, caip10 };
-export { ChainId, CAIP2, ChainReference } from './caip2/caip2';
-export { AccountId, CAIP10 } from './caip10/caip10';
-export { AssetId, AssetNamespace, AssetReference, CAIP19 } from './caip19/caip19';
+export * from './caip2/caip2';
+export * from './caip10/caip10';
+export * from './caip19/caip19';

package/dist/index.js

@@ -22,18 +22,21 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssetReference = exports.AssetNamespace = exports.ChainReference = exports.caip10 = exports.caip19 = exports.caip2 = exports.adapters = void 0;
+exports.caip10 = exports.caip19 = exports.caip2 = exports.adapters = void 0;
 const adapters = __importStar(require("./adapters"));
 exports.adapters = adapters;
+// TODO: These all go away on the caip breaking change PR
 const caip2 = __importStar(require("./caip2/caip2"));
 exports.caip2 = caip2;
 const caip10 = __importStar(require("./caip10/caip10"));
 exports.caip10 = caip10;
 const caip19 = __importStar(require("./caip19/caip19"));
 exports.caip19 = caip19;
-var caip2_1 = require("./caip2/caip2");
-Object.defineProperty(exports, "ChainReference", { enumerable: true, get: function () { return caip2_1.ChainReference; } });
-var caip19_1 = require("./caip19/caip19");
-Object.defineProperty(exports, "AssetNamespace", { enumerable: true, get: function () { return caip19_1.AssetNamespace; } });
-Object.defineProperty(exports, "AssetReference", { enumerable: true, get: function () { return caip19_1.AssetReference; } });
+// ENDTODO
+__exportStar(require("./caip2/caip2"), exports);
+__exportStar(require("./caip10/caip10"), exports);
+__exportStar(require("./caip19/caip19"), exports);

package/dist/utils.d.ts

@@ -0,0 +1,14 @@
+import { ChainId } from './caip2/caip2';
+import { AccountId } from './caip10/caip10';
+import { AssetId } from './caip19/caip19';
+export declare const btcAssetId = "bip122:000000000019d6689c085ae165831e93/slip44:0";
+export declare const ethAssetId = "eip155:1/slip44:60";
+export declare const cosmosAssetId = "cosmos:cosmoshub-4/slip44:118";
+export declare const ethChainId = "eip155:1";
+export declare const btcChainId = "bip122:000000000019d6689c085ae165831e93";
+export declare const cosmosChainId = "cosmos:cosmoshub-4";
+export declare const chainIdToAssetId: Record<ChainId, AssetId>;
+export declare const assetIdToChainId: (assetId: AssetId) => string;
+export declare const accountIdToChainId: (accountId: AccountId) => ChainId;
+export declare const accountIdToSpecifier: (accountId: AccountId) => string;
+export declare const getChainReferenceFromChainId: (chainId: ChainId) => import("./caip2/caip2").ChainReference;

package/dist/utils.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChainReferenceFromChainId = exports.accountIdToSpecifier = exports.accountIdToChainId = exports.assetIdToChainId = exports.chainIdToAssetId = exports.cosmosChainId = exports.btcChainId = exports.ethChainId = exports.cosmosAssetId = exports.ethAssetId = exports.btcAssetId = void 0;
+const caip2_1 = require("./caip2/caip2");
+const caip10_1 = require("./caip10/caip10");
+const caip19_1 = require("./caip19/caip19");
+exports.btcAssetId = 'bip122:000000000019d6689c085ae165831e93/slip44:0';
+exports.ethAssetId = 'eip155:1/slip44:60';
+exports.cosmosAssetId = 'cosmos:cosmoshub-4/slip44:118';
+exports.ethChainId = 'eip155:1';
+exports.btcChainId = 'bip122:000000000019d6689c085ae165831e93';
+exports.cosmosChainId = 'cosmos:cosmoshub-4';
+exports.chainIdToAssetId = {
+    [exports.ethChainId]: 'eip155:1/slip44:60',
+    [exports.btcChainId]: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+    [exports.cosmosChainId]: 'cosmos:cosmoshub-4/slip44:118'
+};
+const assetIdToChainId = (assetId) => {
+    const { chain, network } = (0, caip19_1.fromCAIP19)(assetId);
+    return (0, caip2_1.toCAIP2)({ chain, network });
+};
+exports.assetIdToChainId = assetIdToChainId;
+const accountIdToChainId = (accountId) => (0, caip10_1.fromCAIP10)(accountId).caip2;
+exports.accountIdToChainId = accountIdToChainId;
+const accountIdToSpecifier = (accountId) => (0, caip10_1.fromCAIP10)(accountId).account;
+exports.accountIdToSpecifier = accountIdToSpecifier;
+const getChainReferenceFromChainId = (chainId) => caip2_1.networkTypeToChainReference[(0, caip2_1.fromCAIP2)(chainId).network];
+exports.getChainReferenceFromChainId = getChainReferenceFromChainId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/caip",
-  "version": "2.2.5",
+  "version": "2.5.0",
   "description": "CAIP Implementation",
   "homepage": "",
   "license": "MIT",