@polymeshassociation/polymesh-sdk 14.0.0-beta.11

package/api/entities/Identity/Portfolios.js

@@ -0,0 +1,107 @@
+"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.Portfolios = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const internal_1 = require("../../../internal");
+const types_1 = require("../../../types");
+const conversion_1 = require("../../../utils/conversion");
+const internal_2 = require("../../../utils/internal");
+/**
+ * Handles all Portfolio related functionality on the Identity side
+ */
+class Portfolios extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        const { did } = parent;
+        this.delete = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: args => {
+                const { portfolio } = args;
+                const id = portfolio instanceof bignumber_js_1.default ? portfolio : portfolio.id;
+                return [internal_1.deletePortfolio, { id, did }];
+            },
+        }, context);
+    }
+    /**
+     * Retrieve all the Portfolios owned by this Identity
+     */
+    getPortfolios() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, context: { polymeshApi: { query: { portfolio }, }, }, parent: { did }, } = this;
+            const identityId = (0, conversion_1.stringToIdentityId)(did, context);
+            const rawPortfolios = yield portfolio.portfolios.entries(identityId);
+            const portfolios = [
+                new internal_1.DefaultPortfolio({ did }, context),
+            ];
+            rawPortfolios.forEach(([key]) => {
+                portfolios.push(new internal_1.NumberedPortfolio({ id: (0, conversion_1.u64ToBigNumber)(key.args[1]), did }, context));
+            });
+            return portfolios;
+        });
+    }
+    /**
+     * Retrieve all Portfolios custodied by this Identity.
+     *   This only includes portfolios owned by a different Identity but custodied by this one.
+     *   To fetch Portfolios owned by this Identity, use {@link getPortfolios}
+     *
+     * @note supports pagination
+     */
+    getCustodiedPortfolios(paginationOpts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, context: { polymeshApi: { query: { portfolio }, }, }, parent: { did: custodianDid }, } = this;
+            const custodian = (0, conversion_1.stringToIdentityId)(custodianDid, context);
+            const { entries: portfolioEntries, lastKey: next } = yield (0, internal_2.requestPaginated)(portfolio.portfoliosInCustody, {
+                arg: custodian,
+                paginationOpts,
+            });
+            const data = portfolioEntries.map(([{ args }]) => {
+                const { did: ownerDid, kind } = args[1];
+                const did = (0, conversion_1.identityIdToString)(ownerDid);
+                if (kind.isDefault) {
+                    return new internal_1.DefaultPortfolio({ did }, context);
+                }
+                const id = (0, conversion_1.u64ToBigNumber)(kind.asUser);
+                return new internal_1.NumberedPortfolio({ did, id }, context);
+            });
+            return {
+                data,
+                next,
+            };
+        });
+    }
+    // eslint-disable-next-line require-jsdoc
+    getPortfolio(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, parent: { did }, } = this;
+            const portfolioId = args === null || args === void 0 ? void 0 : args.portfolioId;
+            if (!portfolioId) {
+                return new internal_1.DefaultPortfolio({ did }, context);
+            }
+            const numberedPortfolio = new internal_1.NumberedPortfolio({ id: portfolioId, did }, context);
+            const exists = yield numberedPortfolio.exists();
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: "The Portfolio doesn't exist",
+                });
+            }
+            return numberedPortfolio;
+        });
+    }
+}
+exports.Portfolios = Portfolios;
+//# sourceMappingURL=Portfolios.js.map

