@polymeshassociation/polymesh-sdk 14.0.0-beta.11

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

@@ -0,0 +1,58 @@
+import { Asset, Context, Identity, ModifyCaDefaultConfigParams, ModifyCorporateActionsAgentParams, Namespace, RemoveCorporateActionParams } from "../../../../internal";
+import { NoArgsProcedureMethod, ProcedureMethod } from "../../../../types";
+import { Distributions } from './Distributions';
+import { CorporateActionDefaultConfig } from './types';
+/**
+ * Handles all Asset Corporate Actions related functionality
+ */
+export declare class CorporateActions extends Namespace<Asset> {
+    distributions: Distributions;
+    /**
+     * @hidden
+     */
+    constructor(parent: Asset, context: Context);
+    /**
+     * Assign default config values(targets, global tax withholding percentage and per-Identity tax withholding percentages)
+     *
+     * @note These config values are applied to every Corporate Action that is created until they are modified. Modifying these values
+     *   does not impact existing Corporate Actions.
+     *   When creating a Corporate Action, values passed explicitly will override these default config values
+     */
+    setDefaultConfig: ProcedureMethod<ModifyCaDefaultConfigParams, void>;
+    /**
+     * Assign a new Corporate Actions Agent for the Asset
+     *
+     * @note this may create {@link AuthorizationRequest | Authorization Requests} which have 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`
+     */
+    setAgent: ProcedureMethod<ModifyCorporateActionsAgentParams, void>;
+    /**
+     * Remove the Corporate Actions Agent of the Asset
+     *
+     * @note this action will leave the Asset owner as the Corporate Actions Agent
+     *
+     * @deprecated
+     */
+    removeAgent: NoArgsProcedureMethod<void>;
+    /**
+     * Remove a Corporate Action
+     */
+    remove: ProcedureMethod<RemoveCorporateActionParams, void>;
+    /**
+     * Retrieve a list of agent Identities
+     */
+    getAgents(): Promise<Identity[]>;
+    /**
+     * Retrieve default config comprising of targets, global tax withholding percentage and per-Identity tax withholding percentages.
+     *
+     *
+     * @note This config is applied to every Corporate Action that is created until they are modified. Modifying the default config
+     *   does not impact existing Corporate Actions.
+     *   When creating a Corporate Action, values passed explicitly will override this default config
+     */
+    getDefaultConfig(): Promise<CorporateActionDefaultConfig>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/CorporateActions/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,EACL,OAAO,EACP,QAAQ,EAER,2BAA2B,EAE3B,iCAAiC,EACjC,SAAS,EAET,2BAA2B,EAE5B,6BAAmB;AACpB,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,0BAAgB;AAUjE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,SAAS,CAAC,KAAK,CAAC;IAC7C,aAAa,EAAE,aAAa,CAAC;IAEpC;;OAEG;gBACS,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO;IA4B3C;;;;;;OAMG;IACI,gBAAgB,EAAE,eAAe,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACI,QAAQ,EAAE,eAAe,CAAC,iCAAiC,EAAE,IAAI,CAAC,CAAC;IAE1E;;;;;;OAMG;IACI,WAAW,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEhD;;OAEG;IACI,MAAM,EAAE,eAAe,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;IAElE;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IA2B7C;;;;;;;OAOG;IACU,gBAAgB,IAAI,OAAO,CAAC,4BAA4B,CAAC;CAyCvE"}

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

@@ -0,0 +1,85 @@
+"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.CorporateActions = void 0;
+const internal_1 = require("../../../../internal");
+const conversion_1 = require("../../../../utils/conversion");
+const internal_2 = require("../../../../utils/internal");
+const Distributions_1 = require("./Distributions");
+/**
+ * Handles all Asset Corporate Actions related functionality
+ */
+class CorporateActions extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        const { ticker } = parent;
+        this.distributions = new Distributions_1.Distributions(parent, context);
+        this.setDefaultConfig = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.modifyCaDefaultConfig, Object.assign({ ticker }, args)] }, context);
+        this.setAgent = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.modifyCorporateActionsAgent, Object.assign({ ticker }, args)] }, context);
+        this.removeAgent = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: () => [internal_1.removeCorporateActionsAgent, { ticker }], voidArgs: true }, context);
+        this.remove = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.removeCorporateAction, Object.assign({ ticker }, args)] }, context);
+    }
+    /**
+     * Retrieve a list of agent Identities
+     */
+    getAgents() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { externalAgents }, }, }, parent: { ticker }, context, } = this;
+            const groupOfAgent = yield externalAgents.groupOfAgent.entries((0, conversion_1.stringToTicker)(ticker, context));
+            const agentIdentities = [];
+            groupOfAgent.forEach(([storageKey, agentGroup]) => {
+                const rawAgentGroup = agentGroup.unwrap();
+                if (rawAgentGroup.isPolymeshV1Caa) {
+                    agentIdentities.push(new internal_1.Identity({ did: (0, conversion_1.identityIdToString)(storageKey.args[1]) }, context));
+                }
+            });
+            return agentIdentities;
+        });
+    }
+    /**
+     * Retrieve default config comprising of targets, global tax withholding percentage and per-Identity tax withholding percentages.
+     *
+     *
+     * @note This config is applied to every Corporate Action that is created until they are modified. Modifying the default config
+     *   does not impact existing Corporate Actions.
+     *   When creating a Corporate Action, values passed explicitly will override this default config
+     */
+    getDefaultConfig() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { parent: { ticker }, context: { polymeshApi: { query: { corporateAction }, }, polymeshApi, }, context, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const [targets, defaultTaxWithholding, taxWithholdings] = yield polymeshApi.queryMulti([
+                [
+                    corporateAction.defaultTargetIdentities,
+                    rawTicker,
+                ],
+                [
+                    corporateAction.defaultWithholdingTax,
+                    rawTicker,
+                ],
+                [corporateAction.didWithholdingTax, rawTicker],
+            ]);
+            return {
+                targets: (0, conversion_1.targetIdentitiesToCorporateActionTargets)(targets, context),
+                defaultTaxWithholding: (0, conversion_1.permillToBigNumber)(defaultTaxWithholding),
+                taxWithholdings: taxWithholdings.map(([identity, tax]) => ({
+                    identity: new internal_1.Identity({ did: (0, conversion_1.identityIdToString)(identity) }, context),
+                    percentage: (0, conversion_1.permillToBigNumber)(tax),
+                })),
+            };
+        });
+    }
+}
+exports.CorporateActions = CorporateActions;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/CorporateActions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,mDAYoB;AAGpB,6DAK4B;AAC5B,yDAAyD;AAEzD,mDAAgD;AAGhD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,oBAAgB;IAGpD;;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,aAAa,GAAG,IAAI,6BAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAExD,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,gCAAqB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EAC7E,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,IAAA,gCAAqB,EACnC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,sCAA2B,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACnF,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAA,gCAAqB,EACtC,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,sCAA2B,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EACxF,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAA,gCAAqB,EACjC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,gCAAqB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EAC7E,OAAO,CACR,CAAC;IACJ,CAAC;IAoCD;;OAEG;IACU,SAAS;;YACpB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,cAAc,EAAE,GAC1B,GACF,EACD,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAEhG,MAAM,eAAe,GAAe,EAAE,CAAC;YAEvC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE;gBAChD,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC1C,IAAI,aAAa,CAAC,eAAe,EAAE;oBACjC,eAAe,CAAC,IAAI,CAClB,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,IAAA,+BAAkB,EAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CACvE,CAAC;iBACH;YACH,CAAC,CAAC,CAAC;YAEH,OAAO,eAAe,CAAC;QACzB,CAAC;KAAA;IAED;;;;;;;OAOG;IACU,gBAAgB;;YAC3B,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,eAAe,EAAE,GAC3B,EACD,WAAW,GACZ,EACD,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,eAAe,CAAC,GAAG,MAAM,WAAW,CAAC,UAAU,CAMpF;gBACA;oBACE,eAAe,CAAC,uBAAsE;oBACtF,SAAS;iBACV;gBACD;oBACE,eAAe,CAAC,qBAAoE;oBACpF,SAAS;iBACV;gBACD,CAAC,eAAe,CAAC,iBAAgE,EAAE,SAAS,CAAC;aAC9F,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,EAAE,IAAA,qDAAwC,EAAC,OAAO,EAAE,OAAO,CAAC;gBACnE,qBAAqB,EAAE,IAAA,+BAAkB,EAAC,qBAAqB,CAAC;gBAChE,eAAe,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;oBACzD,QAAQ,EAAE,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,IAAA,+BAAkB,EAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;oBACtE,UAAU,EAAE,IAAA,+BAAkB,EAAC,GAAG,CAAC;iBACpC,CAAC,CAAC;aACJ,CAAC;QACJ,CAAC;KAAA;CACF;AAnJD,4CAmJC"}

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

