@polymeshassociation/polymesh-sdk 14.0.0-beta.11

package/Claims.js

@@ -0,0 +1,247 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Claims = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const lodash_1 = require("lodash");
+const internal_1 = require("./internal");
+const queries_1 = require("./middleware/queries");
+const types_1 = require("./middleware/types");
+const types_2 = require("./types");
+const internal_2 = require("./types/internal");
+const conversion_1 = require("./utils/conversion");
+const internal_3 = require("./utils/internal");
+/**
+ * Handles all Claims related functionality
+ */
+class Claims {
+    /**
+     * @hidden
+     */
+    constructor(context) {
+        this.context = context;
+        this.addClaims = (0, internal_3.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.modifyClaims,
+                Object.assign(Object.assign({}, args), { operation: internal_2.ClaimOperation.Add }),
+            ],
+        }, context);
+        this.editClaims = (0, internal_3.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.modifyClaims,
+                Object.assign(Object.assign({}, args), { operation: internal_2.ClaimOperation.Edit }),
+            ],
+        }, context);
+        this.revokeClaims = (0, internal_3.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.modifyClaims,
+                Object.assign(Object.assign({}, args), { operation: internal_2.ClaimOperation.Revoke }),
+            ],
+        }, context);
+        this.addInvestorUniquenessClaim = (0, internal_3.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.addInvestorUniquenessClaim, args] }, context);
+    }
+    /**
+     * Retrieve all claims issued by an Identity
+     *
+     * @param opts.target - Identity (optional, defaults to the signing Identity)
+     * @param opts.includeExpired - whether to include expired claims. Defaults to true
+     *
+     * @note supports pagination
+     * @note uses the middleware
+     */
+    getIssuedClaims(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { target, includeExpired = true, size, start } = opts;
+            const did = yield (0, internal_3.getDid)(target, context);
+            return context.getIdentityClaimsFromMiddleware({
+                trustedClaimIssuers: [did],
+                includeExpired,
+                size,
+                start,
+            });
+        });
+    }
+    /**
+     * Retrieve a list of Identities with claims associated to them. Can be filtered using parameters
+     *
+     * @param opts.targets - Identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets
+     * @param opts.trustedClaimIssuers - Identity IDs of claim issuers. Defaults to all claim issuers
+     * @param opts.scope - scope of the claims to fetch. Defaults to any scope
+     * @param opts.claimTypes - types of the claims to fetch. Defaults to any type
+     * @param opts.includeExpired - whether to include expired claims. Defaults to true
+     * @param opts.size - page size
+     * @param opts.start - page offset
+     *
+     * @note supports pagination
+     * @note uses the middleware
+     */
+    getIdentitiesWithClaims(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { targets, trustedClaimIssuers, scope, claimTypes, includeExpired = true, size, start, } = opts;
+            const result = yield context.queryMiddleware((0, queries_1.didsWithClaims)({
+                dids: targets === null || targets === void 0 ? void 0 : targets.map(target => (0, conversion_1.signerToString)(target)),
+                scope: scope ? (0, conversion_1.scopeToMiddlewareScope)(scope) : undefined,
+                trustedClaimIssuers: trustedClaimIssuers === null || trustedClaimIssuers === void 0 ? void 0 : trustedClaimIssuers.map(trustedClaimIssuer => (0, conversion_1.signerToString)(trustedClaimIssuer)),
+                claimTypes: claimTypes === null || claimTypes === void 0 ? void 0 : claimTypes.map(ct => types_1.ClaimTypeEnum[ct]),
+                includeExpired,
+                count: size === null || size === void 0 ? void 0 : size.toNumber(),
+                skip: start === null || start === void 0 ? void 0 : start.toNumber(),
+            }));
+            const { data: { didsWithClaims: { items: didsWithClaimsList, totalCount }, }, } = result;
+            const count = new bignumber_js_1.default(totalCount);
+            const data = (0, conversion_1.toIdentityWithClaimsArray)(didsWithClaimsList, context);
+            const next = (0, internal_3.calculateNextKey)(count, size, start);
+            return {
+                data,
+                next,
+                count,
+            };
+        });
+    }
+    /**
+     * Retrieve all scopes in which claims have been made for the target Identity.
+     *   If the scope is an asset DID, the corresponding ticker is returned as well
+     *
+     * @param opts.target - Identity for which to fetch claim scopes (optional, defaults to the signing Identity)
+     */
+    getClaimScopes(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { target } = opts;
+            const did = yield (0, internal_3.getDid)(target, context);
+            const identityClaimsFromChain = yield context.getIdentityClaimsFromChain({
+                targets: [did],
+                claimTypes: [
+                    types_2.ClaimType.Accredited,
+                    types_2.ClaimType.Affiliate,
+                    types_2.ClaimType.Blocked,
+                    types_2.ClaimType.BuyLockup,
+                    types_2.ClaimType.Exempted,
+                    types_2.ClaimType.InvestorUniqueness,
+                    types_2.ClaimType.Jurisdiction,
+                    types_2.ClaimType.KnowYourCustomer,
+                    types_2.ClaimType.SellLockup,
+                ],
+                trustedClaimIssuers: undefined,
+                includeExpired: true,
+            });
+            const claimScopeList = identityClaimsFromChain.map(({ claim }) => {
+                // only Scoped Claims were fetched so this assertion is reasonable
+                const { scope: { type, value }, } = claim;
+                let ticker;
+                if (type === types_2.ScopeType.Ticker) {
+                    ticker = (0, internal_3.removePadding)(value);
+                }
+                return {
+                    scope: { type, value: ticker !== null && ticker !== void 0 ? ticker : value },
+                    ticker,
+                };
+            });
+            return (0, lodash_1.uniqWith)(claimScopeList, lodash_1.isEqual);
+        });
+    }
+    /**
+     * Retrieve the list of CDD claims for a target Identity
+     *
+     * @param opts.target - Identity for which to fetch CDD claims (optional, defaults to the signing Identity)
+     * @param opts.includeExpired - whether to include expired claims. Defaults to true
+     */
+    getCddClaims(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { target, includeExpired = true } = opts;
+            const did = yield (0, internal_3.getDid)(target, context);
+            return context.getIdentityClaimsFromChain({
+                targets: [did],
+                claimTypes: [types_2.ClaimType.CustomerDueDiligence],
+                includeExpired,
+            });
+        });
+    }
+    /**
+     * Retrieve the list of InvestorUniqueness claims for a target Identity
+     *
+     * @param opts.target - Identity for which to fetch CDD claims (optional, defaults to the signing Identity)
+     * @param opts.includeExpired - whether to include expired claims. Defaults to true
+     */
+    getInvestorUniquenessClaims(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { target, includeExpired = true } = opts;
+            const did = yield (0, internal_3.getDid)(target, context);
+            return context.getIdentityClaimsFromChain({
+                targets: [did],
+                claimTypes: [types_2.ClaimType.InvestorUniqueness],
+                includeExpired,
+            });
+        });
+    }
+    /**
+     * Retrieve all claims issued about an Identity, grouped by claim issuer
+     *
+     * @param opts.target - Identity for which to fetch targeting claims (optional, defaults to the signing Identity)
+     * @param opts.includeExpired - whether to include expired claims. Defaults to true
+     *
+     * @note supports pagination
+     * @note uses the middleware (optional)
+     */
+    getTargetingClaims(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { target, trustedClaimIssuers, scope, includeExpired = true, size, start } = opts;
+            const did = yield (0, internal_3.getDid)(target, context);
+            const isMiddlewareAvailable = yield context.isMiddlewareAvailable();
+            if (isMiddlewareAvailable) {
+                const result = yield context.queryMiddleware((0, queries_1.issuerDidsWithClaimsByTarget)({
+                    target: did,
+                    scope: scope ? (0, conversion_1.scopeToMiddlewareScope)(scope) : undefined,
+                    trustedClaimIssuers: trustedClaimIssuers === null || trustedClaimIssuers === void 0 ? void 0 : trustedClaimIssuers.map(trustedClaimIssuer => (0, conversion_1.signerToString)(trustedClaimIssuer)),
+                    includeExpired,
+                    count: size === null || size === void 0 ? void 0 : size.toNumber(),
+                    skip: start === null || start === void 0 ? void 0 : start.toNumber(),
+                }));
+                const { data: { issuerDidsWithClaimsByTarget: { items: issuerDidsWithClaimsByTargetList, totalCount }, }, } = result;
+                const count = new bignumber_js_1.default(totalCount);
+                const data = (0, conversion_1.toIdentityWithClaimsArray)(issuerDidsWithClaimsByTargetList, context);
+                const next = (0, internal_3.calculateNextKey)(count, size, start);
+                return {
+                    data,
+                    next,
+                    count,
+                };
+            }
+            const identityClaimsFromChain = yield context.getIdentityClaimsFromChain({
+                targets: [did],
+                trustedClaimIssuers: trustedClaimIssuers === null || trustedClaimIssuers === void 0 ? void 0 : trustedClaimIssuers.map(trustedClaimIssuer => (0, conversion_1.signerToString)(trustedClaimIssuer)),
+                includeExpired,
+            });
+            const issuers = (0, lodash_1.uniqBy)(identityClaimsFromChain.map(i => i.issuer), identity => identity.did);
+            const identitiesWithClaims = issuers.map(identity => {
+                return {
+                    identity,
+                    claims: (0, lodash_1.filter)(identityClaimsFromChain, ({ issuer }) => issuer.isEqual(identity)),
+                };
+            });
+            return {
+                data: identitiesWithClaims,
+                next: null,
+                count: new bignumber_js_1.default(identitiesWithClaims.length),
+            };
+        });
+    }
+}
+exports.Claims = Claims;
+//# sourceMappingURL=Claims.js.map