package/api/entities/Identity/Portfolios.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Portfolios.js","sourceRoot":"","sources":["../../../../src/api/entities/Identity/Portfolios.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gEAAqC;AAErC,gDAQoB;AACpB,0CAAmF;AACnF,0DAA4F;AAC5F,sDAA2E;AAE3E;;GAEG;AACH,MAAa,UAAW,SAAQ,oBAAmB;IACjD;;OAEG;IACH,YAAY,MAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEvB,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;QAEvB,IAAI,CAAC,MAAM,GAAG,IAAA,gCAAqB,EACjC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE;gBAC1B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;gBAC3B,MAAM,EAAE,GAAG,SAAS,YAAY,sBAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;gBAErE,OAAO,CAAC,0BAAe,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YACxC,CAAC;SACF,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;OAEG;IACU,aAAa;;YACxB,MAAM,EACJ,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,SAAS,EAAE,GACrB,GACF,EACD,MAAM,EAAE,EAAE,GAAG,EAAE,GAChB,GAAG,IAAI,CAAC;YAET,MAAM,UAAU,GAAG,IAAA,+BAAkB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YACpD,MAAM,aAAa,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAErE,MAAM,UAAU,GAA+C;gBAC7D,IAAI,2BAAgB,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC;aACvC,CAAC;YACF,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE;gBAC9B,UAAU,CAAC,IAAI,CAAC,IAAI,4BAAiB,CAAC,EAAE,EAAE,EAAE,IAAA,2BAAc,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;YAEH,OAAO,UAAU,CAAC;QACpB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,sBAAsB,CACjC,cAAkC;;YAElC,MAAM,EACJ,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,SAAS,EAAE,GACrB,GACF,EACD,MAAM,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,GAC9B,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,+BAAkB,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC5D,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,2BAAgB,EACzE,SAAS,CAAC,mBAAmB,EAC7B;gBACE,GAAG,EAAE,SAAS;gBACd,cAAc;aACf,CACF,CAAC;YAEF,MAAM,IAAI,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE;gBAC/C,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBAExC,MAAM,GAAG,GAAG,IAAA,+BAAkB,EAAC,QAAQ,CAAC,CAAC;gBAEzC,IAAI,IAAI,CAAC,SAAS,EAAE;oBAClB,OAAO,IAAI,2BAAgB,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;iBAC/C;gBAED,MAAM,EAAE,GAAG,IAAA,2BAAc,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEvC,OAAO,IAAI,4BAAiB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,IAAI;gBACJ,IAAI;aACL,CAAC;QACJ,CAAC;KAAA;IAUD,yCAAyC;IAC5B,YAAY,CAAC,IAEzB;;YACC,MAAM,EACJ,OAAO,EACP,MAAM,EAAE,EAAE,GAAG,EAAE,GAChB,GAAG,IAAI,CAAC;YAET,MAAM,WAAW,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,CAAC;YAEtC,IAAI,CAAC,WAAW,EAAE;gBAChB,OAAO,IAAI,2BAAgB,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;aAC/C;YAED,MAAM,iBAAiB,GAAG,IAAI,4BAAiB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;YACnF,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,MAAM,EAAE,CAAC;YAEhD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,6BAA6B;iBACvC,CAAC,CAAC;aACJ;YAED,OAAO,iBAAiB,CAAC;QAC3B,CAAC;KAAA;CASF;AA7ID,gCA6IC"}

package/api/entities/Identity/index.d.ts

@@ -0,0 +1,152 @@
+import BigNumber from 'bignumber.js';
+import { Asset, Context, Entity, Instruction, Venue } from "../../../internal";
+import { CheckRolesResult, DistributionWithDetails, GroupedInstructions, Order, PermissionedAccount, ResultSet, Role, SubCallback, UnsubCallback } from "../../../types";
+import { AssetPermissions } from './AssetPermissions';
+import { IdentityAuthorizations } from './IdentityAuthorizations';
+import { Portfolios } from './Portfolios';
+/**
+ * Properties that uniquely identify an Identity
+ */
+export interface UniqueIdentifiers {
+    did: string;
+}
+/**
+ * Represents an Identity in the Polymesh blockchain
+ */
+export declare class Identity extends Entity<UniqueIdentifiers, string> {
+    /**
+     * @hidden
+     * Checks if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier: unknown): identifier is UniqueIdentifiers;
+    /**
+     * Identity ID as stored in the blockchain
+     */
+    did: string;
+    authorizations: IdentityAuthorizations;
+    portfolios: Portfolios;
+    assetPermissions: AssetPermissions;
+    /**
+     * Create an Identity entity
+     */
+    constructor(identifiers: UniqueIdentifiers, context: Context);
+    /**
+     * Check whether this Identity possesses the specified Role
+     */
+    hasRole(role: Role): Promise<boolean>;
+    /**
+     * Retrieve the balance of a particular Asset
+     *
+     * @note can be subscribed to
+     */
+    getAssetBalance(args: {
+        ticker: string;
+    }): Promise<BigNumber>;
+    getAssetBalance(args: {
+        ticker: string;
+    }, callback: SubCallback<BigNumber>): Promise<UnsubCallback>;
+    /**
+     * Check whether this Identity has a valid CDD claim
+     */
+    hasValidCdd(): Promise<boolean>;
+    /**
+     * Check whether this Identity is Governance Committee member
+     */
+    isGcMember(): Promise<boolean>;
+    /**
+     * Check whether this Identity is a CDD provider
+     */
+    isCddProvider(): Promise<boolean>;
+    /**
+     * Retrieve the primary Account associated with the Identity
+     *
+     * @note can be subscribed to
+     */
+    getPrimaryAccount(): Promise<PermissionedAccount>;
+    getPrimaryAccount(callback: SubCallback<PermissionedAccount>): Promise<UnsubCallback>;
+    /**
+     * Retrieve a list of all Assets which were held at one point by this Identity
+     *
+     * @note uses the middleware
+     * @note supports pagination
+     */
+    getHeldAssets(opts?: {
+        order?: Order;
+        size?: BigNumber;
+        start?: BigNumber;
+    }): Promise<ResultSet<Asset>>;
+    /**
+     * Check whether this Identity possesses all specified roles
+     */
+    checkRoles(roles: Role[]): Promise<CheckRolesResult>;
+    /**
+     * Check whether this Identity possesses all specified roles
+     *
+     * @deprecated in favor of `checkRoles`
+     */
+    hasRoles(roles: Role[]): Promise<boolean>;
+    /**
+     * Get the list of Assets for which this Identity is a trusted claim issuer
+     *
+     * @note uses the middleware
+     */
+    getTrustingAssets(): Promise<Asset[]>;
+    /**
+     * Retrieve all Venues created by this Identity
+     *
+     * @note can be subscribed to
+     */
+    getVenues(): Promise<Venue[]>;
+    getVenues(callback: SubCallback<Venue[]>): Promise<UnsubCallback>;
+    /**
+     * Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Asset, or null
+     *   if there is none
+     *
+     * @note more on Investor Uniqueness {@link https://developers.polymesh.network/introduction/identity#polymesh-unique-identity-system-puis | here} and
+     *   {@link https://developers.polymesh.network/polymesh-docs/primitives/confidential-identity | here}
+     */
+    getScopeId(args: {
+        asset: Asset | string;
+    }): Promise<string | null>;
+    /**
+     * Retrieve all Instructions where this Identity is a participant,
+     *   grouped by status
+     */
+    getInstructions(): Promise<GroupedInstructions>;
+    /**
+     * Retrieve all pending Instructions involving this Identity
+     *
+     * @deprecated in favor of `getInstructions`
+     */
+    getPendingInstructions(): Promise<Instruction[]>;
+    /**
+     * Check whether secondary Accounts are frozen
+     *
+     * @note can be subscribed to
+     */
+    areSecondaryAccountsFrozen(): Promise<boolean>;
+    areSecondaryAccountsFrozen(callback: SubCallback<boolean>): Promise<UnsubCallback>;
+    /**
+     * Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid
+     *
+     * @note uses the middleware
+     * @note this query can be potentially **SLOW** depending on which Assets this Identity has held
+     */
+    getPendingDistributions(): Promise<DistributionWithDetails[]>;
+    /**
+     * Get the list of secondary Accounts related to the Identity
+     *
+     * @note can be subscribed to
+     */
+    getSecondaryAccounts(): Promise<PermissionedAccount[]>;
+    getSecondaryAccounts(callback: SubCallback<PermissionedAccount[]>): Promise<UnsubCallback>;
+    /**
+     * Determine whether this Identity exists on chain
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Return the Identity's DID
+     */
+    toHuman(): string;
+}
+//# sourceMappingURL=index.d.ts.map

