@polymeshassociation/polymesh-sdk 14.0.0-beta.11

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

@@ -0,0 +1 @@
+{"version":3,"file":"Settlements.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Settlements.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAIrC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,0BAAmB;AAC9C,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,cAAc,EAAE,uBAAgB;AAc3E;;GAEG;AACH,qBAAa,WAAY,SAAQ,SAAS,CAAC,KAAK,CAAC;IAC/C;;;;;;;;;;;;;OAaG;IACU,SAAS,CAAC,IAAI,EAAE;QAC3B,IAAI,CAAC,EAAE,aAAa,CAAC;QACrB,EAAE,EAAE,aAAa,CAAC;QAClB,MAAM,EAAE,SAAS,CAAC;KACnB,GAAG,OAAO,CAAC,cAAc,CAAC;IAkD3B;;;;;;;;;;;;;;OAcG;IACU,WAAW,CAAC,IAAI,EAAE;QAC7B,IAAI,CAAC,EAAE,aAAa,CAAC;QACrB,EAAE,EAAE,aAAa,CAAC;QAClB,MAAM,EAAE,SAAS,CAAC;KACnB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CA2C/B"}

package/api/entities/Asset/Settlements.js

@@ -0,0 +1,108 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Settlements = void 0;
+const utils_1 = require("../../procedures/utils");
+const internal_1 = require("../../../internal");
+const constants_1 = require("../../../utils/constants");
+const conversion_1 = require("../../../utils/conversion");
+/**
+ * Handles all Asset Settlements related functionality
+ */
+class Settlements extends internal_1.Namespace {
+    /**
+     * Check whether it is possible to create a settlement Instruction to transfer a certain amount of this Asset's tokens between two Portfolios.
+     *
+     * @note this takes locked tokens into account. For example, if portfolio A has 1000 tokens and this function is called to check if 700 of them can be
+     *   transferred to portfolio B (assuming everything else checks out) the result will be success. If an instruction is created and authorized to transfer those 700 tokens,
+     *   they would become locked. From that point, further calls to this function would yield failed results because of the funds being locked, even though they haven't been
+     *   transferred yet
+     *
+     * @param args.from - sender Portfolio (optional, defaults to the signing Identity's Default Portfolio)
+     * @param args.to - receiver Portfolio
+     * @param args.amount - amount of tokens to transfer
+     *
+     * @deprecated in favor of {@link canTransfer}
+     */
+    canSettle(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { parent: { ticker }, context: { polymeshApi: { rpc }, }, context, parent, } = this;
+            const { to, amount } = args;
+            let { from } = args;
+            let isDivisible;
+            if (!from) {
+                [{ isDivisible }, from] = yield Promise.all([parent.details(), context.getSigningIdentity()]);
+            }
+            else {
+                ({ isDivisible } = yield parent.details());
+            }
+            /*
+             * The RPC requires a sender Account ID (although it's not being used at the moment). We use a dummy Account (Alice's in testnet)
+             */
+            const senderAddress = constants_1.DUMMY_ACCOUNT_ID;
+            const fromPortfolioId = (0, conversion_1.portfolioLikeToPortfolioId)(from);
+            const toPortfolioId = (0, conversion_1.portfolioLikeToPortfolioId)(to);
+            const fromPortfolio = (0, conversion_1.portfolioIdToPortfolio)(fromPortfolioId, context);
+            const toPortfolio = (0, conversion_1.portfolioIdToPortfolio)(toPortfolioId, context);
+            const [, , fromCustodian, toCustodian] = yield Promise.all([
+                (0, utils_1.assertPortfolioExists)(fromPortfolioId, context),
+                (0, utils_1.assertPortfolioExists)(toPortfolioId, context),
+                fromPortfolio.getCustodian(),
+                toPortfolio.getCustodian(),
+            ]);
+            const res = yield rpc.asset.canTransfer((0, conversion_1.stringToAccountId)(senderAddress, context), (0, conversion_1.stringToIdentityId)(fromCustodian.did, context), (0, conversion_1.portfolioIdToMeshPortfolioId)(fromPortfolioId, context), (0, conversion_1.stringToIdentityId)(toCustodian.did, context), (0, conversion_1.portfolioIdToMeshPortfolioId)(toPortfolioId, context), (0, conversion_1.stringToTicker)(ticker, context), (0, conversion_1.bigNumberToBalance)(amount, context, isDivisible));
+            return (0, conversion_1.canTransferResultToTransferStatus)(res);
+        });
+    }
+    /**
+     * Check whether it is possible to create a settlement instruction to transfer a certain amount of this asset between two Portfolios. Returns a breakdown of
+     *   the transaction containing general errors (such as insufficient balance or invalid receiver), any broken transfer restrictions, and any compliance
+     *   failures
+     *
+     * @note this takes locked tokens into account. For example, if portfolio A has 1000 tokens and this function is called to check if 700 of them can be
+     *   transferred to portfolio B (assuming everything else checks out) the result will be success. If an instruction is created and authorized to transfer those 700 tokens,
+     *   they would become locked. From that point, further calls to this function would yield failed results because of the funds being locked, even though they haven't been
+     *   transferred yet
+     *
+     * @param args.from - sender Portfolio (optional, defaults to the signing Identity's Default Portfolio)
+     * @param args.to - receiver Portfolio
+     * @param args.amount - amount of tokens to transfer
+     *
+     */
+    canTransfer(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { parent: { ticker }, context: { polymeshApi: { rpc }, }, context, parent, } = this;
+            const { to, amount } = args;
+            let { from } = args;
+            let isDivisible;
+            if (!from) {
+                [{ isDivisible }, from] = yield Promise.all([parent.details(), context.getSigningIdentity()]);
+            }
+            else {
+                ({ isDivisible } = yield parent.details());
+            }
+            const fromPortfolioId = (0, conversion_1.portfolioLikeToPortfolioId)(from);
+            const toPortfolioId = (0, conversion_1.portfolioLikeToPortfolioId)(to);
+            const fromPortfolio = (0, conversion_1.portfolioIdToPortfolio)(fromPortfolioId, context);
+            const toPortfolio = (0, conversion_1.portfolioIdToPortfolio)(toPortfolioId, context);
+            const [, , fromCustodian, toCustodian] = yield Promise.all([
+                (0, utils_1.assertPortfolioExists)(fromPortfolioId, context),
+                (0, utils_1.assertPortfolioExists)(toPortfolioId, context),
+                fromPortfolio.getCustodian(),
+                toPortfolio.getCustodian(),
+            ]);
+            const res = yield rpc.asset.canTransferGranular((0, conversion_1.stringToIdentityId)(fromCustodian.did, context), (0, conversion_1.portfolioIdToMeshPortfolioId)(fromPortfolioId, context), (0, conversion_1.stringToIdentityId)(toCustodian.did, context), (0, conversion_1.portfolioIdToMeshPortfolioId)(toPortfolioId, context), (0, conversion_1.stringToTicker)(ticker, context), (0, conversion_1.bigNumberToBalance)(amount, context, isDivisible));
+            return (0, conversion_1.granularCanTransferResultToTransferBreakdown)(res, context);
+        });
+    }
+}
+exports.Settlements = Settlements;
+//# sourceMappingURL=Settlements.js.map