@@ -0,0 +1,8 @@
+import BigNumber from 'bignumber.js';
+import { CorporateActionTargets, TaxWithholding } from "../../../../types";
+export interface CorporateActionDefaultConfig {
+    targets: CorporateActionTargets;
+    defaultTaxWithholding: BigNumber;
+    taxWithholdings: TaxWithholding[];
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/CorporateActions/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,0BAAgB;AAEjE,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,sBAAsB,CAAC;IAChC,qBAAqB,EAAE,SAAS,CAAC;IACjC,eAAe,EAAE,cAAc,EAAE,CAAC;CACnC"}

package/api/entities/Asset/CorporateActions/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/api/entities/Asset/CorporateActions/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/CorporateActions/types.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,24 @@
+import { Asset, Context, Namespace, SetAssetDocumentsParams } from "../../../internal";
+import { AssetDocument, PaginationOptions, ProcedureMethod, ResultSet } from "../../../types";
+/**
+ * Handles all Asset Document related functionality
+ */
+export declare class Documents extends Namespace<Asset> {
+    /**
+     * @hidden
+     */
+    constructor(parent: Asset, context: Context);
+    /**
+     * Assign a new list of documents to the Asset by replacing the existing list of documents with the ones passed in the parameters
+     *
+     * This requires two transactions
+     */
+    set: ProcedureMethod<SetAssetDocumentsParams, Asset>;
+    /**
+     * Retrieve all documents linked to the Asset
+     *
+     * @note supports pagination
+     */
+    get(paginationOpts?: PaginationOptions): Promise<ResultSet<AssetDocument>>;
+}
+//# sourceMappingURL=Documents.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Documents.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Documents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAqB,uBAAuB,EAAE,0BAAmB;AACnG,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,eAAe,EAAE,SAAS,EAAE,uBAAgB;AAIvF;;GAEG;AACH,qBAAa,SAAU,SAAQ,SAAS,CAAC,KAAK,CAAC;IAC7C;;OAEG;gBACS,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO;IAW3C;;;;OAIG;IACI,GAAG,EAAE,eAAe,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;IAE5D;;;;OAIG;IACU,GAAG,CAAC,cAAc,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;CAqBxF"}

package/api/entities/Asset/Documents.js

@@ -0,0 +1,49 @@
+"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.Documents = void 0;
+const internal_1 = require("../../../internal");
+const conversion_1 = require("../../../utils/conversion");
+const internal_2 = require("../../../utils/internal");
+/**
+ * Handles all Asset Document related functionality
+ */
+class Documents extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        const { ticker } = parent;
+        this.set = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.setAssetDocuments, Object.assign({ ticker }, args)] }, context);
+    }
+    /**
+     * Retrieve all documents linked to the Asset
+     *
+     * @note supports pagination
+     */
+    get(paginationOpts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query }, }, context, parent: { ticker }, } = this;
+            const { entries, lastKey: next } = yield (0, internal_2.requestPaginated)(query.asset.assetDocuments, {
+                arg: (0, conversion_1.stringToTicker)(ticker, context),
+                paginationOpts,
+            });
+            const data = entries.map(([, doc]) => (0, conversion_1.documentToAssetDocument)(doc));
+            return {
+                data,
+                next,
+            };
+        });
+    }
+}
+exports.Documents = Documents;
+//# sourceMappingURL=Documents.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Documents.js","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Documents.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAAmG;AAEnG,0DAA6E;AAC7E,sDAA2E;AAE3E;;GAEG;AACH,MAAa,SAAU,SAAQ,oBAAgB;IAC7C;;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,GAAG,GAAG,IAAA,gCAAqB,EAC9B,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,4BAAiB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACzE,OAAO,CACR,CAAC;IACJ,CAAC;IASD;;;;OAIG;IACU,GAAG,CAAC,cAAkC;;YACjD,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,EACD,OAAO,EACP,MAAM,EAAE,EAAE,MAAM,EAAE,GACnB,GAAG,IAAI,CAAC;YAET,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,2BAAgB,EAAC,KAAK,CAAC,KAAK,CAAC,cAAc,EAAE;gBACpF,GAAG,EAAE,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC;gBACpC,cAAc;aACf,CAAC,CAAC;YAEH,MAAM,IAAI,GAAoB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,IAAA,oCAAuB,EAAC,GAAG,CAAC,CAAC,CAAC;YAErF,OAAO;gBACL,IAAI;gBACJ,IAAI;aACL,CAAC;QACJ,CAAC;KAAA;CACF;AAhDD,8BAgDC"}

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