package/Claims.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Claims.js","sourceRoot":"","sources":["../src/Claims.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gEAAqC;AACrC,mCAA2D;AAE3D,yCAOoB;AACpB,kDAAoF;AACpF,8CAA0D;AAC1D,mCAYiB;AACjB,+CAAkD;AAElD,mDAI4B;AAC5B,+CAAkG;AAElG;;GAEG;AACH,MAAa,MAAM;IAGjB;;OAEG;IACH,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,SAAS,GAAG,IAAA,gCAAqB,EAKpC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,uBAAY;gBACZ,gCACK,IAAI,KACP,SAAS,EAAE,yBAAc,CAAC,GAAG,GACR;aACxB;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,IAAA,gCAAqB,EAKrC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,uBAAY;gBACZ,gCACK,IAAI,KACP,SAAS,EAAE,yBAAc,CAAC,IAAI,GACT;aACxB;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,IAAA,gCAAqB,EAKvC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,uBAAY;gBACZ,gCACK,IAAI,KACP,SAAS,EAAE,yBAAc,CAAC,MAAM,GACX;aACxB;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,0BAA0B,GAAG,IAAA,gCAAqB,EACrD,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,qCAA0B,EAAE,IAAI,CAAC,EAAE,EACnE,OAAO,CACR,CAAC;IACJ,CAAC;IAgCD;;;;;;;;OAQG;IACU,eAAe,CAC1B,OAKI,EAAE;;YAEN,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACzB,MAAM,EAAE,MAAM,EAAE,cAAc,GAAG,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;YAE5D,MAAM,GAAG,GAAG,MAAM,IAAA,iBAAM,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAE1C,OAAO,OAAO,CAAC,+BAA+B,CAAC;gBAC7C,mBAAmB,EAAE,CAAC,GAAG,CAAC;gBAC1B,cAAc;gBACd,IAAI;gBACJ,KAAK;aACN,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;;;;;;;;OAaG;IACU,uBAAuB,CAClC,OAQI,EAAE;;YAEN,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEzB,MAAM,EACJ,OAAO,EACP,mBAAmB,EACnB,KAAK,EACL,UAAU,EACV,cAAc,GAAG,IAAI,EACrB,IAAI,EACJ,KAAK,GACN,GAAG,IAAI,CAAC;YAET,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAC1C,IAAA,wBAAc,EAAC;gBACb,IAAI,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAA,2BAAc,EAAC,MAAM,CAAC,CAAC;gBACpD,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,IAAA,mCAAsB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;gBACxD,mBAAmB,EAAE,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,GAAG,CAAC,kBAAkB,CAAC,EAAE,CACjE,IAAA,2BAAc,EAAC,kBAAkB,CAAC,CACnC;gBACD,UAAU,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,qBAAa,CAAC,EAAE,CAAC,CAAC;gBACpD,cAAc;gBACd,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;gBACvB,IAAI,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,EAAE;aACxB,CAAC,CACH,CAAC;YAEF,MAAM,EACJ,IAAI,EAAE,EACJ,cAAc,EAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,GAC1D,GACF,GAAG,MAAM,CAAC;YAEX,MAAM,KAAK,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,IAAI,GAAG,IAAA,sCAAyB,EAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;YACpE,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAElD,OAAO;gBACL,IAAI;gBACJ,IAAI;gBACJ,KAAK;aACN,CAAC;QACJ,CAAC;KAAA;IAED;;;;;OAKG;IACU,cAAc,CAAC,OAAuC,EAAE;;YACnE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACzB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;YAExB,MAAM,GAAG,GAAG,MAAM,IAAA,iBAAM,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAE1C,MAAM,uBAAuB,GAAG,MAAM,OAAO,CAAC,0BAA0B,CAAC;gBACvE,OAAO,EAAE,CAAC,GAAG,CAAC;gBACd,UAAU,EAAE;oBACV,iBAAS,CAAC,UAAU;oBACpB,iBAAS,CAAC,SAAS;oBACnB,iBAAS,CAAC,OAAO;oBACjB,iBAAS,CAAC,SAAS;oBACnB,iBAAS,CAAC,QAAQ;oBAClB,iBAAS,CAAC,kBAAkB;oBAC5B,iBAAS,CAAC,YAAY;oBACtB,iBAAS,CAAC,gBAAgB;oBAC1B,iBAAS,CAAC,UAAU;iBACrB;gBACD,mBAAmB,EAAE,SAAS;gBAC9B,cAAc,EAAE,IAAI;aACrB,CAAC,CAAC;YAEH,MAAM,cAAc,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC/D,kEAAkE;gBAClE,MAAM,EACJ,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GACvB,GAAG,KAAoB,CAAC;gBAEzB,IAAI,MAA0B,CAAC;gBAE/B,IAAI,IAAI,KAAK,iBAAS,CAAC,MAAM,EAAE;oBAC7B,MAAM,GAAG,IAAA,wBAAa,EAAC,KAAK,CAAC,CAAC;iBAC/B;gBAED,OAAO;oBACL,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,EAAE;oBACvC,MAAM;iBACP,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,OAAO,IAAA,iBAAQ,EAAC,cAAc,EAAE,gBAAO,CAAC,CAAC;QAC3C,CAAC;KAAA;IAED;;;;;OAKG;IACU,YAAY,CACvB,OAGI,EAAE;;YAEN,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACzB,MAAM,EAAE,MAAM,EAAE,cAAc,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;YAE/C,MAAM,GAAG,GAAG,MAAM,IAAA,iBAAM,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAE1C,OAAO,OAAO,CAAC,0BAA0B,CAAC;gBACxC,OAAO,EAAE,CAAC,GAAG,CAAC;gBACd,UAAU,EAAE,CAAC,iBAAS,CAAC,oBAAoB,CAAC;gBAC5C,cAAc;aACf,CAAmC,CAAC;QACvC,CAAC;KAAA;IAED;;;;;OAKG;IACU,2BAA2B,CACtC,OAGI,EAAE;;YAEN,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACzB,MAAM,EAAE,MAAM,EAAE,cAAc,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;YAE/C,MAAM,GAAG,GAAG,MAAM,IAAA,iBAAM,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAE1C,OAAO,OAAO,CAAC,0BAA0B,CAAC;gBACxC,OAAO,EAAE,CAAC,GAAG,CAAC;gBACd,UAAU,EAAE,CAAC,iBAAS,CAAC,kBAAkB,CAAC;gBAC1C,cAAc;aACf,CAAkD,CAAC;QACtD,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,kBAAkB,CAC7B,OAOI,EAAE;;YAEN,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEzB,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,KAAK,EAAE,cAAc,GAAG,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;YAExF,MAAM,GAAG,GAAG,MAAM,IAAA,iBAAM,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAE1C,MAAM,qBAAqB,GAAG,MAAM,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAEpE,IAAI,qBAAqB,EAAE;gBACzB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAC1C,IAAA,sCAA4B,EAAC;oBAC3B,MAAM,EAAE,GAAG;oBACX,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,IAAA,mCAAsB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;oBACxD,mBAAmB,EAAE,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,GAAG,CAAC,kBAAkB,CAAC,EAAE,CACjE,IAAA,2BAAc,EAAC,kBAAkB,CAAC,CACnC;oBACD,cAAc;oBACd,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;oBACvB,IAAI,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,EAAE;iBACxB,CAAC,CACH,CAAC;gBAEF,MAAM,EACJ,IAAI,EAAE,EACJ,4BAA4B,EAAE,EAAE,KAAK,EAAE,gCAAgC,EAAE,UAAU,EAAE,GACtF,GACF,GAAG,MAAM,CAAC;gBAEX,MAAM,KAAK,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,CAAC;gBACxC,MAAM,IAAI,GAAG,IAAA,sCAAyB,EAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;gBAClF,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;gBAElD,OAAO;oBACL,IAAI;oBACJ,IAAI;oBACJ,KAAK;iBACN,CAAC;aACH;YAED,MAAM,uBAAuB,GAAG,MAAM,OAAO,CAAC,0BAA0B,CAAC;gBACvE,OAAO,EAAE,CAAC,GAAG,CAAC;gBACd,mBAAmB,EAAE,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,GAAG,CAAC,kBAAkB,CAAC,EAAE,CACjE,IAAA,2BAAc,EAAC,kBAAkB,CAAC,CACnC;gBACD,cAAc;aACf,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,IAAA,eAAM,EACpB,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAC1C,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CACzB,CAAC;YAEF,MAAM,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAClD,OAAO;oBACL,QAAQ;oBACR,MAAM,EAAE,IAAA,eAAM,EAAC,uBAAuB,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;iBAClF,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,IAAI,EAAE,oBAAoB;gBAC1B,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,IAAI,sBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC;aAClD,CAAC;QACJ,CAAC;KAAA;CACF;AAxXD,wBAwXC"}