package/api/entities/Asset/Settlements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Settlements.js","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Settlements.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,kDAA+D;AAC/D,gDAA8C;AAE9C,wDAAqD;AACrD,0DAU4B;AAE5B;;GAEG;AACH,MAAa,WAAY,SAAQ,oBAAgB;IAC/C;;;;;;;;;;;;;OAaG;IACU,SAAS,CAAC,IAItB;;YACC,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,GAAG,EAAE,GACrB,EACD,OAAO,EACP,MAAM,GACP,GAAG,IAAI,CAAC;YAET,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;YAC5B,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YACpB,IAAI,WAAW,CAAC;YAEhB,IAAI,CAAC,IAAI,EAAE;gBACT,CAAC,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;aAC/F;iBAAM;gBACL,CAAC,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;aAC5C;YAED;;eAEG;YACH,MAAM,aAAa,GAAG,4BAAgB,CAAC;YAEvC,MAAM,eAAe,GAAG,IAAA,uCAA0B,EAAC,IAAI,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,IAAA,uCAA0B,EAAC,EAAE,CAAC,CAAC;YACrD,MAAM,aAAa,GAAG,IAAA,mCAAsB,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YACvE,MAAM,WAAW,GAAG,IAAA,mCAAsB,EAAC,aAAa,EAAE,OAAO,CAAC,CAAC;YAEnE,MAAM,CAAC,EAAE,AAAD,EAAG,aAAa,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACzD,IAAA,6BAAqB,EAAC,eAAe,EAAE,OAAO,CAAC;gBAC/C,IAAA,6BAAqB,EAAC,aAAa,EAAE,OAAO,CAAC;gBAC7C,aAAa,CAAC,YAAY,EAAE;gBAC5B,WAAW,CAAC,YAAY,EAAE;aAC3B,CAAC,CAAC;YAEH,MAAM,GAAG,GAAsB,MAAM,GAAG,CAAC,KAAK,CAAC,WAAW,CACxD,IAAA,8BAAiB,EAAC,aAAa,EAAE,OAAO,CAAC,EACzC,IAAA,+BAAkB,EAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,EAC9C,IAAA,yCAA4B,EAAC,eAAe,EAAE,OAAO,CAAC,EACtD,IAAA,+BAAkB,EAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,EAC5C,IAAA,yCAA4B,EAAC,aAAa,EAAE,OAAO,CAAC,EACpD,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAA,+BAAkB,EAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CACjD,CAAC;YAEF,OAAO,IAAA,8CAAiC,EAAC,GAAG,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACU,WAAW,CAAC,IAIxB;;YACC,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,GAAG,EAAE,GACrB,EACD,OAAO,EACP,MAAM,GACP,GAAG,IAAI,CAAC;YAET,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;YAC5B,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YACpB,IAAI,WAAW,CAAC;YAEhB,IAAI,CAAC,IAAI,EAAE;gBACT,CAAC,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;aAC/F;iBAAM;gBACL,CAAC,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;aAC5C;YAED,MAAM,eAAe,GAAG,IAAA,uCAA0B,EAAC,IAAI,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,IAAA,uCAA0B,EAAC,EAAE,CAAC,CAAC;YACrD,MAAM,aAAa,GAAG,IAAA,mCAAsB,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YACvE,MAAM,WAAW,GAAG,IAAA,mCAAsB,EAAC,aAAa,EAAE,OAAO,CAAC,CAAC;YAEnE,MAAM,CAAC,EAAE,AAAD,EAAG,aAAa,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACzD,IAAA,6BAAqB,EAAC,eAAe,EAAE,OAAO,CAAC;gBAC/C,IAAA,6BAAqB,EAAC,aAAa,EAAE,OAAO,CAAC;gBAC7C,aAAa,CAAC,YAAY,EAAE;gBAC5B,WAAW,CAAC,YAAY,EAAE;aAC3B,CAAC,CAAC;YAEH,MAAM,GAAG,GAA8B,MAAM,GAAG,CAAC,KAAK,CAAC,mBAAmB,CACxE,IAAA,+BAAkB,EAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,EAC9C,IAAA,yCAA4B,EAAC,eAAe,EAAE,OAAO,CAAC,EACtD,IAAA,+BAAkB,EAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,EAC5C,IAAA,yCAA4B,EAAC,aAAa,EAAE,OAAO,CAAC,EACpD,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAA,+BAAkB,EAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CACjD,CAAC;YAEF,OAAO,IAAA,yDAA4C,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC;KAAA;CACF;AAnID,kCAmIC"}