@@ -0,0 +1,21 @@
+import BigNumber from 'bignumber.js';
+import { Asset, Context, Namespace } from "../../../internal";
+import { ProcedureMethod } from "../../../types";
+/**
+ * Handles all Asset Issuance related functionality
+ */
+export declare class Issuance extends Namespace<Asset> {
+    /**
+     * @hidden
+     */
+    constructor(parent: Asset, context: Context);
+    /**
+     * Issue a certain amount of Asset tokens to the caller's default portfolio
+     *
+     * @param args.amount - amount of Asset tokens to be issued
+     */
+    issue: ProcedureMethod<{
+        amount: BigNumber;
+    }, Asset>;
+}
+//# sourceMappingURL=Issuance.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Issuance.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Issuance.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAe,SAAS,EAAE,0BAAmB;AACpE,OAAO,EAAE,eAAe,EAAE,uBAAgB;AAG1C;;GAEG;AACH,qBAAa,QAAS,SAAQ,SAAS,CAAC,KAAK,CAAC;IAC5C;;OAEG;gBACS,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO;IAW3C;;;;OAIG;IACI,KAAK,EAAE,eAAe,CAAC;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,EAAE,KAAK,CAAC,CAAC;CAC7D"}

package/api/entities/Asset/Issuance.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Issuance = void 0;
+const internal_1 = require("../../../internal");
+const internal_2 = require("../../../utils/internal");
+/**
+ * Handles all Asset Issuance related functionality
+ */
+class Issuance extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        const { ticker } = parent;
+        this.issue = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.issueTokens, Object.assign({ ticker }, args)] }, context);
+    }
+}
+exports.Issuance = Issuance;
+//# sourceMappingURL=Issuance.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Issuance.js","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Issuance.ts"],"names":[],"mappings":";;;AAEA,gDAAoE;AAEpE,sDAAyD;AAEzD;;GAEG;AACH,MAAa,QAAS,SAAQ,oBAAgB;IAC5C;;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,KAAK,GAAG,IAAA,gCAAqB,EAChC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,sBAAW,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACnE,OAAO,CACR,CAAC;IACJ,CAAC;CAQF;AArBD,4BAqBC"}

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

