@shapeshiftoss/caip 8.16.0 → 8.16.2

package/dist/cjs/assetId/assetId.test.js

@@ -0,0 +1,324 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const vitest_1 = require("vitest");
+const chainId_1 = require("../chainId/chainId");
+const constants_1 = require("../constants");
+const assetId_1 = require("./assetId");
+(0, vitest_1.describe)('assetId', () => {
+    (0, vitest_1.it)('should have matching CAIP19 aliases', () => {
+        (0, vitest_1.expect)(assetId_1.toAssetId).toEqual(assetId_1.toCAIP19);
+        (0, vitest_1.expect)(assetId_1.fromAssetId).toEqual(assetId_1.fromCAIP19);
+    });
+    (0, vitest_1.describe)('toAssetId', () => {
+        (0, vitest_1.describe)('toAssetId(fromAssetId())', () => {
+            vitest_1.it.each([
+                ['eip155:1/slip44:60'],
+                ['eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'],
+                ['bip122:000000000019d6689c085ae165831e93/slip44:0'],
+                ['cosmos:cosmoshub-4/slip44:118'],
+                ['cosmos:thorchain-1/slip44:tcy'],
+            ])('returns an AssetId from the result of fromAssetId for %s', assetId => {
+                const result = (0, assetId_1.fromAssetId)(assetId);
+                (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(result, 'chainId'))).toBe(assetId);
+                (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(result, ['chainNamespace', 'chainReference']))).toBe(assetId);
+            });
+        });
+        (0, vitest_1.it)('can make eth AssetId on mainnet', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'slip44',
+                assetReference: constants_1.ASSET_REFERENCE.Ethereum,
+                chainId: (0, chainId_1.toChainId)({ chainNamespace, chainReference }),
+            };
+            const expected = 'eip155:1/slip44:60';
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toEqual(expected);
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toEqual(expected);
+        });
+        (0, vitest_1.it)('throws with invalid eth network', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.CosmosHubMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'slip44',
+                assetReference: constants_1.ASSET_REFERENCE.Ethereum,
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('throws with invalid namespace', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'bad',
+                assetReference: constants_1.ASSET_REFERENCE.Ethereum,
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('can make Cosmos AssetId on CosmosHub mainnet', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.CosmosSdk;
+            const chainReference = constants_1.CHAIN_REFERENCE.CosmosHubMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'slip44',
+                assetReference: constants_1.ASSET_REFERENCE.Cosmos,
+                chainId: (0, chainId_1.toChainId)({ chainNamespace, chainReference }),
+            };
+            const expected = 'cosmos:cosmoshub-4/slip44:118';
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toEqual(expected);
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toEqual(expected);
+        });
+        (0, vitest_1.it)('throws with invalid Cosmos network', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.CosmosSdk;
+            const chainReference = constants_1.CHAIN_REFERENCE.BitcoinMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'slip44',
+                assetReference: constants_1.ASSET_REFERENCE.Cosmos,
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('throws with invalid Cosmos slip44 reference', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.CosmosSdk;
+            const chainReference = constants_1.CHAIN_REFERENCE.CosmosHubMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'slip44',
+                assetReference: 'bad',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('throws with invalid btc network', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Utxo;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'slip44',
+                assetReference: constants_1.ASSET_REFERENCE.Bitcoin,
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('can make FOX AssetId on mainnet', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'erc20',
+                assetReference: '0xc770eefad204b5180df6a14ee197d99d808ee52d',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            const expected = 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d';
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toEqual(expected);
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toEqual(expected);
+        });
+        (0, vitest_1.it)('should lower case ERC20 asset references', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'erc20',
+                assetReference: '0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            const expected = 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d';
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toEqual(expected);
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toEqual(expected);
+        });
+        (0, vitest_1.it)('should lower case ERC721 asset references', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'erc721',
+                assetReference: '0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d/12345',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            const expected = 'eip155:1/erc721:0xc770eefad204b5180df6a14ee197d99d808ee52d/12345';
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toEqual(expected);
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toEqual(expected);
+        });
+        (0, vitest_1.it)('throws with invalid assetReference length', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'erc20',
+                assetReference: '0xfoo',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('throws with no assetReference string', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'erc20',
+                assetReference: '',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('throws with invalid assetReference string', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'erc20',
+                assetReference: 'gm',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('throws if no asset namespace provided', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: '',
+                assetReference: '0xdef1cafe',
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toThrow();
+            (0, vitest_1.expect)(() => (0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toThrow();
+        });
+        (0, vitest_1.it)('can make bitcoin AssetId on mainnet', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Utxo;
+            const chainReference = constants_1.CHAIN_REFERENCE.BitcoinMainnet;
+            const assetIdArgSuperset = {
+                chainNamespace,
+                chainReference,
+                assetNamespace: 'slip44',
+                assetReference: constants_1.ASSET_REFERENCE.Bitcoin,
+                chainId: `${chainNamespace}:${chainReference}`,
+            };
+            const expected = 'bip122:000000000019d6689c085ae165831e93/slip44:0';
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, 'chainId'))).toEqual(expected);
+            (0, vitest_1.expect)((0, assetId_1.toAssetId)((0, lodash_1.omit)(assetIdArgSuperset, ['chainNamespace', 'chainReference']))).toEqual(expected);
+        });
+    });
+    (0, vitest_1.describe)('fromAssetId', () => {
+        (0, vitest_1.describe)('fromAssetId(toAssetId())', () => {
+            const slip44 = 'slip44';
+            const erc20 = 'erc20';
+            vitest_1.it.each([
+                [constants_1.CHAIN_NAMESPACE.Utxo, constants_1.CHAIN_REFERENCE.BitcoinMainnet, slip44, constants_1.ASSET_REFERENCE.Bitcoin],
+                [constants_1.CHAIN_NAMESPACE.Evm, constants_1.CHAIN_REFERENCE.EthereumMainnet, slip44, constants_1.ASSET_REFERENCE.Ethereum],
+                [
+                    constants_1.CHAIN_NAMESPACE.Evm,
+                    constants_1.CHAIN_REFERENCE.EthereumMainnet,
+                    erc20,
+                    '0xc770eefad204b5180df6a14ee197d99d808ee52d',
+                ],
+                [
+                    constants_1.CHAIN_NAMESPACE.CosmosSdk,
+                    constants_1.CHAIN_REFERENCE.CosmosHubMainnet,
+                    slip44,
+                    constants_1.ASSET_REFERENCE.Cosmos,
+                ],
+            ])('returns a AssetId from the result of fromAssetId for %s', (chainNamespace, chainReference, assetNamespace, assetReference) => {
+                (0, vitest_1.expect)((0, assetId_1.fromAssetId)((0, assetId_1.toAssetId)({ chainNamespace, chainReference, assetNamespace, assetReference }))).toStrictEqual({
+                    chainNamespace,
+                    chainReference,
+                    assetReference,
+                    assetNamespace,
+                    chainId: (0, chainId_1.toChainId)({ chainNamespace, chainReference }),
+                });
+            });
+        });
+        (0, vitest_1.it)('can return chain, network from eth AssetId on mainnet', () => {
+            const AssetId = 'eip155:1/slip44:60';
+            const { chainId, chainReference, chainNamespace, assetNamespace, assetReference } = (0, assetId_1.fromAssetId)(AssetId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.Evm);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.EthereumMainnet);
+            (0, vitest_1.expect)(chainId).toEqual((0, chainId_1.toChainId)({ chainNamespace, chainReference }));
+            (0, vitest_1.expect)(assetNamespace).toEqual('slip44');
+            (0, vitest_1.expect)(assetReference).toEqual(constants_1.ASSET_REFERENCE.Ethereum);
+        });
+        (0, vitest_1.it)('can return chain, network from bitcoin AssetId on mainnet', () => {
+            const AssetId = 'bip122:000000000019d6689c085ae165831e93/slip44:0';
+            const { chainId, chainReference, chainNamespace, assetNamespace, assetReference } = (0, assetId_1.fromAssetId)(AssetId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.Utxo);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.BitcoinMainnet);
+            (0, vitest_1.expect)(chainId).toEqual((0, chainId_1.toChainId)({ chainNamespace, chainReference }));
+            (0, vitest_1.expect)(assetNamespace).toEqual('slip44');
+            (0, vitest_1.expect)(assetReference).toEqual(constants_1.ASSET_REFERENCE.Bitcoin);
+        });
+        (0, vitest_1.it)('can return chainId, chainReference, chainNamespace, assetNamespace, assetReference from FOX AssetId on mainnet', () => {
+            const AssetId = 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d';
+            const { chainId, chainReference, chainNamespace, assetNamespace, assetReference } = (0, assetId_1.fromAssetId)(AssetId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.Evm);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.EthereumMainnet);
+            (0, vitest_1.expect)(chainId).toEqual((0, chainId_1.toChainId)({ chainNamespace, chainReference }));
+            (0, vitest_1.expect)(assetNamespace).toEqual('erc20');
+            (0, vitest_1.expect)(assetReference).toEqual('0xc770eefad204b5180df6a14ee197d99d808ee52d');
+        });
+        (0, vitest_1.it)('should lower case assetReference for assetNamespace ERC20', () => {
+            const AssetId = 'eip155:1/erc20:0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d';
+            const { chainId, chainReference, chainNamespace, assetNamespace, assetReference } = (0, assetId_1.fromAssetId)(AssetId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.Evm);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.EthereumMainnet);
+            (0, vitest_1.expect)(chainId).toEqual((0, chainId_1.toChainId)({ chainNamespace, chainReference }));
+            (0, vitest_1.expect)(assetNamespace).toEqual('erc20');
+            (0, vitest_1.expect)(assetReference).toEqual('0xc770eefad204b5180df6a14ee197d99d808ee52d');
+        });
+        (0, vitest_1.it)('should lower case assetReference for assetNamespace ERC721', () => {
+            const AssetId = 'eip155:1/erc721:0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d/12345';
+            const { chainId, chainReference, chainNamespace, assetNamespace, assetReference } = (0, assetId_1.fromAssetId)(AssetId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.Evm);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.EthereumMainnet);
+            (0, vitest_1.expect)(chainId).toEqual((0, chainId_1.toChainId)({ chainNamespace, chainReference }));
+            (0, vitest_1.expect)(assetNamespace).toEqual('erc721');
+            const [address, id] = assetReference.split('/');
+            (0, vitest_1.expect)(address).toEqual('0xc770eefad204b5180df6a14ee197d99d808ee52d');
+            (0, vitest_1.expect)(id).toEqual('12345');
+        });
+        (0, vitest_1.it)('can parse a cosmoshub native token', () => {
+            const AssetId = 'cosmos:cosmoshub-4/slip44:118';
+            const { chainId, chainReference, chainNamespace, assetNamespace, assetReference } = (0, assetId_1.fromAssetId)(AssetId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.CosmosSdk);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.CosmosHubMainnet);
+            (0, vitest_1.expect)(chainId).toEqual((0, chainId_1.toChainId)({ chainNamespace, chainReference }));
+            (0, vitest_1.expect)(assetNamespace).toEqual('slip44');
+            (0, vitest_1.expect)(assetReference).toEqual(constants_1.ASSET_REFERENCE.Cosmos);
+        });
+        (0, vitest_1.it)('errors for an invalid AssetId format', () => {
+            (0, vitest_1.expect)(() => (0, assetId_1.fromAssetId)('invalid')).toThrow();
+        });
+        (0, vitest_1.it)('errors for invalid ChainNamespace', () => {
+            (0, vitest_1.expect)(() => (0, assetId_1.fromAssetId)('invalid:cosmoshub-4/slip44:118')).toThrow();
+        });
+        (0, vitest_1.it)('errors for invalid ChainReference type', () => {
+            (0, vitest_1.expect)(() => (0, assetId_1.fromAssetId)('cosmos:invalid/slip44:118')).toThrow();
+        });
+    });
+});