package/api/entities/Asset/TransferRestrictions/Count.d.ts

@@ -0,0 +1,36 @@
+import BigNumber from 'bignumber.js';
+import { AddCountTransferRestrictionParams, SetCountTransferRestrictionsParams, TransferRestrictionBase } from "../../../../internal";
+import { ActiveTransferRestrictions, CountTransferRestriction, NoArgsProcedureMethod, ProcedureMethod, TransferRestrictionType } from "../../../../types";
+/**
+ * Handles all Count Transfer Restriction related functionality
+ */
+export declare class Count extends TransferRestrictionBase<TransferRestrictionType.Count> {
+    protected type: TransferRestrictionType.Count;
+    /**
+     * Add a Count Transfer Restriction to this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    addRestriction: ProcedureMethod<Omit<AddCountTransferRestrictionParams, 'type'>, BigNumber>;
+    /**
+     * Sets all Count Transfer Restrictions on this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    setRestrictions: ProcedureMethod<Omit<SetCountTransferRestrictionsParams, 'type'>, BigNumber>;
+    /**
+     * Removes all Count Transfer Restrictions from this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    removeRestrictions: NoArgsProcedureMethod<BigNumber>;
+    /**
+     * Retrieve all active Count Transfer Restrictions
+     *
+     * @note there is a maximum number of restrictions allowed across all types.
+     *   The `availableSlots` property of the result represents how many more restrictions can be added
+     *   before reaching that limit
+     */
+    get: () => Promise<ActiveTransferRestrictions<CountTransferRestriction>>;
+}
+//# sourceMappingURL=Count.d.ts.map

package/api/entities/Asset/TransferRestrictions/Count.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Count.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/Count.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,iCAAiC,EACjC,kCAAkC,EAClC,uBAAuB,EACxB,6BAAmB;AACpB,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,qBAAqB,EACrB,eAAe,EACf,uBAAuB,EACxB,0BAAgB;AAEjB;;GAEG;AACH,qBAAa,KAAM,SAAQ,uBAAuB,CAAC,uBAAuB,CAAC,KAAK,CAAC;IAC/E,SAAS,CAAC,IAAI,gCAA0C;IAExD;;;;OAIG;IACY,cAAc,EAAE,eAAe,CAC5C,IAAI,CAAC,iCAAiC,EAAE,MAAM,CAAC,EAC/C,SAAS,CACV,CAAC;IAEF;;;;OAIG;IACY,eAAe,EAAE,eAAe,CAC7C,IAAI,CAAC,kCAAkC,EAAE,MAAM,CAAC,EAChD,SAAS,CACV,CAAC;IAEF;;;;OAIG;IACY,kBAAkB,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAEpE;;;;;;OAMG;IACY,GAAG,EAAE,MAAM,OAAO,CAAC,0BAA0B,CAAC,wBAAwB,CAAC,CAAC,CAAC;CACzF"}