@@ -0,0 +1,37 @@
+import BigNumber from 'bignumber.js';
+import { Asset, Context, LaunchOfferingParams, Namespace, Offering } from "../../../internal";
+import { OfferingStatus, OfferingWithDetails, ProcedureMethod } from "../../../types";
+/**
+ * Handles all Asset Offering related functionality
+ */
+export declare class Offerings extends Namespace<Asset> {
+    /**
+     * @hidden
+     */
+    constructor(parent: Asset, context: Context);
+    /**
+     * Launch an Asset Offering
+     *
+     * @note required roles:
+     *   - Offering Portfolio Custodian
+     *   - Raising Portfolio Custodian
+     */
+    launch: ProcedureMethod<LaunchOfferingParams, Offering>;
+    /**
+     * Retrieve a single Offering associated to this Asset by its ID
+     *
+     * @throws if there is no Offering with the passed ID
+     */
+    getOne(args: {
+        id: BigNumber;
+    }): Promise<Offering>;
+    /**
+     * Retrieve all of the Asset's Offerings and their details. Can be filtered using parameters
+     *
+     * @param opts.status - status of the Offerings to fetch. If defined, only Offerings that have all passed statuses will be returned
+     */
+    get(opts?: {
+        status?: Partial<OfferingStatus>;
+    }): Promise<OfferingWithDetails[]>;
+}
+//# sourceMappingURL=Offerings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Offerings.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Offerings.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAGrC,OAAO,EACL,KAAK,EACL,OAAO,EAEP,oBAAoB,EACpB,SAAS,EACT,QAAQ,EAET,0BAAmB;AACpB,OAAO,EAAa,cAAc,EAAE,mBAAmB,EAAE,eAAe,EAAE,uBAAgB;AAI1F;;GAEG;AACH,qBAAa,SAAU,SAAQ,SAAS,CAAC,KAAK,CAAC;IAC7C;;OAEG;gBACS,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO;IAW3C;;;;;;OAMG;IACI,MAAM,EAAE,eAAe,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;IAE/D;;;;OAIG;IACU,MAAM,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAoB/D;;;;OAIG;IACU,GAAG,CACd,IAAI,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;KAAO,GAC9C,OAAO,CAAC,mBAAmB,EAAE,CAAC;CAuDlC"}

