@polymeshassociation/polymesh-sdk 24.1.0 → 24.2.0

package/CHANGELOG.md

@@ -1,16 +1,6 @@
-# [24.1.0](https://github.com/PolymeshAssociation/polymesh-sdk/compare/v24.0.1...v24.1.0) (2024-04-16)
-
-
-### Bug Fixes
-
-* 🐛 Remove future block constraint on `endAfterBlock` ([43878e0](https://github.com/PolymeshAssociation/polymesh-sdk/commit/43878e050ba29217841425a1134c875a85c5afc8))
+# [24.2.0](https://github.com/PolymeshAssociation/polymesh-sdk/compare/v24.1.0...v24.2.0) (2024-04-24)
 
 
 ### Features
 
-* 🎸 Add asset holders namespace for NFT collections ([de9b6d9](https://github.com/PolymeshAssociation/polymesh-sdk/commit/de9b6d9a031bfbfc12bbf4ae5797b3f4a9a3fda2))
-* 🎸 add getTransactionHistory to NFT Collection ([468493e](https://github.com/PolymeshAssociation/polymesh-sdk/commit/468493ee733a037ea42a174678640e1c97138a78))
-* 🎸 add network.supportConfidentialAssets method ([f3a60dc](https://github.com/PolymeshAssociation/polymesh-sdk/commit/f3a60dc63366fc6b97d75e5d9d546fc1db84128f))
-* 🎸 allow connection to polymesh private networks ([a2a68cd](https://github.com/PolymeshAssociation/polymesh-sdk/commit/a2a68cd84e946b4569cd4ae5c0ba37a0a3646f89))
-* 🎸 allow funding round to be specified during nft create ([4bf745f](https://github.com/PolymeshAssociation/polymesh-sdk/commit/4bf745f509695781abb6ff05621ee8785914e962))
-* 🎸 Identities:rotatePrimaryKeyToSecondary ([cdd3f1d](https://github.com/PolymeshAssociation/polymesh-sdk/commit/cdd3f1d38ee9bd2737b9882c3115a4cc142ce27a))
+* 🎸 Refactor types into module specific files ([f7e7e73](https://github.com/PolymeshAssociation/polymesh-sdk/commit/f7e7e738c22d778139116389e08a206bcaa8a198))

package/api/client/Identities.d.ts

@@ -1,5 +1,5 @@
-import { AllowIdentityToCreatePortfoliosParams, AuthorizationRequest, ChildIdentity, Context, Identity, NumberedPortfolio, RevokeIdentityToCreatePortfoliosParams } from "../../internal";
-import { AttestPrimaryKeyRotationParams, CreateChildIdentityParams, ProcedureMethod, RegisterIdentityParams, RotatePrimaryKeyParams, RotatePrimaryKeyToSecondaryParams } from "../../types";
+import { AuthorizationRequest, ChildIdentity, Context, Identity, NumberedPortfolio } from "../../internal";
+import { AllowIdentityToCreatePortfoliosParams, AttestPrimaryKeyRotationParams, CreateChildIdentityParams, ProcedureMethod, RegisterIdentityParams, RevokeIdentityToCreatePortfoliosParams, RotatePrimaryKeyParams, RotatePrimaryKeyToSecondaryParams } from "../../types";
 /**
  * Handles all Identity related functionality
  */

package/api/client/Identities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Identities.d.ts","sourceRoot":"","sources":["../../../src/api/client/Identities.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,qCAAqC,EAErC,oBAAoB,EACpB,aAAa,EACb,OAAO,EAGP,QAAQ,EACR,iBAAiB,EAGjB,sCAAsC,EAGvC,uBAAmB;AACpB,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,EACzB,eAAe,EACf,sBAAsB,EACtB,sBAAsB,EACtB,iCAAiC,EAClC,oBAAgB;AAIjB;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAU;IAEzB;;OAEG;gBACS,OAAO,EAAE,OAAO;IAgE5B;;;;;;;;;;OAUG;IACI,gBAAgB,EAAE,eAAe,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;IAE3E;;;;;;;;;;OAUG;IACI,wBAAwB,EAAE,eAAe,CAC9C,8BAA8B,EAC9B,oBAAoB,CACrB,CAAC;IAEF;;;;;;OAMG;IACI,gBAAgB,EAAE,eAAe,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;IAEvF;;;;;;;;;;OAUG;IACI,2BAA2B,EAAE,eAAe,CACjD,iCAAiC,EACjC,oBAAoB,CACrB,CAAC;IAEF;;;OAGG;IACI,eAAe,EAAE,eAAe,CACrC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EACnC,iBAAiB,EAAE,EACnB,iBAAiB,CAClB,CAAC;IAEF;;;OAGG;IACI,gBAAgB,EAAE,eAAe,CACtC;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EACtC,iBAAiB,EAAE,CACpB,CAAC;IAEF;;;;OAIG;IACI,WAAW,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5D;;;;OAIG;IACI,gBAAgB,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAItE;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/E;;;;;;;;;;OAUG;IACI,WAAW,EAAE,eAAe,CAAC,yBAAyB,EAAE,aAAa,CAAC,CAAC;IAE9E;;;;;;OAMG;IACI,+BAA+B,EAAE,eAAe,CACrD,qCAAqC,EACrC,IAAI,CACL,CAAC;IAEF;;;;;;OAMG;IACI,gCAAgC,EAAE,eAAe,CACtD,sCAAsC,EACtC,IAAI,CACL,CAAC;IAEF;;;;OAIG;IACU,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB7E"}
+{"version":3,"file":"Identities.d.ts","sourceRoot":"","sources":["../../../src/api/client/Identities.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,oBAAoB,EACpB,aAAa,EACb,OAAO,EAGP,QAAQ,EACR,iBAAiB,EAKlB,uBAAmB;AACpB,OAAO,EACL,qCAAqC,EACrC,8BAA8B,EAC9B,yBAAyB,EACzB,eAAe,EACf,sBAAsB,EACtB,sCAAsC,EACtC,sBAAsB,EACtB,iCAAiC,EAClC,oBAAgB;AAIjB;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAU;IAEzB;;OAEG;gBACS,OAAO,EAAE,OAAO;IAgE5B;;;;;;;;;;OAUG;IACI,gBAAgB,EAAE,eAAe,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;IAE3E;;;;;;;;;;OAUG;IACI,wBAAwB,EAAE,eAAe,CAC9C,8BAA8B,EAC9B,oBAAoB,CACrB,CAAC;IAEF;;;;;;OAMG;IACI,gBAAgB,EAAE,eAAe,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;IAEvF;;;;;;;;;;OAUG;IACI,2BAA2B,EAAE,eAAe,CACjD,iCAAiC,EACjC,oBAAoB,CACrB,CAAC;IAEF;;;OAGG;IACI,eAAe,EAAE,eAAe,CACrC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EACnC,iBAAiB,EAAE,EACnB,iBAAiB,CAClB,CAAC;IAEF;;;OAGG;IACI,gBAAgB,EAAE,eAAe,CACtC;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EACtC,iBAAiB,EAAE,CACpB,CAAC;IAEF;;;;OAIG;IACI,WAAW,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5D;;;;OAIG;IACI,gBAAgB,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAItE;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/E;;;;;;;;;;OAUG;IACI,WAAW,EAAE,eAAe,CAAC,yBAAyB,EAAE,aAAa,CAAC,CAAC;IAE9E;;;;;;OAMG;IACI,+BAA+B,EAAE,eAAe,CACrD,qCAAqC,EACrC,IAAI,CACL,CAAC;IAEF;;;;;;OAMG;IACI,gCAAgC,EAAE,eAAe,CACtD,sCAAsC,EACtC,IAAI,CACL,CAAC;IAEF;;;;OAIG;IACU,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB7E"}

package/api/client/Identities.js.map

@@ -1 +1 @@
-{"version":3,"file":"Identities.js","sourceRoot":"","sources":["../../../src/api/client/Identities.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAClE,6CAgBoB;AASpB,uDAAwD;AACxD,mDAA2F;AAE3F;;GAEG;AACH,MAAa,UAAU;IAGrB;;OAEG;IACH,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,2BAAgB,EAAE,IAAI,CAAC,EAAE,EACzD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,wBAAwB,GAAG,IAAA,gCAAqB,EACnD,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,mCAAwB,EAAE,IAAI,CAAC,EAAE,EACjE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,2BAAgB,EAAE,IAAI,CAAC,EAAE,EACzD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,2BAA2B,GAAG,IAAA,gCAAqB,EACtD,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,sCAA2B,EAAE,IAAI,CAAC,EAAE,EACpE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,eAAe,GAAG,IAAA,gCAAqB,EAC1C;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,2BAAgB;gBAChB;oBACE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;iBAC3D;aACF;YACD,WAAW,EAAE,kCAA0B;SACxC,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,2BAAgB;gBAChB,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE;aAC5E;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAA,gCAAqB,EACtC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,8BAAmB,EAAE,IAAI,CAAC;SACzD,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,+BAA+B,GAAG,IAAA,gCAAqB,EAC1D,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,0CAA+B,EAAE,IAAI,CAAC,EAAE,EACxE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gCAAgC,GAAG,IAAA,gCAAqB,EAC3D,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,2CAAgC,EAAE,IAAI,CAAC,EAAE,EACzE,OAAO,CACR,CAAC;IACJ,CAAC;IA2ED;;;;OAIG;IACI,WAAW,CAAC,IAAqB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAAqB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAqC;QAC1D,OAAO,IAAA,qBAAU,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1D,CAAC;IAuCD;;;;OAIG;IACU,oBAAoB,CAAC,GAAsB;;YACtD,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,MAAM,QAAQ,GAAG,IAAA,qBAAU,EAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/C,MAAM,IAAA,+BAAoB,EAAC,QAAQ,CAAC,CAAC;YAErC,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEnF,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE;gBACrC,MAAM,EACJ,IAAI,EAAE,CAAC,EAAE,mBAAmB,CAAC,GAC9B,GAAG,UAAU,CAAC;gBAEf,OAAO,IAAA,+BAAkB,EAAC,mBAAmB,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAvOD,gCAuOC"}
+{"version":3,"file":"Identities.js","sourceRoot":"","sources":["../../../src/api/client/Identities.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAClE,6CAcoB;AAWpB,uDAAwD;AACxD,mDAA2F;AAE3F;;GAEG;AACH,MAAa,UAAU;IAGrB;;OAEG;IACH,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,2BAAgB,EAAE,IAAI,CAAC,EAAE,EACzD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,wBAAwB,GAAG,IAAA,gCAAqB,EACnD,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,mCAAwB,EAAE,IAAI,CAAC,EAAE,EACjE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,2BAAgB,EAAE,IAAI,CAAC,EAAE,EACzD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,2BAA2B,GAAG,IAAA,gCAAqB,EACtD,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,sCAA2B,EAAE,IAAI,CAAC,EAAE,EACpE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,eAAe,GAAG,IAAA,gCAAqB,EAC1C;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,2BAAgB;gBAChB;oBACE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;iBAC3D;aACF;YACD,WAAW,EAAE,kCAA0B;SACxC,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,2BAAgB;gBAChB,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE;aAC5E;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAA,gCAAqB,EACtC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,8BAAmB,EAAE,IAAI,CAAC;SACzD,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,+BAA+B,GAAG,IAAA,gCAAqB,EAC1D,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,0CAA+B,EAAE,IAAI,CAAC,EAAE,EACxE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gCAAgC,GAAG,IAAA,gCAAqB,EAC3D,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,2CAAgC,EAAE,IAAI,CAAC,EAAE,EACzE,OAAO,CACR,CAAC;IACJ,CAAC;IA2ED;;;;OAIG;IACI,WAAW,CAAC,IAAqB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAAqB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAqC;QAC1D,OAAO,IAAA,qBAAU,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1D,CAAC;IAuCD;;;;OAIG;IACU,oBAAoB,CAAC,GAAsB;;YACtD,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,MAAM,QAAQ,GAAG,IAAA,qBAAU,EAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/C,MAAM,IAAA,+BAAoB,EAAC,QAAQ,CAAC,CAAC;YAErC,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEnF,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE;gBACrC,MAAM,EACJ,IAAI,EAAE,CAAC,EAAE,mBAAmB,CAAC,GAC9B,GAAG,UAAU,CAAC;gBAEf,OAAO,IAAA,+BAAkB,EAAC,mBAAmB,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAvOD,gCAuOC"}

package/api/client/types.d.ts

@@ -0,0 +1,192 @@
+import { ApiOptions } from '@polkadot/api/types';
+import BigNumber from 'bignumber.js';
+import { TxTag } from "../../types";
+export interface ExtrinsicData {
+    blockHash: string;
+    blockNumber: BigNumber;
+    blockDate: Date;
+    extrinsicIdx: BigNumber;
+    /**
+     * public key of the signer. Unsigned transactions have no signer, in which case this value is null (example: an enacted governance proposal)
+     */
+    address: string | null;
+    /**
+     * nonce of the transaction. Null for unsigned transactions where address is null
+     */
+    nonce: BigNumber | null;
+    txTag: TxTag;
+    params: Record<string, unknown>[];
+    success: boolean;
+    specVersionId: BigNumber;
+    extrinsicHash: string;
+}
+export interface ExtrinsicDataWithFees extends ExtrinsicData {
+    fee: Fees;
+}
+export interface ProtocolFees {
+    tag: TxTag;
+    fees: BigNumber;
+}
+export interface MiddlewareMetadata {
+    chain: string;
+    genesisHash: string;
+    indexerHealthy: boolean;
+    lastProcessedHeight: BigNumber;
+    lastProcessedTimestamp: Date;
+    specName: string;
+    targetHeight: BigNumber;
+}
+export interface SubmissionDetails {
+    blockHash: string;
+    transactionIndex: BigNumber;
+    transactionHash: string;
+}
+/**
+ * Specifies possible types of errors in the SDK
+ */
+export declare enum ErrorCode {
+    /**
+     * transaction removed from the tx pool
+     */
+    TransactionAborted = "TransactionAborted",
+    /**
+     * user rejected the transaction in their wallet
+     */
+    TransactionRejectedByUser = "TransactionRejectedByUser",
+    /**
+     * transaction failed due to an on-chain error. This is a business logic error,
+     *   and it should be caught by the SDK before being sent to the chain.
+     *   Please report it to the Polymesh team
+     */
+    TransactionReverted = "TransactionReverted",
+    /**
+     * error that should cause termination of the calling application
+     */
+    FatalError = "FatalError",
+    /**
+     * user input error. This means that one or more inputs passed by the user
+     *   do not conform to expected value ranges or types
+     */
+    ValidationError = "ValidationError",
+    /**
+     * user does not have the required roles/permissions to perform an operation
+     */
+    NotAuthorized = "NotAuthorized",
+    /**
+     * errors encountered when interacting with the historic data middleware (GQL server)
+     */
+    MiddlewareError = "MiddlewareError",
+    /**
+     * the data that is being fetched does not exist on-chain, or relies on non-existent data. There are
+     *   some cases where the data did exist at some point, but has been deleted to save storage space
+     */
+    DataUnavailable = "DataUnavailable",
+    /**
+     * the data that is being written to the chain is the same data that is already in place. This would result
+     *   in a redundant/useless transaction being executed
+     */
+    NoDataChange = "NoDataChange",
+    /**
+     * the data that is being written to the chain would result in some limit being exceeded. For example, adding a transfer
+     *   restriction when the maximum possible amount has already been added
+     */
+    LimitExceeded = "LimitExceeded",
+    /**
+     * one or more base prerequisites for a transaction to be successful haven't been met. For example, reserving a ticker requires
+     *   said ticker to not be already reserved. Attempting to reserve a ticker without that prerequisite being met would result in this
+     *   type of error. Attempting to create an entity that already exists would also fall into this category,
+     *   if the entity in question is supposed to be unique
+     */
+    UnmetPrerequisite = "UnmetPrerequisite",
+    /**
+     * this type of error is thrown when attempting to delete/modify an entity which has other entities depending on it. For example, deleting
+     *   a Portfolio that still holds assets, or removing a Checkpoint Schedule that is being referenced by a Corporate Action
+     */
+    EntityInUse = "EntityInUse",
+    /**
+     * one or more parties involved in the transaction do not have enough balance to perform it
+     */
+    InsufficientBalance = "InsufficientBalance",
+    /**
+     * errors that are the result of something unforeseen.
+     *   These should generally be reported to the Polymesh team
+     */
+    UnexpectedError = "UnexpectedError",
+    /**
+     * general purpose errors that don't fit well into the other categories
+     */
+    General = "General"
+}
+export interface MiddlewareConfig {
+    link: string;
+    key: string;
+}
+export interface PolkadotConfig {
+    /**
+     * provide a locally saved metadata file for a modestly fast startup time (e.g. 1 second when provided, 1.5 seconds without).
+     *
+     * @note if not provided the SDK will read the needed data from chain during startup
+     *
+     * @note format is key as genesis hash and spec version and the value hex encoded chain metadata
+     *
+     * @example creating valid metadata
+     * ```ts
+     const meta = _polkadotApi.runtimeMetadata.toHex();
+     const genesisHash = _polkadotApi.genesisHash;
+     const specVersion = _polkadotApi.runtimeVersion.specVersion;
+  
+    const metadata = {
+      [`${genesisHash}-${specVersion}`]: meta,
+    };
+    ```
+     */
+    metadata?: ApiOptions['metadata'];
+    /**
+     * set to `true` to disable polkadot start up warnings
+     */
+    noInitWarn?: boolean;
+    /**
+     * allows for types to be provided for multiple chain specs at once
+     *
+     * @note shouldn't be needed for most use cases
+     */
+    typesBundle?: ApiOptions['typesBundle'];
+}
+export interface EventIdentifier {
+    blockNumber: BigNumber;
+    blockHash: string;
+    blockDate: Date;
+    eventIndex: BigNumber;
+}
+export interface NetworkProperties {
+    name: string;
+    version: BigNumber;
+}
+export interface Fees {
+    /**
+     * bonus fee charged by certain transactions
+     */
+    protocol: BigNumber;
+    /**
+     * regular network fee
+     */
+    gas: BigNumber;
+    /**
+     * sum of the protocol and gas fees
+     */
+    total: BigNumber;
+}
+/**
+ * CustomClaimType
+ */
+export declare type CustomClaimType = {
+    name: string;
+    id: BigNumber;
+};
+/**
+ * CustomClaimType with DID that registered the CustomClaimType
+ */
+export declare type CustomClaimTypeWithDid = CustomClaimType & {
+    did?: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/api/client/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/api/client/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,KAAK,EAAE,oBAAgB;AAEhC,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,SAAS,CAAC;IACvB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,SAAS,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,SAAS,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,GAAG,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,KAAK,CAAC;IACX,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,mBAAmB,EAAE,SAAS,CAAC;IAC/B,sBAAsB,EAAE,IAAI,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,SAAS;IACnB;;OAEG;IACH,kBAAkB,uBAAuB;IACzC;;OAEG;IACH,yBAAyB,8BAA8B;IACvD;;;;OAIG;IACH,mBAAmB,wBAAwB;IAC3C;;OAEG;IACH,UAAU,eAAe;IACzB;;;OAGG;IACH,eAAe,oBAAoB;IACnC;;OAEG;IACH,aAAa,kBAAkB;IAC/B;;OAEG;IACH,eAAe,oBAAoB;IACnC;;;OAGG;IACH,eAAe,oBAAoB;IACnC;;;OAGG;IACH,YAAY,iBAAiB;IAC7B;;;OAGG;IACH,aAAa,kBAAkB;IAC/B;;;;;OAKG;IACH,iBAAiB,sBAAsB;IACvC;;;OAGG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C;;;OAGG;IACH,eAAe,oBAAoB;IACnC;;OAEG;IACH,OAAO,YAAY;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,SAAS,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,GAAG,EAAE,SAAS,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;CAClB;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,SAAS,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG,eAAe,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/api/client/types.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorCode = void 0;
+/**
+ * Specifies possible types of errors in the SDK
+ */
+var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * transaction removed from the tx pool
+     */
+    ErrorCode["TransactionAborted"] = "TransactionAborted";
+    /**
+     * user rejected the transaction in their wallet
+     */
+    ErrorCode["TransactionRejectedByUser"] = "TransactionRejectedByUser";
+    /**
+     * transaction failed due to an on-chain error. This is a business logic error,
+     *   and it should be caught by the SDK before being sent to the chain.
+     *   Please report it to the Polymesh team
+     */
+    ErrorCode["TransactionReverted"] = "TransactionReverted";
+    /**
+     * error that should cause termination of the calling application
+     */
+    ErrorCode["FatalError"] = "FatalError";
+    /**
+     * user input error. This means that one or more inputs passed by the user
+     *   do not conform to expected value ranges or types
+     */
+    ErrorCode["ValidationError"] = "ValidationError";
+    /**
+     * user does not have the required roles/permissions to perform an operation
+     */
+    ErrorCode["NotAuthorized"] = "NotAuthorized";
+    /**
+     * errors encountered when interacting with the historic data middleware (GQL server)
+     */
+    ErrorCode["MiddlewareError"] = "MiddlewareError";
+    /**
+     * the data that is being fetched does not exist on-chain, or relies on non-existent data. There are
+     *   some cases where the data did exist at some point, but has been deleted to save storage space
+     */
+    ErrorCode["DataUnavailable"] = "DataUnavailable";
+    /**
+     * the data that is being written to the chain is the same data that is already in place. This would result
+     *   in a redundant/useless transaction being executed
+     */
+    ErrorCode["NoDataChange"] = "NoDataChange";
+    /**
+     * the data that is being written to the chain would result in some limit being exceeded. For example, adding a transfer
+     *   restriction when the maximum possible amount has already been added
+     */
+    ErrorCode["LimitExceeded"] = "LimitExceeded";
+    /**
+     * one or more base prerequisites for a transaction to be successful haven't been met. For example, reserving a ticker requires
+     *   said ticker to not be already reserved. Attempting to reserve a ticker without that prerequisite being met would result in this
+     *   type of error. Attempting to create an entity that already exists would also fall into this category,
+     *   if the entity in question is supposed to be unique
+     */
+    ErrorCode["UnmetPrerequisite"] = "UnmetPrerequisite";
+    /**
+     * this type of error is thrown when attempting to delete/modify an entity which has other entities depending on it. For example, deleting
+     *   a Portfolio that still holds assets, or removing a Checkpoint Schedule that is being referenced by a Corporate Action
+     */
+    ErrorCode["EntityInUse"] = "EntityInUse";
+    /**
+     * one or more parties involved in the transaction do not have enough balance to perform it
+     */
+    ErrorCode["InsufficientBalance"] = "InsufficientBalance";
+    /**
+     * errors that are the result of something unforeseen.
+     *   These should generally be reported to the Polymesh team
+     */
+    ErrorCode["UnexpectedError"] = "UnexpectedError";
+    /**
+     * general purpose errors that don't fit well into the other categories
+     */
+    ErrorCode["General"] = "General";
+})(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
+//# sourceMappingURL=types.js.map

package/api/client/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/api/client/types.ts"],"names":[],"mappings":";;;AAkDA;;GAEG;AACH,IAAY,SAwEX;AAxED,WAAY,SAAS;IACnB;;OAEG;IACH,sDAAyC,CAAA;IACzC;;OAEG;IACH,oEAAuD,CAAA;IACvD;;;;OAIG;IACH,wDAA2C,CAAA;IAC3C;;OAEG;IACH,sCAAyB,CAAA;IACzB;;;OAGG;IACH,gDAAmC,CAAA;IACnC;;OAEG;IACH,4CAA+B,CAAA;IAC/B;;OAEG;IACH,gDAAmC,CAAA;IACnC;;;OAGG;IACH,gDAAmC,CAAA;IACnC;;;OAGG;IACH,0CAA6B,CAAA;IAC7B;;;OAGG;IACH,4CAA+B,CAAA;IAC/B;;;;;OAKG;IACH,oDAAuC,CAAA;IACvC;;;OAGG;IACH,wCAA2B,CAAA;IAC3B;;OAEG;IACH,wDAA2C,CAAA;IAC3C;;;OAGG;IACH,gDAAmC,CAAA;IACnC;;OAEG;IACH,gCAAmB,CAAA;AACrB,CAAC,EAxEW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAwEpB"}

package/api/entities/Account/types.d.ts

@@ -1,11 +1,22 @@
 import BigNumber from 'bignumber.js';
 import { Account, Identity } from "../../../internal";
 import { BalanceTypeEnum, CallIdEnum, EventIdEnum, ModuleIdEnum } from "../../../middleware/types";
-import { EventIdentifier, Signer } from "../../../types";
-export interface MultiSigDetails {
-    signers: Signer[];
-    requiredSignatures: BigNumber;
+import { EventIdentifier } from "../../../types";
+export interface Balance {
+    /**
+     * balance available for transferring and paying fees
+     */
+    free: BigNumber;
+    /**
+     * unavailable balance, either bonded for staking or locked for some other purpose
+     */
+    locked: BigNumber;
+    /**
+     * free + locked
+     */
+    total: BigNumber;
 }
+export declare type AccountBalance = Balance;
 /**
  * Distinguishes MultiSig and Smart Contract accounts
  */

package/api/entities/Account/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Account/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,0BAAmB;AAC/C,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,kCAA2B;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,uBAAgB;AAClD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,kBAAkB,EAAE,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,MAAM,KAAK;IACX;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,aAAa,kBAAkB;CAChC;AAED;;GAEG;AACH,oBAAY,uBAAuB;IACjC;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC;CACnC;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,MAAM,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,eAAe,CAAC;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,SAAS,CAAC;IAEzB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,WAAW,CAAC;CACtB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Account/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,0BAAmB;AAC/C,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,kCAA2B;AAC5F,OAAO,EAAE,eAAe,EAAE,uBAAgB;AAE1C,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,oBAAY,cAAc,GAAG,OAAO,CAAC;AAErC;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,MAAM,KAAK;IACX;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,aAAa,kBAAkB;CAChC;AAED;;GAEG;AACH,oBAAY,uBAAuB;IACjC;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC;CACnC;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,MAAM,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,eAAe,CAAC;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,SAAS,CAAC;IAEzB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,WAAW,CAAC;CACtB"}

package/api/entities/Account/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/entities/Account/types.ts"],"names":[],"mappings":";;;AAUA;;GAEG;AACH,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,6BAAW,CAAA;IACX;;OAEG;IACH,uCAAqB,CAAA;IACrB;;OAEG;IACH,iDAA+B,CAAA;AACjC,CAAC,EAbW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAazB;AAED;;GAEG;AACH,IAAY,uBAiBX;AAjBD,WAAY,uBAAuB;IACjC;;OAEG;IACH,oDAAyB,CAAA;IACzB;;OAEG;IACH,8CAAmB,CAAA;IACnB;;OAEG;IACH,kDAAuB,CAAA;IACvB;;OAEG;IACH,4DAAiC,CAAA;AACnC,CAAC,EAjBW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAiBlC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/entities/Account/types.ts"],"names":[],"mappings":";;;AAuBA;;GAEG;AACH,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,6BAAW,CAAA;IACX;;OAEG;IACH,uCAAqB,CAAA;IACrB;;OAEG;IACH,iDAA+B,CAAA;AACjC,CAAC,EAbW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAazB;AAED;;GAEG;AACH,IAAY,uBAiBX;AAjBD,WAAY,uBAAuB;IACjC;;OAEG;IACH,oDAAyB,CAAA;IACzB;;OAEG;IACH,8CAAmB,CAAA;IACnB;;OAEG;IACH,kDAAuB,CAAA;IACvB;;OAEG;IACH,4DAAiC,CAAA;AACnC,CAAC,EAjBW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAiBlC"}

package/api/entities/Asset/types.d.ts

@@ -1,12 +1,56 @@
 import BigNumber from 'bignumber.js';
 import { CustomPermissionGroup, DefaultPortfolio, FungibleAsset, Identity, KnownPermissionGroup, NftCollection, NumberedPortfolio } from "../../../internal";
 import { EventIdEnum } from "../../../middleware/types";
-import { Compliance, EventIdentifier, MetadataDetails, MetadataType, Nft, TransferError, TransferRestriction, Venue } from "../../../types";
+import { Compliance, EventIdentifier, MetadataDetails, MetadataType, Nft, TransferRestriction, Venue } from "../../../types";
 /**
  * Represents a generic asset on chain. Common functionality (e.g. documents) can be interacted with directly. For type specific functionality (e.g. issue) the type can
  * be narrowed via `instanceof` operator, or by using a more specific getter
  */
 export declare type Asset = FungibleAsset | NftCollection;
+export declare enum KnownAssetType {
+    EquityCommon = "EquityCommon",
+    EquityPreferred = "EquityPreferred",
+    Commodity = "Commodity",
+    FixedIncome = "FixedIncome",
+    Reit = "Reit",
+    Fund = "Fund",
+    RevenueShareAgreement = "RevenueShareAgreement",
+    StructuredProduct = "StructuredProduct",
+    Derivative = "Derivative",
+    StableCoin = "StableCoin"
+}
+export declare enum KnownNftType {
+    Derivative = "Derivative",
+    FixedIncome = "FixedIncome",
+    Invoice = "Invoice"
+}
+export declare enum SecurityIdentifierType {
+    Isin = "Isin",
+    Cusip = "Cusip",
+    Cins = "Cins",
+    Lei = "Lei",
+    Figi = "Figi"
+}
+/**
+ * Alphanumeric standardized security identifier
+ */
+export interface SecurityIdentifier {
+    type: SecurityIdentifierType;
+    value: string;
+}
+/**
+ * Document attached to a token
+ */
+export interface AssetDocument {
+    name: string;
+    uri: string;
+    /**
+     * hex representation of the document (must be prefixed by "0x")
+     */
+    contentHash?: string;
+    type?: string;
+    filedAt?: Date;
+}
 /**
  * Properties that uniquely identify an Asset
  */
@@ -151,4 +195,131 @@ export interface VenueFilteringDetails {
 export declare type CollectionKey = MetadataKeyId & MetadataDetails;
 export * from './Fungible/Checkpoints/types';
 export * from './Fungible/CorporateActions/types';
+/**
+ * ERC1400 compliant transfer status
+ */
+export declare enum TransferStatus {
+    Failure = "Failure",
+    Success = "Success",
+    InsufficientBalance = "InsufficientBalance",
+    InsufficientAllowance = "InsufficientAllowance",
+    TransfersHalted = "TransfersHalted",
+    FundsLocked = "FundsLocked",
+    InvalidSenderAddress = "InvalidSenderAddress",
+    InvalidReceiverAddress = "InvalidReceiverAddress",
+    InvalidOperator = "InvalidOperator",
+    InvalidSenderIdentity = "InvalidSenderIdentity",
+    InvalidReceiverIdentity = "InvalidReceiverIdentity",
+    ComplianceFailure = "ComplianceFailure",
+    SmartExtensionFailure = "SmartExtensionFailure",
+    InvalidGranularity = "InvalidGranularity",
+    VolumeLimitReached = "VolumeLimitReached",
+    BlockedTransaction = "BlockedTransaction",
+    FundsLimitReached = "FundsLimitReached",
+    PortfolioFailure = "PortfolioFailure",
+    CustodianError = "CustodianError",
+    ScopeClaimMissing = "ScopeClaimMissing",
+    TransferRestrictionFailure = "TransferRestrictionFailure"
+}
+/**
+ * Akin to TransferStatus, these are a bit more granular and specific. Every TransferError translates to
+ *   a {@link TransferStatus}, but two or more TransferErrors can represent the same TransferStatus, and
+ *   not all Transfer Statuses are represented by a TransferError
+ */
+export declare enum TransferError {
+    /**
+     * translates to TransferStatus.InvalidGranularity
+     *
+     * occurs if attempting to transfer decimal amounts of a non-divisible token
+     */
+    InvalidGranularity = "InvalidGranularity",
+    /**
+     * translates to TransferStatus.InvalidReceiverIdentity
+     *
+     * occurs if the origin and destination Identities are the same
+     */
+    SelfTransfer = "SelfTransfer",
+    /**
+     * translates to TransferStatus.InvalidReceiverIdentity
+     *
+     * occurs if the receiver Identity doesn't have a valid CDD claim
+     */
+    InvalidReceiverCdd = "InvalidReceiverCdd",
+    /**
+     * translates to TransferStatus.InvalidSenderIdentity
+     *
+     * occurs if the receiver Identity doesn't have a valid CDD claim
+     */
+    InvalidSenderCdd = "InvalidSenderCdd",
+    /**
+     * translates to TransferStatus.ScopeClaimMissing
+     *
+     * occurs if one of the participants doesn't have a valid Investor Uniqueness Claim for
+     *   the Asset
+     */
+    ScopeClaimMissing = "ScopeClaimMissing",
+    /**
+     * translates to TransferStatus.InsufficientBalance
+     *
+     * occurs if the sender Identity does not have enough balance to cover the amount
+     */
+    InsufficientBalance = "InsufficientBalance",
+    /**
+     * translates to TransferStatus.TransfersHalted
+     *
+     * occurs if the Asset's transfers are frozen
+     */
+    TransfersFrozen = "TransfersFrozen",
+    /**
+     * translates to TransferStatus.PortfolioFailure
+     *
+     * occurs if the sender Portfolio doesn't exist
+     */
+    InvalidSenderPortfolio = "InvalidSenderPortfolio",
+    /**
+     * translates to TransferStatus.PortfolioFailure
+     *
+     * occurs if the receiver Portfolio doesn't exist
+     */
+    InvalidReceiverPortfolio = "InvalidReceiverPortfolio",
+    /**
+     * translates to TransferStatus.PortfolioFailure
+     *
+     * occurs if the sender Portfolio does not have enough balance to cover the amount
+     */
+    InsufficientPortfolioBalance = "InsufficientPortfolioBalance",
+    /**
+     * translates to TransferStatus.ComplianceFailure
+     *
+     * occurs if some compliance rule would prevent the transfer
+     */
+    ComplianceFailure = "ComplianceFailure"
+}
+export interface AssetWithGroup {
+    asset: FungibleAsset;
+    group: KnownPermissionGroup | CustomPermissionGroup;
+}
+/**
+ * Events triggered by transactions performed by an Agent Identity, related to the Token's configuration
+ *   For example: changing compliance requirements, inviting/removing agent Identities, freezing/unfreezing transfers
+ *
+ * Token transfers (settlements or movements between Portfolios) do not count as Operations
+ */
+export interface HistoricAgentOperation {
+    /**
+     * Agent Identity that performed the operations
+     */
+    identity: Identity;
+    /**
+     * list of Token Operation Events that were triggered by the Agent Identity
+     */
+    history: EventIdentifier[];
+}
+/**
+ * An nft collection, along with a subset of its NFTs
+ */
+export interface HeldNfts {
+    collection: NftCollection;
+    nfts: Nft[];
+}
 //# sourceMappingURL=types.d.ts.map

package/api/entities/Asset/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,aAAa,EACb,QAAQ,EACR,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EAClB,0BAAmB;AACpB,OAAO,EAAE,WAAW,EAAE,kCAA2B;AACjD,OAAO,EACL,UAAU,EACV,eAAe,EACf,eAAe,EACf,YAAY,EACZ,GAAG,EACH,aAAa,EACb,mBAAmB,EACnB,KAAK,EACN,uBAAgB;AAEjB;;;GAGG;AACH,oBAAY,KAAK,GAAG,aAAa,GAAG,aAAa,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC;IAChB,WAAW,EAAE,SAAS,CAAC;IACvB,UAAU,EAAE,QAAQ,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,SAAS,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,mBAAmB,CAAC;IACjC,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,YAAY,EAAE,yBAAyB,EAAE,CAAC;IAC1C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,QAAQ,CAAC;IAChB,KAAK,EAAE,oBAAoB,GAAG,qBAAqB,CAAC;CACrD;AAED,MAAM,WAAW,4BAA6B,SAAQ,eAAe;IACnE;;OAEG;IACH,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAClD;;OAEG;IACH,EAAE,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,KAAK,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,SAAS,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAyB,SAAQ,4BAA4B;IAC5E,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,sBAAuB,SAAQ,4BAA4B;IAC1E,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED;;GAEG;AACH,oBAAY,aAAa,GACrB;IACE,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;IAC1B,EAAE,EAAE,SAAS,CAAC;CACf,GACD;IACE,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC;IACzB,EAAE,EAAE,SAAS,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,GAAG,EAAE,aAAa,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE,KAAK,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,aAAa,GAAG,aAAa,GAAG,eAAe,CAAC;AAE5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,aAAa,EACb,QAAQ,EACR,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EAClB,0BAAmB;AACpB,OAAO,EAAE,WAAW,EAAE,kCAA2B;AACjD,OAAO,EACL,UAAU,EACV,eAAe,EACf,eAAe,EACf,YAAY,EACZ,GAAG,EACH,mBAAmB,EACnB,KAAK,EACN,uBAAgB;AAEjB;;;GAGG;AACH,oBAAY,KAAK,GAAG,aAAa,GAAG,aAAa,CAAC;AAElD,oBAAY,cAAc;IACxB,YAAY,iBAAiB;IAC7B,eAAe,oBAAoB;IACnC,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,IAAI,SAAS;IACb,qBAAqB,0BAA0B;IAC/C,iBAAiB,sBAAsB;IACvC,UAAU,eAAe;IACzB,UAAU,eAAe;CAC1B;AAED,oBAAY,YAAY;IACtB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;CACpB;AAED,oBAAY,sBAAsB;IAChC,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAKD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC;IAChB,WAAW,EAAE,SAAS,CAAC;IACvB,UAAU,EAAE,QAAQ,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,SAAS,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,mBAAmB,CAAC;IACjC,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,YAAY,EAAE,yBAAyB,EAAE,CAAC;IAC1C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,QAAQ,CAAC;IAChB,KAAK,EAAE,oBAAoB,GAAG,qBAAqB,CAAC;CACrD;AAED,MAAM,WAAW,4BAA6B,SAAQ,eAAe;IACnE;;OAEG;IACH,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAClD;;OAEG;IACH,EAAE,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,KAAK,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,SAAS,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAyB,SAAQ,4BAA4B;IAC5E,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,sBAAuB,SAAQ,4BAA4B;IAC1E,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED;;GAEG;AACH,oBAAY,aAAa,GACrB;IACE,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;IAC1B,EAAE,EAAE,SAAS,CAAC;CACf,GACD;IACE,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC;IACzB,EAAE,EAAE,SAAS,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,GAAG,EAAE,aAAa,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE,KAAK,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,aAAa,GAAG,aAAa,GAAG,eAAe,CAAC;AAE5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mCAAmC,CAAC;AAElD;;GAEG;AACH,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,mBAAmB,wBAAwB;IAC3C,qBAAqB,0BAA0B;IAC/C,eAAe,oBAAoB;IACnC,WAAW,gBAAgB;IAC3B,oBAAoB,yBAAyB;IAC7C,sBAAsB,2BAA2B;IACjD,eAAe,oBAAoB;IACnC,qBAAqB,0BAA0B;IAC/C,uBAAuB,4BAA4B;IACnD,iBAAiB,sBAAsB;IACvC,qBAAqB,0BAA0B;IAC/C,kBAAkB,uBAAuB;IACzC,kBAAkB,uBAAuB;IACzC,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;IACjC,iBAAiB,sBAAsB;IACvC,0BAA0B,+BAA+B;CAC1D;AAED;;;;GAIG;AACH,oBAAY,aAAa;IACvB;;;;OAIG;IACH,kBAAkB,uBAAuB;IACzC;;;;OAIG;IACH,YAAY,iBAAiB;IAC7B;;;;OAIG;IACH,kBAAkB,uBAAuB;IACzC;;;;OAIG;IACH,gBAAgB,qBAAqB;IACrC;;;;;OAKG;IACH,iBAAiB,sBAAsB;IACvC;;;;OAIG;IACH,mBAAmB,wBAAwB;IAC3C;;;;OAIG;IACH,eAAe,oBAAoB;IACnC;;;;OAIG;IACH,sBAAsB,2BAA2B;IACjD;;;;OAIG;IACH,wBAAwB,6BAA6B;IACrD;;;;OAIG;IACH,4BAA4B,iCAAiC;IAE7D;;;;OAIG;IACH,iBAAiB,sBAAsB;CACxC;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,aAAa,CAAC;IACrB,KAAK,EAAE,oBAAoB,GAAG,qBAAqB,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,aAAa,CAAC;IAC1B,IAAI,EAAE,GAAG,EAAE,CAAC;CACb"}