package/api/entities/Asset/TransferRestrictions/Count.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Count = void 0;
+const internal_1 = require("../../../../internal");
+const types_1 = require("../../../../types");
+/**
+ * Handles all Count Transfer Restriction related functionality
+ */
+class Count extends internal_1.TransferRestrictionBase {
+    constructor() {
+        super(...arguments);
+        this.type = types_1.TransferRestrictionType.Count;
+    }
+}
+exports.Count = Count;
+//# sourceMappingURL=Count.js.map

package/api/entities/Asset/TransferRestrictions/Count.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Count.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/Count.ts"],"names":[],"mappings":";;;AAEA,mDAIoB;AACpB,6CAMiB;AAEjB;;GAEG;AACH,MAAa,KAAM,SAAQ,kCAAsD;IAAjF;;QACY,SAAI,GAAG,+BAAuB,CAAC,KAAc,CAAC;IAqC1D,CAAC;CAAA;AAtCD,sBAsCC"}

package/api/entities/Asset/TransferRestrictions/Percentage.d.ts

@@ -0,0 +1,36 @@
+import BigNumber from 'bignumber.js';
+import { AddPercentageTransferRestrictionParams, SetPercentageTransferRestrictionsParams, TransferRestrictionBase } from "../../../../internal";
+import { ActiveTransferRestrictions, NoArgsProcedureMethod, PercentageTransferRestriction, ProcedureMethod, TransferRestrictionType } from "../../../../types";
+/**
+ * Handles all Percentage Transfer Restriction related functionality
+ */
+export declare class Percentage extends TransferRestrictionBase<TransferRestrictionType.Percentage> {
+    protected type: TransferRestrictionType.Percentage;
+    /**
+     * Add a Percentage Transfer Restriction to this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    addRestriction: ProcedureMethod<Omit<AddPercentageTransferRestrictionParams, 'type'>, BigNumber>;
+    /**
+     * Sets all Percentage Transfer Restrictions on this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    setRestrictions: ProcedureMethod<Omit<SetPercentageTransferRestrictionsParams, 'type'>, BigNumber>;
+    /**
+     * Removes all Percentage Transfer Restrictions from this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    removeRestrictions: NoArgsProcedureMethod<BigNumber>;
+    /**
+     * Retrieve all active Percentage Transfer Restrictions
+     *
+     * @note there is a maximum number of restrictions allowed across all types.
+     *   The `availableSlots` property of the result represents how many more restrictions can be added
+     *   before reaching that limit
+     */
+    get: () => Promise<ActiveTransferRestrictions<PercentageTransferRestriction>>;
+}
+//# sourceMappingURL=Percentage.d.ts.map

package/api/entities/Asset/TransferRestrictions/Percentage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Percentage.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/Percentage.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,sCAAsC,EACtC,uCAAuC,EACvC,uBAAuB,EACxB,6BAAmB;AACpB,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,6BAA6B,EAC7B,eAAe,EACf,uBAAuB,EACxB,0BAAgB;AAEjB;;GAEG;AACH,qBAAa,UAAW,SAAQ,uBAAuB,CAAC,uBAAuB,CAAC,UAAU,CAAC;IACzF,SAAS,CAAC,IAAI,qCAA+C;IAE7D;;;;OAIG;IACY,cAAc,EAAE,eAAe,CAC5C,IAAI,CAAC,sCAAsC,EAAE,MAAM,CAAC,EACpD,SAAS,CACV,CAAC;IAEF;;;;OAIG;IACY,eAAe,EAAE,eAAe,CAC7C,IAAI,CAAC,uCAAuC,EAAE,MAAM,CAAC,EACrD,SAAS,CACV,CAAC;IAEF;;;;OAIG;IACY,kBAAkB,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAEpE;;;;;;OAMG;IACY,GAAG,EAAE,MAAM,OAAO,CAAC,0BAA0B,CAAC,6BAA6B,CAAC,CAAC,CAAC;CAC9F"}

package/api/entities/Asset/TransferRestrictions/Percentage.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Percentage = void 0;
+const internal_1 = require("../../../../internal");
+const types_1 = require("../../../../types");
+/**
+ * Handles all Percentage Transfer Restriction related functionality
+ */
+class Percentage extends internal_1.TransferRestrictionBase {
+    constructor() {
+        super(...arguments);
+        this.type = types_1.TransferRestrictionType.Percentage;
+    }
+}
+exports.Percentage = Percentage;
+//# sourceMappingURL=Percentage.js.map

package/api/entities/Asset/TransferRestrictions/Percentage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Percentage.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/Percentage.ts"],"names":[],"mappings":";;;AAEA,mDAIoB;AACpB,6CAMiB;AAEjB;;GAEG;AACH,MAAa,UAAW,SAAQ,kCAA2D;IAA3F;;QACY,SAAI,GAAG,+BAAuB,CAAC,UAAmB,CAAC;IAqC/D,CAAC;CAAA;AAtCD,gCAsCC"}

package/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.d.ts