package/api/entities/Asset/Offerings.js

@@ -0,0 +1,79 @@
+"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.Offerings = void 0;
+const lodash_1 = require("lodash");
+const internal_1 = require("../../../internal");
+const types_1 = require("../../../types");
+const conversion_1 = require("../../../utils/conversion");
+const internal_2 = require("../../../utils/internal");
+/**
+ * Handles all Asset Offering related functionality
+ */
+class Offerings extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        const { ticker } = parent;
+        this.launch = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.launchOffering, Object.assign({ ticker }, args)] }, context);
+    }
+    /**
+     * Retrieve a single Offering associated to this Asset by its ID
+     *
+     * @throws if there is no Offering with the passed ID
+     */
+    getOne(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { parent: { ticker }, context, } = this;
+            const { id } = args;
+            const offering = new internal_1.Offering({ ticker, id }, context);
+            const exists = yield offering.exists();
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: 'The Offering does not exist',
+                });
+            }
+            return offering;
+        });
+    }
+    /**
+     * Retrieve all of the Asset's Offerings and their details. Can be filtered using parameters
+     *
+     * @param opts.status - status of the Offerings to fetch. If defined, only Offerings that have all passed statuses will be returned
+     */
+    get(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { parent: { ticker }, context: { polymeshApi: { query: { sto }, }, }, context, } = this;
+            const { status: { timing: timingFilter, balance: balanceFilter, sale: saleFilter } = {} } = opts;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const [fundraiserEntries, nameEntries] = yield Promise.all([
+                sto.fundraisers.entries(rawTicker),
+                sto.fundraiserNames.entries(rawTicker),
+            ]);
+            const offerings = fundraiserEntries.map(([{ args: [, rawFundraiserId], }, fundraiser,]) => {
+                const id = (0, conversion_1.u64ToBigNumber)(rawFundraiserId);
+                const [[, name]] = (0, lodash_1.remove)(nameEntries, ([{ args: [, rawId], },]) => (0, conversion_1.u64ToBigNumber)(rawId).eq(id));
+                return {
+                    offering: new internal_1.Offering({ id, ticker }, context),
+                    details: (0, conversion_1.fundraiserToOfferingDetails)(fundraiser.unwrap(), name, context),
+                };
+            });
+            return offerings.filter(({ details: { status: { timing, sale, balance }, }, }) => (!timingFilter || timingFilter === timing) &&
+                (!saleFilter || saleFilter === sale) &&
+                (!balanceFilter || balanceFilter === balance));
+        });
+    }
+}
+exports.Offerings = Offerings;
+//# sourceMappingURL=Offerings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Offerings.js","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Offerings.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,mCAAgC;AAEhC,gDAQoB;AACpB,0CAA0F;AAC1F,0DAAiG;AACjG,sDAAyD;AAEzD;;GAEG;AACH,MAAa,SAAU,SAAQ,oBAAgB;IAC7C;;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,MAAM,GAAG,IAAA,gCAAqB,EACjC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,yBAAc,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACtE,OAAO,CACR,CAAC;IACJ,CAAC;IAWD;;;;OAIG;IACU,MAAM,CAAC,IAAuB;;YACzC,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,GACR,GAAG,IAAI,CAAC;YACT,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC;YACpB,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAEvD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;YAEvC,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,QAAQ,CAAC;QAClB,CAAC;KAAA;IAED;;;;OAIG;IACU,GAAG,CACd,OAA6C,EAAE;;YAE/C,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,GAAG,EAAE,GACf,GACF,EACD,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,EAAE,GACvF,IAAI,CAAC;YAEP,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,MAAM,CAAC,iBAAiB,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACzD,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;gBAClC,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC;aACvC,CAAC,CAAC;YAEH,MAAM,SAAS,GAAG,iBAAiB,CAAC,GAAG,CACrC,CAAC,CACC,EACE,IAAI,EAAE,CAAC,EAAE,eAAe,CAAC,GAC1B,EACD,UAAU,EACX,EAAE,EAAE;gBACH,MAAM,EAAE,GAAG,IAAA,2BAAc,EAAC,eAAe,CAAC,CAAC;gBAC3C,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,IAAA,eAAM,EACvB,WAAW,EACX,CAAC,CACC,EACE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,GAChB,EACF,EAAE,EAAE,CAAC,IAAA,2BAAc,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CACnC,CAAC;gBACF,OAAO;oBACL,QAAQ,EAAE,IAAI,mBAAQ,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC;oBAC/C,OAAO,EAAE,IAAA,wCAA2B,EAAC,UAAU,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC;iBACzE,CAAC;YACJ,CAAC,CACF,CAAC;YAEF,OAAO,SAAS,CAAC,MAAM,CACrB,CAAC,EACC,OAAO,EAAE,EACP,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAClC,GACF,EAAE,EAAE,CACH,CAAC,CAAC,YAAY,IAAI,YAAY,KAAK,MAAM,CAAC;gBAC1C,CAAC,CAAC,UAAU,IAAI,UAAU,KAAK,IAAI,CAAC;gBACpC,CAAC,CAAC,aAAa,IAAI,aAAa,KAAK,OAAO,CAAC,CAChD,CAAC;QACJ,CAAC;KAAA;CACF;AA/GD,8BA+GC"}

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