package/api/entities/Identity/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Identity/index.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,cAAc,CAAC;AAMrC,OAAO,EAEL,KAAK,EACL,OAAO,EACP,MAAM,EACN,WAAW,EAGX,KAAK,EACN,0BAAmB;AAGpB,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAEvB,mBAAmB,EACnB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,IAAI,EACJ,WAAW,EACX,aAAa,EACd,uBAAgB;AA8BjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAC7D;;;OAGG;WACoB,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,iBAAiB;IAMhG;;OAEG;IACI,GAAG,EAAE,MAAM,CAAC;IAGZ,cAAc,EAAE,sBAAsB,CAAC;IACvC,UAAU,EAAE,UAAU,CAAC;IACvB,gBAAgB,EAAE,gBAAgB,CAAC;IAE1C;;OAEG;gBACS,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IAW5D;;OAEG;IACU,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IA2ClD;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,CAAC;IAC7D,eAAe,CACpB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EACxB,QAAQ,EAAE,WAAW,CAAC,SAAS,CAAC,GAC/B,OAAO,CAAC,aAAa,CAAC;IA0CzB;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAa5C;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAc3C;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAc9C;;;;OAIG;IACU,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IACjD,iBAAiB,CAC5B,QAAQ,EAAE,WAAW,CAAC,mBAAmB,CAAC,GACzC,OAAO,CAAC,aAAa,CAAC;IAsCzB;;;;;OAKG;IACU,aAAa,CACxB,IAAI,GAAE;QACJ,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,CAAC,EAAE,SAAS,CAAC;KACI,GACvB,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAiC5B;;OAEG;IACU,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmBjE;;;;OAIG;IACU,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAMtD;;;;OAIG;IACU,iBAAiB,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAYlD;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAC7B,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA4B9E;;;;;;OAMG;IACU,UAAU,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAkBhF;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAgE5D;;;;OAIG;IACU,sBAAsB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAgD7D;;;;OAIG;IACI,0BAA0B,IAAI,OAAO,CAAC,OAAO,CAAC;IAC9C,0BAA0B,CAAC,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA8BzF;;;;;OAKG;IACU,uBAAuB,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAiD1E;;;;OAIG;IACU,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;IACtD,oBAAoB,CAC/B,QAAQ,EAAE,WAAW,CAAC,mBAAmB,EAAE,CAAC,GAC3C,OAAO,CAAC,aAAa,CAAC;IAiCzB;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAUvC;;OAEG;IACI,OAAO,IAAI,MAAM;CAGzB"}