package/dist/cjs/chainId/chainId.js

@@ -0,0 +1,25 @@
+"use strict";
+// https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromCAIP2 = exports.toCAIP2 = exports.fromChainId = exports.toChainId = void 0;
+const typeGuards_1 = require("../typeGuards");
+const toChainId = (args) => {
+    const { chainNamespace, chainReference } = args;
+    const maybeChainId = `${chainNamespace}:${chainReference}`;
+    (0, typeGuards_1.assertIsChainId)(maybeChainId);
+    return maybeChainId;
+};
+exports.toChainId = toChainId;
+// NOTE: perf critical - benchmark any changes
+const fromChainId = (chainId) => {
+    const idx = chainId.indexOf(':');
+    const chainNamespace = chainId.substring(0, idx);
+    const chainReference = chainId.substring(idx + 1);
+    return {
+        chainNamespace: chainNamespace,
+        chainReference: chainReference,
+    };
+};
+exports.fromChainId = fromChainId;
+exports.toCAIP2 = exports.toChainId;
+exports.fromCAIP2 = exports.fromChainId;

package/dist/cjs/chainId/chainId.test.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const constants_1 = require("../constants");
+const typeGuards_1 = require("../typeGuards");
+const chainId_1 = require("./chainId");
+(0, vitest_1.describe)('chainId', () => {
+    (0, vitest_1.it)('should have matching CAIP2 aliases', () => {
+        (0, vitest_1.expect)(chainId_1.toChainId).toEqual(chainId_1.toCAIP2);
+        (0, vitest_1.expect)(chainId_1.fromChainId).toEqual(chainId_1.fromCAIP2);
+    });
+    (0, vitest_1.describe)('toChainId', () => {
+        (0, vitest_1.it)('can turn CosmosHub mainnet to ChainId', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.CosmosSdk;
+            const chainReference = constants_1.CHAIN_REFERENCE.CosmosHubMainnet;
+            const result = (0, chainId_1.toChainId)({ chainNamespace, chainReference });
+            (0, vitest_1.expect)(result).toEqual('cosmos:cosmoshub-4');
+        });
+        (0, vitest_1.it)('can turn Ethereum mainnet to ChainId', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Evm;
+            const chainReference = constants_1.CHAIN_REFERENCE.EthereumMainnet;
+            const result = (0, chainId_1.toChainId)({ chainNamespace, chainReference });
+            (0, vitest_1.expect)(result).toEqual('eip155:1');
+        });
+        (0, vitest_1.it)('can turn Bitcoin mainnet to ChainId', () => {
+            const chainNamespace = constants_1.CHAIN_NAMESPACE.Utxo;
+            const chainReference = constants_1.CHAIN_REFERENCE.BitcoinMainnet;
+            const result = (0, chainId_1.toChainId)({ chainNamespace, chainReference });
+            (0, vitest_1.expect)(result).toEqual('bip122:000000000019d6689c085ae165831e93');
+        });
+        (0, vitest_1.it)('should throw an error for an invalid chain', () => {
+            // @ts-ignore
+            (0, vitest_1.expect)(() => (0, chainId_1.toChainId)({
+                chainNamespace: constants_1.CHAIN_NAMESPACE.Utxo,
+                chainReference: constants_1.CHAIN_REFERENCE.CosmosHubMainnet,
+            })).toThrow('assertIsChainId: unsupported ChainId: bip122:cosmoshub-4');
+        });
+    });
+    (0, vitest_1.describe)('fromChainId', () => {
+        (0, vitest_1.it)('can turn Bitcoin mainnet to chain and network', () => {
+            const bitcoinChainId = 'bip122:000000000019d6689c085ae165831e93';
+            const { chainNamespace, chainReference } = (0, chainId_1.fromChainId)(bitcoinChainId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.Utxo);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.BitcoinMainnet);
+        });
+        (0, vitest_1.it)('can turn CosmosHub mainnet to chain and network', () => {
+            const cosmosHubChainId = 'cosmos:cosmoshub-4';
+            const { chainNamespace, chainReference } = (0, chainId_1.fromChainId)(cosmosHubChainId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.CosmosSdk);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.CosmosHubMainnet);
+        });
+        (0, vitest_1.it)('can turn Ethereum mainnet to chain and network', () => {
+            const ethereumChainId = 'eip155:1';
+            const { chainNamespace, chainReference } = (0, chainId_1.fromChainId)(ethereumChainId);
+            (0, vitest_1.expect)(chainNamespace).toEqual(constants_1.CHAIN_NAMESPACE.Evm);
+            (0, vitest_1.expect)(chainReference).toEqual(constants_1.CHAIN_REFERENCE.EthereumMainnet);
+        });
+    });
+});
+(0, vitest_1.describe)('isChainId', () => {
+    (0, vitest_1.it)('throws on eip155 without a network reference', () => {
+        (0, vitest_1.expect)(() => (0, typeGuards_1.assertIsChainId)('eip155')).toThrow();
+    });
+    (0, vitest_1.it)('validates eip155:1 mainnet as true', () => {
+        (0, vitest_1.expect)((0, typeGuards_1.isChainId)('eip155:1')).toBe(true);
+    });
+    (0, vitest_1.it)('throws on eip155:2 unsupported network reference', () => {
+        (0, vitest_1.expect)(() => (0, typeGuards_1.assertIsChainId)('eip155:2')).toThrow();
+    });
+    (0, vitest_1.it)('validates bip122:000000000019d6689c085ae165831e93 mainnet as true', () => {
+        (0, vitest_1.expect)((0, typeGuards_1.isChainId)('bip122:000000000019d6689c085ae165831e93')).toBe(true);
+    });
+    (0, vitest_1.it)('throws on bip122 with the wrong network reference', () => {
+        (0, vitest_1.expect)(() => (0, typeGuards_1.assertIsChainId)('bip122:1')).toThrow();
+    });
+    (0, vitest_1.it)('throws on bip122', () => {
+        // missing network
+        (0, vitest_1.expect)(() => (0, typeGuards_1.assertIsChainId)('bip122')).toThrow();
+    });
+    (0, vitest_1.it)('throws on empty string', () => {
+        // missing network
+        (0, vitest_1.expect)(() => (0, typeGuards_1.assertIsChainId)('')).toThrow();
+    });
+    (0, vitest_1.it)('should return true for cosmos', () => {
+        (0, vitest_1.expect)((0, typeGuards_1.isChainId)('cosmos:cosmoshub-4')).toBe(true);
+    });
+    (0, vitest_1.it)('should throw for an unknown cosmos chain', () => {
+        (0, vitest_1.expect)(() => (0, typeGuards_1.assertIsChainId)('cosmos:fakechain-1')).toThrow('assertIsChainId: unsupported ChainId: cosmos:fakechain-1');
+    });
+});