@@ -0,0 +1,50 @@
+import BigNumber from 'bignumber.js';
+import { Asset, AuthorizationRequest, Context, CreateGroupParams, CustomPermissionGroup, InviteExternalAgentParams, KnownPermissionGroup, Namespace, RemoveExternalAgentParams } from "../../../internal";
+import { AgentWithGroup, PermissionGroups, PermissionGroupType, ProcedureMethod } from "../../../types";
+/**
+ * Handles all Asset Permissions related functionality
+ */
+export declare class Permissions extends Namespace<Asset> {
+    /**
+     * @hidden
+     */
+    constructor(parent: Asset, context: Context);
+    /**
+     * Create a Permission Group for this Asset. Identities can be assigned to Permission Groups as agents. Agents assigned to a Permission Group have said group's permissions over the Asset
+     */
+    createGroup: ProcedureMethod<CreateGroupParams, CustomPermissionGroup>;
+    /**
+     * Invite an Identity to be an agent with permissions over this 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}
+     */
+    inviteAgent: ProcedureMethod<InviteExternalAgentParams, AuthorizationRequest>;
+    /**
+     * Revoke an agent's permissions over this Asset
+     */
+    removeAgent: ProcedureMethod<RemoveExternalAgentParams, void>;
+    /**
+     * Retrieve a single Permission Group by its ID (or type). Passing an ID will fetch a Custom Permission Group,
+     *   while passing a type will fetch a Known Permission Group
+     *
+     * @throws if there is no Permission Group with the passed ID
+     */
+    getGroup(args: {
+        id: BigNumber;
+    }): Promise<CustomPermissionGroup>;
+    getGroup(args: {
+        type: PermissionGroupType;
+    }): Promise<KnownPermissionGroup>;
+    /**
+     * Retrieve all Permission Groups of this Asset
+     */
+    getGroups(): Promise<PermissionGroups>;
+    /**
+     * Retrieve a list of agents (Identities which have permissions over the Asset) and
+     *   their respective Permission Groups
+     */
+    getAgents(): Promise<AgentWithGroup[]>;
+}
+//# sourceMappingURL=Permissions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Permissions.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Permissions.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,KAAK,EACL,oBAAoB,EACpB,OAAO,EAEP,iBAAiB,EACjB,qBAAqB,EAGrB,yBAAyB,EACzB,oBAAoB,EACpB,SAAS,EAGT,yBAAyB,EAC1B,0BAAmB;AACpB,OAAO,EACL,cAAc,EAEd,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EAChB,uBAAgB;AASjB;;GAEG;AACH,qBAAa,WAAY,SAAQ,SAAS,CAAC,KAAK,CAAC;IAC/C;;OAEG;gBACS,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO;IAqB3C;;OAEG;IACI,WAAW,EAAE,eAAe,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,CAAC;IAE9E;;;;;;OAMG;IACI,WAAW,EAAE,eAAe,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,CAAC;IAErF;;OAEG;IACI,WAAW,EAAE,eAAe,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;IAErE;;;;;OAKG;IACU,QAAQ,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IACjE,QAAQ,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,mBAAmB,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA6BzF;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;IA8BnD;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;CAqBpD"}