package/Identities.d.ts

@@ -0,0 +1,45 @@
+import { Context, Identity, NumberedPortfolio, RegisterIdentityParams } from "./internal";
+import { ProcedureMethod } from "./types";
+/**
+ * Handles all Identity related functionality
+ */
+export declare class Identities {
+    private context;
+    /**
+     * @hidden
+     */
+    constructor(context: Context);
+    /**
+     * Register an Identity
+     *
+     * @note must be a CDD provider
+     * @note this may create {@link AuthorizationRequest | Authorization Requests} which have to be accepted by the `targetAccount`.
+     *   An {@link Account} or {@link Identity} can fetch its pending Authorization Requests by calling {@link Authorizations.getReceived | authorizations.getReceived}.
+     *   Also, an Account or Identity can directly fetch the details of an Authorization Request by calling {@link Authorizations.getOne | authorizations.getOne}
+     *
+     * @note required role:
+     *   - Customer Due Diligence Provider
+     */
+    registerIdentity: ProcedureMethod<RegisterIdentityParams, Identity>;
+    /**
+     * Create a new Portfolio under the ownership of the signing Identity
+     */
+    createPortfolio: ProcedureMethod<{
+        name: string;
+    }, NumberedPortfolio>;
+    /**
+     * Create an Identity instance from a DID
+     *
+     * @throws if there is no Identity with the passed DID
+     */
+    getIdentity(args: {
+        did: string;
+    }): Promise<Identity>;
+    /**
+     * Return whether the supplied Identity/DID exists
+     */
+    isIdentityValid(args: {
+        identity: Identity | string;
+    }): Promise<boolean>;
+}
+//# sourceMappingURL=Identities.d.ts.map