package/dist/{constants.d.ts → cjs/constants.d.ts}

@@ -32,6 +32,7 @@ export declare const foxWifHatAssetId: AssetId;
 export declare const cosmosAssetId: AssetId;
 export declare const thorchainAssetId: AssetId;
 export declare const tcyAssetId: AssetId;
+export declare const rujiAssetId: AssetId;
 export declare const mayachainAssetId: AssetId;
 export declare const binanceAssetId: AssetId;
 export declare const btcChainId: ChainId;
@@ -89,7 +90,6 @@ export declare const ASSET_NAMESPACE: {
     readonly bep721: "bep721";
     readonly bep1155: "bep1155";
     readonly slip44: "slip44";
-    readonly ibc: "ibc";
     readonly splToken: "token";
 };
 export declare const ASSET_REFERENCE: {

package/dist/cjs/constants.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.thorchainChainId = exports.cosmosChainId = exports.baseChainId = exports.arbitrumNovaChainId = exports.arbitrumChainId = exports.gnosisChainId = exports.polygonChainId = exports.bscChainId = exports.optimismChainId = exports.avalancheChainId = exports.ethChainId = exports.ltcChainId = exports.dogeChainId = exports.bchChainId = exports.btcChainId = exports.binanceAssetId = exports.mayachainAssetId = exports.rujiAssetId = exports.tcyAssetId = exports.thorchainAssetId = exports.cosmosAssetId = exports.foxWifHatAssetId = exports.flipAssetId = exports.usdcOnSolanaAssetId = exports.usdcOnArbitrumOneAssetId = exports.usdcAssetId = exports.usdtAssetId = exports.foxOnPolygonAssetId = exports.foxOnOptimismAssetId = exports.foxAssetId = exports.foxOnArbitrumOneAssetId = exports.foxOnGnosisAssetId = exports.foxyAssetId = exports.foxatarAssetId = exports.uniV2EthFoxArbitrumAssetId = exports.wrappedSolAssetId = exports.solAssetId = exports.baseAssetId = exports.arbitrumNovaAssetId = exports.arbitrumAssetId = exports.gnosisAssetId = exports.polygonAssetId = exports.bscAssetId = exports.optimismAssetId = exports.avalancheAssetId = exports.ethAssetId = exports.ltcAssetId = exports.dogeAssetId = exports.bchAssetId = exports.btcAssetId = void 0;
+exports.FEE_ASSET_IDS = exports.VALID_ASSET_NAMESPACE = exports.VALID_CHAIN_IDS = exports.ASSET_REFERENCE = exports.ASSET_NAMESPACE = exports.CHAIN_REFERENCE = exports.CHAIN_NAMESPACE = exports.solanaChainId = exports.binanceChainId = exports.mayachainChainId = void 0;
+exports.btcAssetId = 'bip122:000000000019d6689c085ae165831e93/slip44:0';
+exports.bchAssetId = 'bip122:000000000000000000651ef99cb9fcbe/slip44:145';
+exports.dogeAssetId = 'bip122:00000000001a91e3dace36e2be3bf030/slip44:3';
+exports.ltcAssetId = 'bip122:12a765e31ffd4059bada1e25190f6e98/slip44:2';
+exports.ethAssetId = 'eip155:1/slip44:60';
+exports.avalancheAssetId = 'eip155:43114/slip44:60';
+exports.optimismAssetId = 'eip155:10/slip44:60';
+exports.bscAssetId = 'eip155:56/slip44:60';
+exports.polygonAssetId = 'eip155:137/slip44:60';
+exports.gnosisAssetId = 'eip155:100/slip44:60';
+exports.arbitrumAssetId = 'eip155:42161/slip44:60';
+exports.arbitrumNovaAssetId = 'eip155:42170/slip44:60';
+exports.baseAssetId = 'eip155:8453/slip44:60';
+exports.solAssetId = 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501';
+exports.wrappedSolAssetId = 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:So11111111111111111111111111111111111111112';
+exports.uniV2EthFoxArbitrumAssetId = 'eip155:42161/erc20:0x5f6ce0ca13b87bd738519545d3e018e70e339c24';
+exports.foxatarAssetId = 'eip155:137/erc721:0x2e727c425a11ce6b8819b3004db332c12d2af2a2';
+exports.foxyAssetId = 'eip155:1/erc20:0xdc49108ce5c57bc3408c3a5e95f3d864ec386ed3';
+exports.foxOnGnosisAssetId = 'eip155:100/erc20:0x21a42669643f45bc0e086b8fc2ed70c23d67509d';
+exports.foxOnArbitrumOneAssetId = 'eip155:42161/erc20:0xf929de51d91c77e42f5090069e0ad7a09e513c73';
+exports.foxAssetId = 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d';
+exports.foxOnOptimismAssetId = 'eip155:10/erc20:0xf1a0da3367bc7aa04f8d94ba57b862ff37ced174';
+exports.foxOnPolygonAssetId = 'eip155:137/erc20:0x65a05db8322701724c197af82c9cae41195b0aa8';
+exports.usdtAssetId = 'eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7';
+exports.usdcAssetId = 'eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48';
+exports.usdcOnArbitrumOneAssetId = 'eip155:42161/erc20:0xaf88d065e77c8cc2239327c5edb3a432268e5831';
+exports.usdcOnSolanaAssetId = 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v';
+exports.flipAssetId = 'eip155:1/erc20:0x826180541412d574cf1336d22c0c0a287822678a';
+exports.foxWifHatAssetId = 'eip155:8453/erc20:0xd14acd73ade7f3c652f05365115f015e905a6bf4';
+exports.cosmosAssetId = 'cosmos:cosmoshub-4/slip44:118';
+exports.thorchainAssetId = 'cosmos:thorchain-1/slip44:931';
+exports.tcyAssetId = 'cosmos:thorchain-1/slip44:tcy';
+exports.rujiAssetId = 'cosmos:thorchain-1/slip44:ruji';
+exports.mayachainAssetId = 'cosmos:mayachain-mainnet-v1/slip44:931';
+exports.binanceAssetId = 'cosmos:binance-chain-tigris/slip44:714';
+exports.btcChainId = 'bip122:000000000019d6689c085ae165831e93';
+exports.bchChainId = 'bip122:000000000000000000651ef99cb9fcbe';
+exports.dogeChainId = 'bip122:00000000001a91e3dace36e2be3bf030';
+exports.ltcChainId = 'bip122:12a765e31ffd4059bada1e25190f6e98';
+exports.ethChainId = 'eip155:1';
+exports.avalancheChainId = 'eip155:43114';
+exports.optimismChainId = 'eip155:10';
+exports.bscChainId = 'eip155:56';
+exports.polygonChainId = 'eip155:137';
+exports.gnosisChainId = 'eip155:100';
+exports.arbitrumChainId = 'eip155:42161';
+exports.arbitrumNovaChainId = 'eip155:42170';
+exports.baseChainId = 'eip155:8453';
+exports.cosmosChainId = 'cosmos:cosmoshub-4';
+exports.thorchainChainId = 'cosmos:thorchain-1';
+exports.mayachainChainId = 'cosmos:mayachain-mainnet-v1';
+exports.binanceChainId = 'cosmos:binance-chain-tigris';
+exports.solanaChainId = 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp';
+exports.CHAIN_NAMESPACE = {
+    Evm: 'eip155',
+    Utxo: 'bip122',
+    CosmosSdk: 'cosmos',
+    Solana: 'solana',
+};
+exports.CHAIN_REFERENCE = {
+    EthereumMainnet: '1',
+    BitcoinMainnet: '000000000019d6689c085ae165831e93',
+    BitcoinCashMainnet: '000000000000000000651ef99cb9fcbe',
+    DogecoinMainnet: '00000000001a91e3dace36e2be3bf030',
+    LitecoinMainnet: '12a765e31ffd4059bada1e25190f6e98',
+    CosmosHubMainnet: 'cosmoshub-4',
+    ThorchainMainnet: 'thorchain-1',
+    MayachainMainnet: 'mayachain-mainnet-v1',
+    BinanceMainnet: 'binance-chain-tigris',
+    AvalancheCChain: '43114',
+    OptimismMainnet: '10',
+    BnbSmartChainMainnet: '56',
+    PolygonMainnet: '137',
+    GnosisMainnet: '100',
+    ArbitrumMainnet: '42161',
+    ArbitrumNovaMainnet: '42170',
+    BaseMainnet: '8453',
+    SolanaMainnet: '5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp', // https://namespaces.chainagnostic.org/solana/caip2
+};
+exports.ASSET_NAMESPACE = {
+    erc20: 'erc20',
+    erc721: 'erc721',
+    erc1155: 'erc1155',
+    bep20: 'bep20',
+    bep721: 'bep721',
+    bep1155: 'bep1155',
+    slip44: 'slip44',
+    splToken: 'token',
+};
+exports.ASSET_REFERENCE = {
+    Bitcoin: '0',
+    BitcoinCash: '145',
+    Litecoin: '2',
+    Dogecoin: '3',
+    Cosmos: '118',
+    Thorchain: '931',
+    Mayachain: '931',
+    Binance: '714',
+    Ethereum: '60',
+    AvalancheC: '60',
+    Optimism: '60',
+    BnbSmartChain: '60',
+    Polygon: '60',
+    Gnosis: '60',
+    Arbitrum: '60',
+    ArbitrumNova: '60',
+    Base: '60',
+    Solana: '501',
+};
+exports.VALID_CHAIN_IDS = Object.freeze({
+    [exports.CHAIN_NAMESPACE.Utxo]: [
+        exports.CHAIN_REFERENCE.BitcoinMainnet,
+        exports.CHAIN_REFERENCE.BitcoinCashMainnet,
+        exports.CHAIN_REFERENCE.DogecoinMainnet,
+        exports.CHAIN_REFERENCE.LitecoinMainnet,
+    ],
+    [exports.CHAIN_NAMESPACE.Evm]: [
+        exports.CHAIN_REFERENCE.EthereumMainnet,
+        exports.CHAIN_REFERENCE.AvalancheCChain,
+        exports.CHAIN_REFERENCE.OptimismMainnet,
+        exports.CHAIN_REFERENCE.BnbSmartChainMainnet,
+        exports.CHAIN_REFERENCE.PolygonMainnet,
+        exports.CHAIN_REFERENCE.GnosisMainnet,
+        exports.CHAIN_REFERENCE.ArbitrumMainnet,
+        exports.CHAIN_REFERENCE.ArbitrumNovaMainnet,
+        exports.CHAIN_REFERENCE.BaseMainnet,
+    ],
+    [exports.CHAIN_NAMESPACE.CosmosSdk]: [
+        exports.CHAIN_REFERENCE.CosmosHubMainnet,
+        exports.CHAIN_REFERENCE.ThorchainMainnet,
+        exports.CHAIN_REFERENCE.MayachainMainnet,
+        exports.CHAIN_REFERENCE.BinanceMainnet,
+    ],
+    [exports.CHAIN_NAMESPACE.Solana]: [exports.CHAIN_REFERENCE.SolanaMainnet],
+});
+exports.VALID_ASSET_NAMESPACE = Object.freeze({
+    [exports.CHAIN_NAMESPACE.Utxo]: [exports.ASSET_NAMESPACE.slip44],
+    [exports.CHAIN_NAMESPACE.Evm]: [
+        exports.ASSET_NAMESPACE.slip44,
+        exports.ASSET_NAMESPACE.erc20,
+        exports.ASSET_NAMESPACE.erc721,
+        exports.ASSET_NAMESPACE.erc1155,
+        exports.ASSET_NAMESPACE.bep20,
+        exports.ASSET_NAMESPACE.bep721,
+        exports.ASSET_NAMESPACE.bep1155,
+    ],
+    [exports.CHAIN_NAMESPACE.CosmosSdk]: [exports.ASSET_NAMESPACE.slip44],
+    [exports.CHAIN_NAMESPACE.Solana]: [exports.ASSET_NAMESPACE.splToken, exports.ASSET_NAMESPACE.slip44],
+});
+// We should prob change this once we add more chains
+exports.FEE_ASSET_IDS = [
+    exports.ethAssetId,
+    exports.btcAssetId,
+    exports.bchAssetId,
+    exports.cosmosAssetId,
+    exports.thorchainAssetId,
+    exports.mayachainAssetId,
+    exports.dogeAssetId,
+    exports.ltcAssetId,
+    exports.avalancheAssetId,
+    exports.optimismAssetId,
+    exports.bscAssetId,
+    exports.polygonAssetId,
+    exports.gnosisAssetId,
+    exports.arbitrumAssetId,
+    exports.arbitrumNovaAssetId,
+    exports.baseAssetId,
+    exports.solAssetId,
+];