@@ -0,0 +1,44 @@
+import BigNumber from 'bignumber.js';
+import { AddCountTransferRestrictionParams, AddPercentageTransferRestrictionParams, Asset, Context, Namespace, SetCountTransferRestrictionsParams, SetPercentageTransferRestrictionsParams } from "../../../../internal";
+import { ActiveTransferRestrictions, CountTransferRestriction, NoArgsProcedureMethod, PercentageTransferRestriction, ProcedureMethod, TransferRestrictionType } from "../../../../types";
+declare type AddRestrictionParams<T> = Omit<T extends TransferRestrictionType.Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, 'type'>;
+declare type SetRestrictionsParams<T> = Omit<T extends TransferRestrictionType.Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, 'type'>;
+declare type GetReturnType<T> = ActiveTransferRestrictions<T extends TransferRestrictionType.Count ? CountTransferRestriction : PercentageTransferRestriction>;
+/**
+ * Base class for managing Transfer Restrictions
+ */
+export declare abstract class TransferRestrictionBase<T extends TransferRestrictionType> extends Namespace<Asset> {
+    protected abstract type: T;
+    /**
+     * @hidden
+     */
+    constructor(parent: Asset, context: Context);
+    /**
+     * Add a Transfer Restriction of the corresponding type to this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    addRestriction: ProcedureMethod<AddRestrictionParams<T>, BigNumber>;
+    /**
+     * Sets all Transfer Restrictions of the corresponding type on this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    setRestrictions: ProcedureMethod<SetRestrictionsParams<T>, BigNumber>;
+    /**
+     * Removes all Transfer Restrictions of the corresponding type from this Asset
+     *
+     * @note the result is the total amount of restrictions after the procedure has run
+     */
+    removeRestrictions: NoArgsProcedureMethod<BigNumber>;
+    /**
+     * Retrieve all active Transfer Restrictions of the corresponding type
+     *
+     * @note there is a maximum number of restrictions allowed across all types.
+     *   The `availableSlots` property of the result represents how many more restrictions can be added
+     *   before reaching that limit
+     */
+    get(): Promise<GetReturnType<T>>;
+}
+export {};
+//# sourceMappingURL=TransferRestrictionBase.d.ts.map

package/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransferRestrictionBase.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,iCAAiC,EACjC,sCAAsC,EAGtC,KAAK,EACL,OAAO,EACP,SAAS,EACT,kCAAkC,EAClC,uCAAuC,EAIxC,6BAAmB;AACpB,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,qBAAqB,EACrB,6BAA6B,EAC7B,eAAe,EACf,uBAAuB,EACxB,0BAAgB;AASjB,aAAK,oBAAoB,CAAC,CAAC,IAAI,IAAI,CACjC,CAAC,SAAS,uBAAuB,CAAC,KAAK,GACnC,iCAAiC,GACjC,sCAAsC,EAC1C,MAAM,CACP,CAAC;AAEF,aAAK,qBAAqB,CAAC,CAAC,IAAI,IAAI,CAClC,CAAC,SAAS,uBAAuB,CAAC,KAAK,GACnC,kCAAkC,GAClC,uCAAuC,EAC3C,MAAM,CACP,CAAC;AAEF,aAAK,aAAa,CAAC,CAAC,IAAI,0BAA0B,CAChD,CAAC,SAAS,uBAAuB,CAAC,KAAK,GAAG,wBAAwB,GAAG,6BAA6B,CACnG,CAAC;AAEF;;GAEG;AACH,8BAAsB,uBAAuB,CAC3C,CAAC,SAAS,uBAAuB,CACjC,SAAQ,SAAS,CAAC,KAAK,CAAC;IACxB,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAE3B;;OAEG;gBACS,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO;IAsD3C;;;;OAIG;IACI,cAAc,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IAE3E;;;;OAIG;IACI,eAAe,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IAE7E;;;;OAIG;IACI,kBAAkB,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAE5D;;;;;;OAMG;IACU,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAgE9C"}

package/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.js