package/Identities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Identities.d.ts","sourceRoot":"","sources":["../src/Identities.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAEP,QAAQ,EACR,iBAAiB,EAEjB,sBAAsB,EACvB,mBAAmB;AACpB,OAAO,EAAE,eAAe,EAAE,gBAAgB;AAG1C;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAU;IAEzB;;OAEG;gBACS,OAAO,EAAE,OAAO;IAc5B;;;;;;;;;;OAUG;IACI,gBAAgB,EAAE,eAAe,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;IAE3E;;OAEG;IACI,eAAe,EAAE,eAAe,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,iBAAiB,CAAC,CAAC;IAE7E;;;;OAIG;IACI,WAAW,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5D;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGhF"}

package/Identities.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Identities = void 0;
+const internal_1 = require("./internal");
+const internal_2 = require("./utils/internal");
+/**
+ * Handles all Identity related functionality
+ */
+class Identities {
+    /**
+     * @hidden
+     */
+    constructor(context) {
+        this.context = context;
+        this.registerIdentity = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.registerIdentity, args] }, context);
+        this.createPortfolio = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.createPortfolio, args] }, context);
+    }
+    /**
+     * Create an Identity instance from a DID
+     *
+     * @throws if there is no Identity with the passed DID
+     */
+    getIdentity(args) {
+        return this.context.getIdentity(args.did);
+    }
+    /**
+     * Return whether the supplied Identity/DID exists
+     */
+    isIdentityValid(args) {
+        return (0, internal_2.asIdentity)(args.identity, this.context).exists();
+    }
+}
+exports.Identities = Identities;
+//# sourceMappingURL=Identities.js.map

