@shapeshiftoss/caip 2.5.2 → 3.1.0

package/README.md

@@ -3,13 +3,13 @@
 This package is ShapeShift's partial implementation of [CAIPs](https://github.com/ChainAgnostic/CAIPs) - Chain Agnostic Improvement Protocols.
 It is not exhaustive and is currently only used internally.
 
-## ChainId - Blockchain ID Specification
+## ChainId (CAIP2) - Blockchain ID Specification
 
 https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md
 
 Usage
 
-### `toChainId`
+### `toChainId` | `toCAIP2`
 
 ```ts
 const chain = ChainTypes.Ethereum
@@ -18,7 +18,7 @@ const result = toChainId({ chain, network })
 expect(result).toEqual('eip155:1')
 ```
 
-### `fromChainId`
+### `fromChainId` | `fromCAIP2`
 
 ```ts
 const ethChainId = 'eip155:1'
@@ -27,13 +27,37 @@ expect(chain).toEqual(ChainTypes.Ethereum)
 expect(network).toEqual(NetworkTypes.MAINNET)
 ```
 
-## AssetId - Asset Type and Asset ID Specification
+## AccountId (CAIP10) - Blockchain ID Specification
+
+https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-10.md
+
+Usage
+
+### `toAccountId` | `toCAIP10`
+
+```ts
+const chainId = 'eip155:1'
+const account = '0xA44C286BA83Bb771cd0107B2c1Df678435Bd1535'
+const result = (toAccountId({ chainId, account }))
+expect(result).toEqual('eip155:1:0xa44c286ba83bb771cd0107b2c1df678435bd1535')
+```
+
+### `fromAccountId` | `fromCAIP10`
+
+```ts
+const accountId = 'eip155:1:0xa44c286ba83bb771cd0107b2c1df678435bd1535'
+const { chainId, account } = fromAccountId(accountId)
+expect(chainId).toEqual('eip155:1')
+expect(account).toEqual('0xa44c286ba83bb771cd0107b2c1df678435bd1535')
+```
+
+## AssetId (CAIP19) - Asset Type and Asset ID Specification
 
 https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-19.md
 
 Usage
 
-### `toAssetId`
+### `toAssetId` | `toCAIP19`
 
 Ether
 
@@ -57,7 +81,7 @@ const result = toAssetId({ chain, network, contractType, tokenId })
 expect(result).toEqual('eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d')
 ```
 
-### `fromAssetId`
+### `fromAssetId` | `fromCAIP19`
 
 Ether
 

package/dist/accountId/accountId.d.ts

@@ -12,4 +12,6 @@ declare type FromAccountIdReturn = {
 };
 declare type FromAccountId = (accountId: string) => FromAccountIdReturn;
 export declare const fromAccountId: FromAccountId;
+export declare const toCAIP10: ToAccountId;
+export declare const fromCAIP10: FromAccountId;
 export {};

package/dist/accountId/accountId.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromAccountId = exports.toAccountId = void 0;
+exports.fromCAIP10 = exports.toCAIP10 = exports.fromAccountId = exports.toAccountId = void 0;
 const chainId_1 = require("../chainId/chainId");
 const toAccountId = ({ chainId, account }) => {
     if (!(0, chainId_1.isChainId)(chainId)) {
@@ -38,3 +38,5 @@ const fromAccountId = (accountId) => {
     return { chainId, account: outputAccount };
 };
 exports.fromAccountId = fromAccountId;
+exports.toCAIP10 = exports.toAccountId;
+exports.fromCAIP10 = exports.fromAccountId;

package/dist/assetId/assetId.d.ts

@@ -30,5 +30,8 @@ declare type FromAssetIdReturn = {
     assetNamespace: AssetNamespace;
     assetReference: AssetReference | string;
 };
-export declare const fromAssetId: (assetId: string) => FromAssetIdReturn;
+export declare type FromAssetId = (assetId: AssetId) => FromAssetIdReturn;
+export declare const fromAssetId: FromAssetId;
+export declare const toCAIP19: ToAssetId;
+export declare const fromCAIP19: FromAssetId;
 export {};

package/dist/assetId/assetId.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromAssetId = exports.toAssetId = exports.AssetReference = exports.AssetNamespace = void 0;
+exports.fromCAIP19 = exports.toCAIP19 = exports.fromAssetId = exports.toAssetId = exports.AssetReference = exports.AssetNamespace = void 0;
 // https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-19.md
 const types_1 = require("@shapeshiftoss/types");
 const chainId_1 = require("../chainId/chainId");
@@ -113,3 +113,5 @@ const fromAssetId = (assetId) => {
     throw new Error(`fromAssetId: invalid AssetId: ${assetId}`);
 };
 exports.fromAssetId = fromAssetId;
+exports.toCAIP19 = exports.toAssetId;
+exports.fromCAIP19 = exports.fromAssetId;

package/dist/chainId/chainId.d.ts

@@ -32,4 +32,6 @@ export declare const isChainId: IsChainId;
 export declare const chainReferenceToNetworkType: Record<ChainReference, NetworkTypes>;
 export declare const networkTypeToChainReference: Record<NetworkTypes, ChainReference>;
 export declare const chainNamespaceToChainType: Record<ChainNamespace, ChainTypes>;
+export declare const toCAIP2: (args: ToChainIdArgs) => string;
+export declare const fromCAIP2: FromChainId;
 export {};

package/dist/chainId/chainId.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chainNamespaceToChainType = exports.networkTypeToChainReference = exports.chainReferenceToNetworkType = exports.isChainId = exports.fromChainId = exports.toChainId = exports.ChainReference = exports.ChainNamespace = void 0;
+exports.fromCAIP2 = exports.toCAIP2 = exports.chainNamespaceToChainType = exports.networkTypeToChainReference = exports.chainReferenceToNetworkType = exports.isChainId = exports.fromChainId = exports.toChainId = exports.ChainReference = exports.ChainNamespace = void 0;
 const types_1 = require("@shapeshiftoss/types");
 const invert_1 = __importDefault(require("lodash/invert"));
 var ChainNamespace;
@@ -231,3 +231,5 @@ exports.chainNamespaceToChainType = Object.freeze({
     [ChainNamespace.Ethereum]: types_1.ChainTypes.Ethereum,
     [ChainNamespace.Cosmos]: types_1.ChainTypes.Cosmos
 });
+exports.toCAIP2 = exports.toChainId;
+exports.fromCAIP2 = exports.fromChainId;

package/package.json

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