@@ -0,0 +1,99 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransferRestrictionBase = void 0;
+const internal_1 = require("../../../../internal");
+const types_1 = require("../../../../types");
+const conversion_1 = require("../../../../utils/conversion");
+const internal_2 = require("../../../../utils/internal");
+/**
+ * Base class for managing Transfer Restrictions
+ */
+class TransferRestrictionBase extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        const { ticker } = parent;
+        this.addRestriction = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.addTransferRestriction,
+                Object.assign(Object.assign({}, args), { type: this.type, ticker }),
+            ],
+        }, context);
+        this.setRestrictions = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.setTransferRestrictions,
+                Object.assign(Object.assign({}, args), { type: this.type, ticker }),
+            ],
+        }, context);
+        this.removeRestrictions = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: () => [
+                internal_1.setTransferRestrictions,
+                {
+                    restrictions: [],
+                    type: this.type,
+                    ticker,
+                },
+            ],
+            voidArgs: true,
+        }, context);
+    }
+    /**
+     * Retrieve all active Transfer Restrictions of the corresponding type
+     *
+     * @note there is a maximum number of restrictions allowed across all types.
+     *   The `availableSlots` property of the result represents how many more restrictions can be added
+     *   before reaching that limit
+     */
+    get() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { parent: { ticker }, context: { polymeshApi: { query: { statistics }, consts, }, }, context, type, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const activeTms = yield statistics.activeTransferManagers(rawTicker);
+            const filteredTms = activeTms.filter(tm => {
+                if (type === types_1.TransferRestrictionType.Count) {
+                    return tm.isCountTransferManager;
+                }
+                return tm.isPercentageTransferManager;
+            });
+            const rawExemptedLists = yield Promise.all(filteredTms.map(tm => statistics.exemptEntities.entries([rawTicker, tm])));
+            const restrictions = rawExemptedLists.map((list, index) => {
+                const exemptedIds = list.map(([{ args: [, scopeId], },]) => (0, conversion_1.scopeIdToString)(scopeId) // `ScopeId` and `IdentityId` are the same type, so this is fine
+                );
+                const { value } = (0, conversion_1.transferManagerToTransferRestriction)(filteredTms[index]);
+                let restriction;
+                if (type === types_1.TransferRestrictionType.Count) {
+                    restriction = {
+                        count: value,
+                    };
+                }
+                else {
+                    restriction = {
+                        percentage: value,
+                    };
+                }
+                if (exemptedIds.length) {
+                    return Object.assign(Object.assign({}, restriction), { exemptedIds });
+                }
+                return restriction;
+            });
+            const maxTransferManagers = (0, conversion_1.u32ToBigNumber)(consts.statistics.maxTransferManagersPerAsset);
+            return {
+                restrictions,
+                availableSlots: maxTransferManagers.minus(activeTms.length),
+            };
+        });
+    }
+}
+exports.TransferRestrictionBase = TransferRestrictionBase;
+//# sourceMappingURL=TransferRestrictionBase.js.map

package/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransferRestrictionBase.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,mDAaoB;AACpB,6CAOiB;AACjB,6DAK4B;AAC5B,yDAAyD;AAoBzD;;GAEG;AACH,MAAsB,uBAEpB,SAAQ,oBAAgB;IAGxB;;OAEG;IACH,YAAY,MAAa,EAAE,OAAgB;QACzC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEvB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAE1B,IAAI,CAAC,cAAc,GAAG,IAAA,gCAAqB,EAKzC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,iCAAsB;gBACtB,gCAAK,IAAI,KAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,GAA6C;aAChF;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,eAAe,GAAG,IAAA,gCAAqB,EAM1C;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,kCAAuB;gBACvB,gCAAK,IAAI,KAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,GAA8C;aACjF;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,kBAAkB,GAAG,IAAA,gCAAqB,EAK7C;YACE,mBAAmB,EAAE,GAAG,EAAE,CAAC;gBACzB,kCAAuB;gBACvB;oBACE,YAAY,EAAE,EAAE;oBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,MAAM;iBACqC;aAC9C;YACD,QAAQ,EAAE,IAAI;SACf,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAuBD;;;;;;OAMG;IACU,GAAG;;YACd,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,UAAU,EAAE,EACrB,MAAM,GACP,GACF,EACD,OAAO,EACP,IAAI,GACL,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;YACrE,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;gBACxC,IAAI,IAAI,KAAK,+BAAuB,CAAC,KAAK,EAAE;oBAC1C,OAAO,EAAE,CAAC,sBAAsB,CAAC;iBAClC;gBAED,OAAO,EAAE,CAAC,2BAA2B,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,GAAG,CACxC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAC1E,CAAC;YAEF,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBACxD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAC1B,CAAC,CACC,EACE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,GAClB,EACF,EAAE,EAAE,CAAC,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC,gEAAgE;iBAChG,CAAC;gBACF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,iDAAoC,EAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC3E,IAAI,WAAW,CAAC;gBAEhB,IAAI,IAAI,KAAK,+BAAuB,CAAC,KAAK,EAAE;oBAC1C,WAAW,GAAG;wBACZ,KAAK,EAAE,KAAK;qBACb,CAAC;iBACH;qBAAM;oBACL,WAAW,GAAG;wBACZ,UAAU,EAAE,KAAK;qBAClB,CAAC;iBACH;gBAED,IAAI,WAAW,CAAC,MAAM,EAAE;oBACtB,uCACK,WAAW,KACd,WAAW,IACX;iBACH;gBACD,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,MAAM,mBAAmB,GAAG,IAAA,2BAAc,EAAC,MAAM,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;YAE1F,OAAO;gBACL,YAAY;gBACZ,cAAc,EAAE,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC;aACxC,CAAC;QACxB,CAAC;KAAA;CACF;AA1JD,0DA0JC"}

package/api/entities/Asset/TransferRestrictions/index.d.ts