package/Identities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Identities.js","sourceRoot":"","sources":["../src/Identities.ts"],"names":[],"mappings":";;;AAAA,yCAOoB;AAEpB,+CAAqE;AAErE;;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,eAAe,GAAG,IAAA,gCAAqB,EAC1C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,0BAAe,EAAE,IAAI,CAAC,EAAE,EACxD,OAAO,CACR,CAAC;IACJ,CAAC;IAoBD;;;;OAIG;IACI,WAAW,CAAC,IAAqB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5C,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;CACF;AArDD,gCAqDC"}

package/Network.d.ts

@@ -0,0 +1,104 @@
+import BigNumber from 'bignumber.js';
+import { Account, Context, TransferPolyxParams } from "./internal";
+import { EventIdEnum as EventId, ModuleIdEnum as ModuleId } from "./middleware/types";
+import { EventIdentifier, ExtrinsicDataWithFees, NetworkProperties, ProcedureMethod, ProtocolFees, SubCallback, TxTag, UnsubCallback } from "./types";
+/**
+ * Handles all Network related functionality, including querying for historical events from middleware
+ */
+export declare class Network {
+    private context;
+    /**
+     * @hidden
+     */
+    constructor(context: Context);
+    /**
+     * Retrieve the number of the latest block in the chain
+     */
+    getLatestBlock(): Promise<BigNumber>;
+    /**
+     * Fetch the current network version (i.e. 3.1.0)
+     */
+    getVersion(): Promise<string>;
+    /**
+     * Retrieve the chain's SS58 format
+     */
+    getSs58Format(): BigNumber;
+    /**
+     * Retrieve information for the current network
+     */
+    getNetworkProperties(): Promise<NetworkProperties>;
+    /**
+     * Retrieve the protocol fees associated with running specific transactions
+     *
+     * @param args.tags - list of transaction tags (i.e. [TxTags.asset.CreateAsset, TxTags.asset.RegisterTicker] or ["asset.createAsset", "asset.registerTicker"])
+     */
+    getProtocolFees(args: {
+        tags: TxTag[];
+    }): Promise<ProtocolFees[]>;
+    /**
+     * Get the treasury wallet address
+     */
+    getTreasuryAccount(): Account;
+    /**
+     * Get the Treasury POLYX balance
+     *
+     * @note can be subscribed to
+     */
+    getTreasuryBalance(): Promise<BigNumber>;
+    getTreasuryBalance(callback: SubCallback<BigNumber>): Promise<UnsubCallback>;
+    /**
+     * Transfer an amount of POLYX to a specified Account
+     */
+    transferPolyx: ProcedureMethod<TransferPolyxParams, void>;
+    /**
+     * Retrieve a single event by any of its indexed arguments. Can be filtered using parameters
+     *
+     * @param opts.moduleId - type of the module to fetch
+     * @param opts.eventId - type of the event to fetch
+     * @param opts.eventArg0 - event parameter value to filter by in position 0
+     * @param opts.eventArg1 - event parameter value to filter by in position 1
+     * @param opts.eventArg2 - event parameter value to filter by in position 2
+     *
+     * @note uses the middleware
+     */
+    getEventByIndexedArgs(opts: {
+        moduleId: ModuleId;
+        eventId: EventId;
+        eventArg0?: string;
+        eventArg1?: string;
+        eventArg2?: string;
+    }): Promise<EventIdentifier | null>;
+    /**
+     * Retrieve a list of events. Can be filtered using parameters
+     *
+     * @param opts.moduleId - type of the module to fetch
+     * @param opts.eventId - type of the event to fetch
+     * @param opts.eventArg0 - event parameter value to filter by in position 0
+     * @param opts.eventArg1 - event parameter value to filter by in position 1
+     * @param opts.eventArg2 - event parameter value to filter by in position 2
+     * @param opts.size - page size
+     * @param opts.start - page offset
+     *
+     * @note uses the middleware
+     */
+    getEventsByIndexedArgs(opts: {
+        moduleId: ModuleId;
+        eventId: EventId;
+        eventArg0?: string;
+        eventArg1?: string;
+        eventArg2?: string;
+        size?: BigNumber;
+        start?: BigNumber;
+    }): Promise<EventIdentifier[] | null>;
+    /**
+     * Retrieve a transaction by hash
+     *
+     * @param opts.txHash - hash of the transaction
+     *
+     * @note uses the middleware
+     */
+    getTransactionByHash(opts: {
+        txHash: string;
+    }): Promise<ExtrinsicDataWithFees | null>;
+}
+//# sourceMappingURL=Network.d.ts.map