package/api/entities/Asset/Permissions.js

@@ -0,0 +1,83 @@
+"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.Permissions = void 0;
+const internal_1 = require("../../../internal");
+const types_1 = require("../../../types");
+const conversion_1 = require("../../../utils/conversion");
+const internal_2 = require("../../../utils/internal");
+/**
+ * Handles all Asset Permissions related functionality
+ */
+class Permissions extends internal_1.Namespace {
+    /**
+     * @hidden
+     */
+    constructor(parent, context) {
+        super(parent, context);
+        const { ticker } = parent;
+        this.createGroup = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.createGroup, Object.assign({ ticker }, args)] }, context);
+        this.inviteAgent = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.inviteExternalAgent, Object.assign({ ticker }, args)] }, context);
+        this.removeAgent = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.removeExternalAgent, Object.assign({ ticker }, args)] }, context);
+    }
+    // eslint-disable-next-line require-jsdoc
+    getGroup(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { parent: { ticker }, context, } = this;
+            if ('type' in args) {
+                return new internal_1.KnownPermissionGroup({ ticker, type: args.type }, context);
+            }
+            const customGroup = new internal_1.CustomPermissionGroup({ ticker, id: args.id }, context);
+            const exists = yield customGroup.exists();
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: 'The Permission Group does not exist',
+                });
+            }
+            return customGroup;
+        });
+    }
+    /**
+     * Retrieve all Permission Groups of this Asset
+     */
+    getGroups() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { externalAgents }, }, }, context, parent: { ticker }, } = this;
+            const known = Object.values(types_1.PermissionGroupType).map(type => new internal_1.KnownPermissionGroup({ type, ticker }, context));
+            const rawCustomPermissionGroups = yield externalAgents.groupPermissions.entries((0, conversion_1.stringToTicker)(ticker, context));
+            const custom = rawCustomPermissionGroups.map(([storageKey]) => new internal_1.CustomPermissionGroup({ ticker, id: (0, conversion_1.u32ToBigNumber)(storageKey.args[1]) }, context));
+            return {
+                known,
+                custom,
+            };
+        });
+    }
+    /**
+     * Retrieve a list of agents (Identities which have permissions over the Asset) and
+     *   their respective Permission Groups
+     */
+    getAgents() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { externalAgents }, }, }, parent: { ticker }, context, } = this;
+            const groups = yield externalAgents.groupOfAgent.entries((0, conversion_1.stringToTicker)(ticker, context));
+            return groups.map(([storageKey, agentGroup]) => {
+                const rawAgentGroup = agentGroup.unwrap();
+                return {
+                    agent: new internal_1.Identity({ did: (0, conversion_1.identityIdToString)(storageKey.args[1]) }, context),
+                    group: (0, conversion_1.agentGroupToPermissionGroup)(rawAgentGroup, ticker, context),
+                };
+            });
+        });
+    }
+}
+exports.Permissions = Permissions;
+//# sourceMappingURL=Permissions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Permissions.js","sourceRoot":"","sources":["../../../../src/api/entities/Asset/Permissions.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,gDAeoB;AACpB,0CAMiB;AACjB,0DAK4B;AAC5B,sDAAyD;AAEzD;;GAEG;AACH,MAAa,WAAY,SAAQ,oBAAgB;IAC/C;;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,WAAW,GAAG,IAAA,gCAAqB,EACtC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,sBAAW,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACnE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAA,gCAAqB,EACtC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,8BAAmB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EAC3E,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAA,gCAAqB,EACtC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,8BAAmB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EAC3E,OAAO,CACR,CAAC;IACJ,CAAC;IA8BD,yCAAyC;IAC5B,QAAQ,CACnB,IAAuD;;YAEvD,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,GACR,GAAG,IAAI,CAAC;YAET,IAAI,MAAM,IAAI,IAAI,EAAE;gBAClB,OAAO,IAAI,+BAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;aACvE;YAED,MAAM,WAAW,GAAG,IAAI,gCAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAEhF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,CAAC;YAE1C,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,qCAAqC;iBAC/C,CAAC,CAAC;aACJ;YAED,OAAO,WAAW,CAAC;QACrB,CAAC;KAAA;IAED;;OAEG;IACU,SAAS;;YACpB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,cAAc,EAAE,GAC1B,GACF,EACD,OAAO,EACP,MAAM,EAAE,EAAE,MAAM,EAAE,GACnB,GAAG,IAAI,CAAC;YAET,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,2BAAmB,CAAC,CAAC,GAAG,CAClD,IAAI,CAAC,EAAE,CAAC,IAAI,+BAAoB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAC5D,CAAC;YAEF,MAAM,yBAAyB,GAAG,MAAM,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAC7E,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAChC,CAAC;YAEF,MAAM,MAAM,GAA4B,yBAAyB,CAAC,GAAG,CACnE,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,CACf,IAAI,gCAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAA,2BAAc,EAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CACzF,CAAC;YAEF,OAAO;gBACL,KAAK;gBACL,MAAM;aACP,CAAC;QACJ,CAAC;KAAA;IAED;;;OAGG;IACU,SAAS;;YACpB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,cAAc,EAAE,GAC1B,GACF,EACD,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAE1F,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE;gBAC7C,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC1C,OAAO;oBACL,KAAK,EAAE,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,IAAA,+BAAkB,EAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC;oBAC7E,KAAK,EAAE,IAAA,wCAA2B,EAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC;iBACnE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA1ID,kCA0IC"}

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

@@ -0,0 +1,48 @@
+import BigNumber from 'bignumber.js';
+import { Asset, Namespace } from "../../../internal";
+import { PortfolioLike, TransferBreakdown, TransferStatus } from "../../../types";
+/**
+ * Handles all Asset Settlements related functionality
+ */
+export declare class Settlements extends Namespace<Asset> {
+    /**
+     * 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: {
+        from?: PortfolioLike;
+        to: PortfolioLike;
+        amount: BigNumber;
+    }): Promise<TransferStatus>;
+    /**
+     * 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: {
+        from?: PortfolioLike;
+        to: PortfolioLike;
+        amount: BigNumber;
+    }): Promise<TransferBreakdown>;
+}
+//# sourceMappingURL=Settlements.d.ts.map