@@ -0,0 +1,15 @@
+import { Asset, Context, Namespace } from "../../../../internal";
+import { Count } from './Count';
+import { Percentage } from './Percentage';
+/**
+ * Handles all Asset Transfer Restrictions related functionality
+ */
+export declare class TransferRestrictions extends Namespace<Asset> {
+    count: Count;
+    percentage: Percentage;
+    /**
+     * @hidden
+     */
+    constructor(parent: Asset, context: Context);
+}
+//# sourceMappingURL=index.d.ts.map

package/api/entities/Asset/TransferRestrictions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,6BAAmB;AAEvD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,SAAS,CAAC,KAAK,CAAC;IACjD,KAAK,EAAE,KAAK,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IAE9B;;OAEG;gBACS,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO;CAM5C"}

package/api/entities/Asset/TransferRestrictions/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransferRestrictions = void 0;
+const internal_1 = require("../../../../internal");
+const Count_1 = require("./Count");
+const Percentage_1 = require("./Percentage");
+/**
+ * Handles all Asset Transfer Restrictions related functionality
+ */
+class TransferRestrictions extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        this.count = new Count_1.Count(parent, context);
+        this.percentage = new Percentage_1.Percentage(parent, context);
+    }
+}
+exports.TransferRestrictions = TransferRestrictions;
+//# sourceMappingURL=index.js.map

package/api/entities/Asset/TransferRestrictions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/TransferRestrictions/index.ts"],"names":[],"mappings":";;;AAAA,mDAAuD;AAEvD,mCAAgC;AAChC,6CAA0C;AAE1C;;GAEG;AACH,MAAa,oBAAqB,SAAQ,oBAAgB;IAIxD;;OAEG;IACH,YAAY,MAAa,EAAE,OAAgB;QACzC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEvB,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;CACF;AAbD,oDAaC"}

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