package/Network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Network.d.ts","sourceRoot":"","sources":["../src/Network.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAiB,mBAAmB,EAAE,mBAAmB;AAElF,OAAO,EAAE,WAAW,IAAI,OAAO,EAAE,YAAY,IAAI,QAAQ,EAAS,2BAA2B;AAC7F,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,WAAW,EACX,KAAK,EACL,aAAa,EACd,gBAAgB;AAcjB;;GAEG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,OAAO,CAAU;IAEzB;;OAEG;gBACS,OAAO,EAAE,OAAO;IAS5B;;OAEG;IACI,cAAc,IAAI,OAAO,CAAC,SAAS,CAAC;IAI3C;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAI1C;;OAEG;IACI,aAAa,IAAI,SAAS;IAIjC;;OAEG;IACU,oBAAoB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAmB/D;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,KAAK,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAIxE;;OAEG;IACI,kBAAkB,IAAI,OAAO;IAQpC;;;;OAIG;IACI,kBAAkB,IAAI,OAAO,CAAC,SAAS,CAAC;IACxC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IAmBnF;;OAEG;IACI,aAAa,EAAE,eAAe,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAEjE;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,IAAI,EAAE;QACvC,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAoBnC;;;;;;;;;;;;OAYG;IACU,sBAAsB,CAAC,IAAI,EAAE;QACxC,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,CAAC,EAAE,SAAS,CAAC;KACnB,GAAG,OAAO,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;IA6BrC;;;;;;OAMG;IACU,oBAAoB,CAAC,IAAI,EAAE;QACtC,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;CA6E1C"}

package/Network.js

@@ -0,0 +1,203 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Network = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const internal_1 = require("./internal");
+const queries_1 = require("./middleware/queries");
+const constants_1 = require("./utils/constants");
+const conversion_1 = require("./utils/conversion");
+const internal_2 = require("./utils/internal");
+/**
+ * Handles all Network related functionality, including querying for historical events from middleware
+ */
+class Network {
+    /**
+     * @hidden
+     */
+    constructor(context) {
+        this.context = context;
+        this.transferPolyx = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.transferPolyx, args] }, context);
+    }
+    /**
+     * Retrieve the number of the latest block in the chain
+     */
+    getLatestBlock() {
+        return this.context.getLatestBlock();
+    }
+    /**
+     * Fetch the current network version (i.e. 3.1.0)
+     */
+    getVersion() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.context.getNetworkVersion();
+        });
+    }
+    /**
+     * Retrieve the chain's SS58 format
+     */
+    getSs58Format() {
+        return this.context.ss58Format;
+    }
+    /**
+     * Retrieve information for the current network
+     */
+    getNetworkProperties() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { runtimeVersion: { specVersion }, rpc: { system: { chain }, }, }, }, } = this;
+            const name = yield chain();
+            return {
+                name: (0, conversion_1.textToString)(name),
+                version: (0, conversion_1.u32ToBigNumber)(specVersion),
+            };
+        });
+    }
+    /**
+     * Retrieve the protocol fees associated with running specific transactions
+     *
+     * @param args.tags - list of transaction tags (i.e. [TxTags.asset.CreateAsset, TxTags.asset.RegisterTicker] or ["asset.createAsset", "asset.registerTicker"])
+     */
+    getProtocolFees(args) {
+        return this.context.getProtocolFees(args);
+    }
+    /**
+     * Get the treasury wallet address
+     */
+    getTreasuryAccount() {
+        const { context } = this;
+        return new internal_1.Account({ address: (0, conversion_1.moduleAddressToString)(constants_1.TREASURY_MODULE_ADDRESS, context) }, context);
+    }
+    // eslint-disable-next-line require-jsdoc
+    getTreasuryBalance(callback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const account = this.getTreasuryAccount();
+            if (callback) {
+                return account.getBalance(({ free: freeBalance }) => {
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- callback errors should be handled by the caller
+                    callback(freeBalance);
+                });
+            }
+            const { free } = yield account.getBalance();
+            return free;
+        });
+    }
+    /**
+     * Retrieve a single event by any of its indexed arguments. Can be filtered using parameters
+     *
+     * @param opts.moduleId - type of the module to fetch
+     * @param opts.eventId - type of the event to fetch
+     * @param opts.eventArg0 - event parameter value to filter by in position 0
+     * @param opts.eventArg1 - event parameter value to filter by in position 1
+     * @param opts.eventArg2 - event parameter value to filter by in position 2
+     *
+     * @note uses the middleware
+     */
+    getEventByIndexedArgs(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { moduleId, eventId, eventArg0, eventArg1, eventArg2 } = opts;
+            const { data: { eventByIndexedArgs: event }, } = yield context.queryMiddleware((0, queries_1.eventByIndexedArgs)({
+                moduleId,
+                eventId,
+                eventArg0,
+                eventArg1,
+                eventArg2,
+            }));
+            return (0, internal_2.optionize)(conversion_1.middlewareEventToEventIdentifier)(event);
+        });
+    }
+    /**
+     * Retrieve a list of events. Can be filtered using parameters
+     *
+     * @param opts.moduleId - type of the module to fetch
+     * @param opts.eventId - type of the event to fetch
+     * @param opts.eventArg0 - event parameter value to filter by in position 0
+     * @param opts.eventArg1 - event parameter value to filter by in position 1
+     * @param opts.eventArg2 - event parameter value to filter by in position 2
+     * @param opts.size - page size
+     * @param opts.start - page offset
+     *
+     * @note uses the middleware
+     */
+    getEventsByIndexedArgs(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const { moduleId, eventId, eventArg0, eventArg1, eventArg2, size, start } = opts;
+            const result = yield context.queryMiddleware((0, queries_1.eventsByIndexedArgs)({
+                moduleId,
+                eventId,
+                eventArg0,
+                eventArg1,
+                eventArg2,
+                count: size === null || size === void 0 ? void 0 : size.toNumber(),
+                skip: start === null || start === void 0 ? void 0 : start.toNumber(),
+            }));
+            const { data: { eventsByIndexedArgs: events }, } = result;
+            if (events) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                return events.map(event => (0, conversion_1.middlewareEventToEventIdentifier)(event));
+            }
+            return null;
+        });
+    }
+    /**
+     * Retrieve a transaction by hash
+     *
+     * @param opts.txHash - hash of the transaction
+     *
+     * @note uses the middleware
+     */
+    getTransactionByHash(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { rpc: { chain: { getBlock }, payment: { queryInfo }, }, }, }, context, } = this;
+            const { txHash: transactionHash } = opts;
+            const result = yield context.queryMiddleware((0, queries_1.transactionByHash)({
+                transactionHash,
+            }));
+            const { data: { transactionByHash: transaction }, } = result;
+            if (transaction) {
+                const { block_id: blockNumber, extrinsic_idx: extrinsicIdx, address: rawAddress, nonce, module_id: moduleId, call_id: callId, params, success: txSuccess, spec_version_id: specVersionId, extrinsic_hash: extrinsicHash, block, } = transaction;
+                const txTag = (0, conversion_1.extrinsicIdentifierToTxTag)({ moduleId, callId });
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                const blockHash = block.hash;
+                const rawBlockHash = (0, conversion_1.stringToBlockHash)(blockHash, context);
+                const { block: { extrinsics }, } = yield getBlock(rawBlockHash);
+                const [{ partialFee }, [{ fees: protocolFees }]] = yield Promise.all([
+                    queryInfo(extrinsics[extrinsicIdx].toHex(), rawBlockHash),
+                    context.getProtocolFees({ tags: [txTag], blockHash }),
+                ]);
+                return {
+                    blockNumber: new bignumber_js_1.default(blockNumber),
+                    blockHash,
+                    extrinsicIdx: new bignumber_js_1.default(extrinsicIdx),
+                    address: rawAddress !== null && rawAddress !== void 0 ? rawAddress : null,
+                    nonce: nonce ? new bignumber_js_1.default(nonce) : null,
+                    txTag,
+                    params,
+                    success: !!txSuccess,
+                    specVersionId: new bignumber_js_1.default(specVersionId),
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    extrinsicHash: extrinsicHash,
+                    fee: {
+                        gas: (0, conversion_1.balanceToBigNumber)(partialFee),
+                        protocol: protocolFees,
+                    },
+                };
+            }
+            return null;
+        });
+    }
+}
+exports.Network = Network;
+//# sourceMappingURL=Network.js.map