@@ -0,0 +1,166 @@
+import BigNumber from 'bignumber.js';
+import { AuthorizationRequest, Context, ControllerTransferParams, Entity, ModifyAssetParams, ModifyPrimaryIssuanceAgentParams, RedeemTokensParams, TransferAssetOwnershipParams } from "../../../internal";
+import { EventIdentifier, HistoricAgentOperation, NoArgsProcedureMethod, ProcedureMethod, SecurityIdentifier, SubCallback, UnsubCallback } from "../../../types";
+import { AssetHolders } from './AssetHolders';
+import { Checkpoints } from './Checkpoints';
+import { Compliance } from './Compliance';
+import { CorporateActions } from './CorporateActions';
+import { Documents } from './Documents';
+import { Issuance } from './Issuance';
+import { Offerings } from './Offerings';
+import { Permissions } from './Permissions';
+import { Settlements } from './Settlements';
+import { TransferRestrictions } from './TransferRestrictions';
+import { AssetDetails } from './types';
+/**
+ * Properties that uniquely identify an Asset
+ */
+export interface UniqueIdentifiers {
+    /**
+     * ticker of the Asset
+     */
+    ticker: string;
+}
+/**
+ * Class used to manage all Asset functionality
+ */
+export declare class Asset extends Entity<UniqueIdentifiers, string> {
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier: unknown): identifier is UniqueIdentifiers;
+    /**
+     * Identity ID of the Asset (used for Claims)
+     */
+    did: string;
+    /**
+     * ticker of the Asset
+     */
+    ticker: string;
+    documents: Documents;
+    settlements: Settlements;
+    assetHolders: AssetHolders;
+    issuance: Issuance;
+    compliance: Compliance;
+    transferRestrictions: TransferRestrictions;
+    offerings: Offerings;
+    checkpoints: Checkpoints;
+    corporateActions: CorporateActions;
+    permissions: Permissions;
+    /**
+     * @hidden
+     */
+    constructor(identifiers: UniqueIdentifiers, context: Context);
+    /**
+     * Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted
+     *   by the recipient
+     *
+     * @note this will create {@link AuthorizationRequest | Authorization Request} which has to be accepted by the `target` Identity.
+     *   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}
+     */
+    transferOwnership: ProcedureMethod<TransferAssetOwnershipParams, AuthorizationRequest>;
+    /**
+     * Modify some properties of the Asset
+     *
+     * @throws if the passed values result in no changes being made to the Asset
+     */
+    modify: ProcedureMethod<ModifyAssetParams, Asset>;
+    /**
+     * Retrieve the Asset's data
+     *
+     * @note can be subscribed to
+     */
+    details(): Promise<AssetDetails>;
+    details(callback: SubCallback<AssetDetails>): Promise<UnsubCallback>;
+    /**
+     * Retrieve the Asset's funding round
+     *
+     * @note can be subscribed to
+     */
+    currentFundingRound(): Promise<string | null>;
+    currentFundingRound(callback: SubCallback<string | null>): Promise<UnsubCallback>;
+    /**
+     * Retrieve the Asset's identifiers list
+     *
+     * @note can be subscribed to
+     */
+    getIdentifiers(): Promise<SecurityIdentifier[]>;
+    getIdentifiers(callback?: SubCallback<SecurityIdentifier[]>): Promise<UnsubCallback>;
+    /**
+     * Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created
+     *
+     * @note uses the middleware
+     * @note there is a possibility that the data is not ready by the time it is requested. In that case, `null` is returned
+     */
+    createdAt(): Promise<EventIdentifier | null>;
+    /**
+     * Freeze transfers of the Asset
+     */
+    freeze: NoArgsProcedureMethod<Asset>;
+    /**
+     * Unfreeze transfers of the Asset
+     */
+    unfreeze: NoArgsProcedureMethod<Asset>;
+    /**
+     * Check whether transfers are frozen for the Asset
+     *
+     * @note can be subscribed to
+     */
+    isFrozen(): Promise<boolean>;
+    isFrozen(callback: SubCallback<boolean>): Promise<UnsubCallback>;
+    /**
+     * Assign a new primary issuance agent for the Asset
+     *
+     * @note this will create an {@link AuthorizationRequest | Authorization Request} which has to be accepted by the `target` Identity.
+     *   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}
+     *
+     * @deprecated in favor of `inviteAgent`
+     */
+    modifyPrimaryIssuanceAgent: ProcedureMethod<ModifyPrimaryIssuanceAgentParams, void>;
+    /**
+     * Remove the primary issuance agent of the Asset
+     *
+     * @note if primary issuance agent is not set, Asset owner would be used by default
+     *
+     * @deprecated
+     */
+    removePrimaryIssuanceAgent: NoArgsProcedureMethod<void>;
+    /**
+     * Redeem (burn) an amount of this Asset's tokens
+     *
+     * @note tokens are removed from the caller's Default Portfolio
+     */
+    redeem: ProcedureMethod<RedeemTokensParams, void>;
+    /**
+     * Retrieve the amount of unique investors that hold this Asset
+     *
+     * @note this takes into account the Scope ID of Investor Uniqueness Claims. If an investor holds balances
+     *   of this Asset in two or more different Identities, but they all have Investor Uniqueness Claims with the same
+     *   Scope ID, then they will only be counted once for the purposes of this result
+     */
+    investorCount(): Promise<BigNumber>;
+    /**
+     * Force a transfer from a given Portfolio to the caller’s default Portfolio
+     */
+    controllerTransfer: ProcedureMethod<ControllerTransferParams, void>;
+    /**
+     * Retrieve this Asset's Operation History
+     *
+     * @note Operations are grouped by the agent Identity who performed them
+     *
+     * @note uses the middleware
+     */
+    getOperationHistory(): Promise<HistoricAgentOperation[]>;
+    /**
+     * Determine whether this Asset exists on chain
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Return the Asset's ticker
+     */
+    toHuman(): string;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/index.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,cAAc,CAAC;AAWrC,OAAO,EACL,oBAAoB,EACpB,OAAO,EAEP,wBAAwB,EACxB,MAAM,EAGN,iBAAiB,EAEjB,gCAAgC,EAEhC,kBAAkB,EAIlB,4BAA4B,EAC7B,0BAAmB;AAGpB,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,WAAW,EACX,aAAa,EACd,uBAAgB;AAqBjB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAC1D;;;OAGG;WACoB,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,iBAAiB;IAMhG;;OAEG;IACI,GAAG,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAC;IAGf,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,WAAW,EAAE,WAAW,CAAC;IAEhC;;OAEG;gBACS,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IA2D5D;;;;;;;OAOG;IACI,iBAAiB,EAAE,eAAe,CAAC,4BAA4B,EAAE,oBAAoB,CAAC,CAAC;IAC9F;;;;OAIG;IACI,MAAM,EAAE,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;IAEzD;;;;OAIG;IACI,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IAChC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA+F3E;;;;OAIG;IACI,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAC7C,mBAAmB,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IAgCxF;;;;OAIG;IACI,cAAc,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAC/C,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,kBAAkB,EAAE,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA8B3F;;;;;OAKG;IACU,SAAS,IAAI,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAgBzD;;OAEG;IACI,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAE5C;;OAEG;IACI,QAAQ,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAE9C;;;;OAIG;IACI,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA4BvE;;;;;;;;OAQG;IACI,0BAA0B,EAAE,eAAe,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;IAE3F;;;;;;OAMG;IACI,0BAA0B,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;OAIG;IACI,MAAM,EAAE,eAAe,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAEzD;;;;;;OAMG;IACU,aAAa,IAAI,OAAO,CAAC,SAAS,CAAC;IAkDhD;;OAEG;IACI,kBAAkB,EAAE,eAAe,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;IAE3E;;;;;;OAMG;IACU,mBAAmB,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;IA8ErE;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAUvC;;OAEG;IACI,OAAO,IAAI,MAAM;CAGzB"}