@polymeshassociation/polymesh-sdk 14.0.0-beta.11

package/api/procedures/addTransferRestriction.js

@@ -0,0 +1,102 @@
+"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.addTransferRestriction = exports.getAuthorization = exports.prepareAddTransferRestriction = 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");
+/**
+ * @hidden
+ */
+function prepareAddTransferRestriction(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { context: { polymeshApi: { tx: { statistics }, query, consts, }, }, context, } = this;
+        const { ticker, exemptedIdentities = [], type } = args;
+        const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+        const maxTransferManagers = (0, conversion_1.u32ToBigNumber)(consts.statistics.maxTransferManagersPerAsset);
+        const currentTms = yield query.statistics.activeTransferManagers(ticker);
+        const restrictionAmount = new bignumber_js_1.default(currentTms.length);
+        if (restrictionAmount.gte(maxTransferManagers)) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.LimitExceeded,
+                message: 'Transfer Restriction limit reached',
+                data: { limit: maxTransferManagers },
+            });
+        }
+        let value;
+        if (type === types_1.TransferRestrictionType.Count) {
+            value = args.count;
+        }
+        else {
+            value = args.percentage;
+        }
+        const exists = !!currentTms.find(transferManager => {
+            const restriction = (0, conversion_1.transferManagerToTransferRestriction)(transferManager);
+            return restriction.type === type && restriction.value.eq(value);
+        });
+        if (exists) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.NoDataChange,
+                message: 'Cannot add the same restriction more than once',
+            });
+        }
+        const rawTransferManager = (0, conversion_1.transferRestrictionToTransferManager)({ type, value }, context);
+        const transactions = [
+            (0, internal_2.checkTxType)({
+                transaction: statistics.addTransferManager,
+                args: [rawTicker, rawTransferManager],
+            }),
+        ];
+        if (exemptedIdentities.length) {
+            const exemptedIds = yield (0, internal_2.getExemptedIds)(exemptedIdentities, context, ticker);
+            transactions.push((0, internal_2.checkTxType)({
+                transaction: statistics.addExemptedEntities,
+                feeMultiplier: new bignumber_js_1.default(exemptedIds.length),
+                args: [
+                    rawTicker,
+                    rawTransferManager,
+                    exemptedIds.map(entityId => (0, conversion_1.stringToScopeId)(entityId, context)),
+                ],
+            }));
+        }
+        this.addBatchTransaction({ transactions });
+        return restrictionAmount.plus(1);
+    });
+}
+exports.prepareAddTransferRestriction = prepareAddTransferRestriction;
+/**
+ * @hidden
+ */
+function getAuthorization({ ticker, exemptedIdentities = [] }) {
+    const transactions = [types_1.TxTags.statistics.AddTransferManager];
+    if (exemptedIdentities.length) {
+        transactions.push(types_1.TxTags.statistics.AddExemptedEntities);
+    }
+    return {
+        permissions: {
+            assets: [new internal_1.Asset({ ticker }, this.context)],
+            transactions,
+            portfolios: [],
+        },
+    };
+}
+exports.getAuthorization = getAuthorization;
+/**
+ * @hidden
+ */
+const addTransferRestriction = () => new internal_1.Procedure(prepareAddTransferRestriction, getAuthorization);
+exports.addTransferRestriction = addTransferRestriction;
+//# sourceMappingURL=addTransferRestriction.js.map

package/api/procedures/addTransferRestriction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addTransferRestriction.js","sourceRoot":"","sources":["../../../src/api/procedures/addTransferRestriction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gEAAqC;AAErC,6CAA6D;AAC7D,uCAMiB;AAEjB,uDAM4B;AAC5B,mDAA+D;AAkB/D;;GAEG;AACH,SAAsB,6BAA6B,CAEjD,IAAkC;;QAElC,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,EAAE,EAAE,EAAE,UAAU,EAAE,EAClB,KAAK,EACL,MAAM,GACP,GACF,EACD,OAAO,GACR,GAAG,IAAI,CAAC;QACT,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEvD,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,mBAAmB,GAAG,IAAA,2BAAc,EAAC,MAAM,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;QAE1F,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACzE,MAAM,iBAAiB,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAE3D,IAAI,iBAAiB,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE;YAC9C,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,aAAa;gBAC7B,OAAO,EAAE,oCAAoC;gBAC7C,IAAI,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE;aACrC,CAAC,CAAC;SACJ;QAED,IAAI,KAAgB,CAAC;QAErB,IAAI,IAAI,KAAK,+BAAuB,CAAC,KAAK,EAAE;YAC1C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SACpB;aAAM;YACL,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC;SACzB;QAED,MAAM,MAAM,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;YACjD,MAAM,WAAW,GAAG,IAAA,iDAAoC,EAAC,eAAe,CAAC,CAAC;YAE1E,OAAO,WAAW,CAAC,IAAI,KAAK,IAAI,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,EAAE;YACV,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,YAAY;gBAC5B,OAAO,EAAE,gDAAgD;aAC1D,CAAC,CAAC;SACJ;QAED,MAAM,kBAAkB,GAAG,IAAA,iDAAoC,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;QAE1F,MAAM,YAAY,GAAG;YACnB,IAAA,sBAAW,EAAC;gBACV,WAAW,EAAE,UAAU,CAAC,kBAAkB;gBAC1C,IAAI,EAAE,CAAC,SAAS,EAAE,kBAAkB,CAAC;aACtC,CAAC;SACH,CAAC;QAEF,IAAI,kBAAkB,CAAC,MAAM,EAAE;YAC7B,MAAM,WAAW,GAAG,MAAM,IAAA,yBAAc,EAAC,kBAAkB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAE9E,YAAY,CAAC,IAAI,CACf,IAAA,sBAAW,EAAC;gBACV,WAAW,EAAE,UAAU,CAAC,mBAAmB;gBAC3C,aAAa,EAAE,IAAI,sBAAS,CAAC,WAAW,CAAC,MAAM,CAAC;gBAChD,IAAI,EAAE;oBACJ,SAAS;oBACT,kBAAkB;oBAClB,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAA,4BAAe,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;iBAChE;aACF,CAAC,CACH,CAAC;SACH;QAED,IAAI,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;QAE3C,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;CAAA;AAhFD,sEAgFC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAE9B,EAAE,MAAM,EAAE,kBAAkB,GAAG,EAAE,EAAgC;IAEjE,MAAM,YAAY,GAAG,CAAC,cAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAE5D,IAAI,kBAAkB,CAAC,MAAM,EAAE;QAC7B,YAAY,CAAC,IAAI,CAAC,cAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;KAC1D;IAED,OAAO;QACL,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,IAAI,gBAAK,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC7C,YAAY;YACZ,UAAU,EAAE,EAAE;SACf;KACF,CAAC;AACJ,CAAC;AAjBD,4CAiBC;AAED;;GAEG;AACI,MAAM,sBAAsB,GAAG,GAAuD,EAAE,CAC7F,IAAI,oBAAS,CAAC,6BAA6B,EAAE,gBAAgB,CAAC,CAAC;AADpD,QAAA,sBAAsB,0BAC8B"}

package/api/procedures/claimClassicTicker.d.ts

@@ -0,0 +1,22 @@
+import { Procedure, TickerReservation } from "../../internal";
+export interface ClaimClassicTickerParams {
+    /**
+     * signature generated by signing a message formed by the DID (hex without the leading 0x),
+     *   prefixed by `classic_claim`. Example: if the DID is `0x1230000000000000000000000000000000000000000000000000000000000000`,
+     *   the message would be `classic_claim1230000000000000000000000000000000000000000000000000000000000000`
+     */
+    ethereumSignature: string;
+    /**
+     * ticker symbol to claim
+     */
+    ticker: string;
+}
+/**
+ * @hidden
+ */
+export declare function prepareClaimClassicTicker(this: Procedure<ClaimClassicTickerParams, TickerReservation>, args: ClaimClassicTickerParams): Promise<TickerReservation>;
+/**
+ * @hidden
+ */
+export declare const claimClassicTicker: () => Procedure<ClaimClassicTickerParams, TickerReservation>;
+//# sourceMappingURL=claimClassicTicker.d.ts.map

package/api/procedures/claimClassicTicker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"claimClassicTicker.d.ts","sourceRoot":"","sources":["../../../src/api/procedures/claimClassicTicker.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,SAAS,EAAE,iBAAiB,EAAE,uBAAmB;AAUzE,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAgBD;;GAEG;AACH,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,SAAS,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,EAC5D,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,CAmF5B;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,QAAO,UAAU,wBAAwB,EAAE,iBAAiB,CAOvF,CAAC"}

package/api/procedures/claimClassicTicker.js

@@ -0,0 +1,112 @@
+"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.claimClassicTicker = exports.prepareClaimClassicTicker = void 0;
+const util_1 = require("@polkadot/util");
+const eth_sig_util_1 = require("eth-sig-util");
+const internal_1 = require("../../internal");
+const types_1 = require("../../types");
+const constants_1 = require("../../utils/constants");
+const conversion_1 = require("../../utils/conversion");
+/**
+ * @hidden
+ * Generate the message a classic user has to sign to claim their ticker. This is used to validate
+ *   if the DID that is claiming the ticker in Polymesh is the actual owner of the ticker in Ethereum. The message format is
+ *   `classic_claim` followed by the DID in hex format (stripped of the leading 0x). So, if the DID is
+ *   `0x1230000000000000000000000000000000000000000000000000000000000000`, the message will be
+ *   `classic_claim1230000000000000000000000000000000000000000000000000000000000000`
+ */
+function generateClassicSignableMessage(did) {
+    const strippedDid = did.replace('0x', '');
+    return (0, util_1.stringToHex)(`${constants_1.CLASSIC_CLAIM_SIGNATURE_PREFIX}${strippedDid}`);
+}
+/**
+ * @hidden
+ */
+function prepareClaimClassicTicker(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { context: { polymeshApi: { tx, query: { asset }, }, }, context, } = this;
+        const { ticker, ethereumSignature } = args;
+        const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+        const [classicReservation, { expiry, owner: reservationOwner }, { did }] = yield Promise.all([
+            asset.classicTickers(rawTicker),
+            asset.tickers(rawTicker),
+            context.getSigningIdentity(),
+        ]);
+        if (classicReservation.isNone) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.UnmetPrerequisite,
+                message: 'The supplied ticker is not in the reserved classic ticker list',
+            });
+        }
+        const reservationExpired = expiry.isSome && (0, conversion_1.momentToDate)(expiry.unwrap()) < new Date();
+        if (reservationExpired) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.UnmetPrerequisite,
+                message: "The Ticker's claiming period has already expired",
+            });
+        }
+        const ownerDid = (0, conversion_1.identityIdToString)(reservationOwner);
+        if (ownerDid !== constants_1.CLASSIC_TICKER_OWNER_DID) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.UnmetPrerequisite,
+                message: 'Ticker already claimed',
+                data: {
+                    ownerDid,
+                },
+            });
+        }
+        const { eth_owner: ethOwner } = classicReservation.unwrap();
+        let signerAddress;
+        try {
+            signerAddress = (0, eth_sig_util_1.recoverPersonalSignature)({
+                data: generateClassicSignableMessage(did),
+                sig: ethereumSignature,
+            }).toLowerCase();
+        }
+        catch (err) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.ValidationError,
+                message: 'Ethereum signature not valid',
+                data: {
+                    error: err.message,
+                },
+            });
+        }
+        if (signerAddress !== (0, util_1.u8aToString)(ethOwner).toLowerCase()) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.UnmetPrerequisite,
+                message: 'The Account that signed the message is not the classic Ticker owner',
+                data: {
+                    signerAddress,
+                },
+            });
+        }
+        this.addTransaction({
+            transaction: tx.asset.claimClassicTicker,
+            args: [rawTicker, (0, conversion_1.stringToEcdsaSignature)(ethereumSignature, context)],
+        });
+        return new internal_1.TickerReservation({ ticker }, context);
+    });
+}
+exports.prepareClaimClassicTicker = prepareClaimClassicTicker;
+/**
+ * @hidden
+ */
+const claimClassicTicker = () => new internal_1.Procedure(prepareClaimClassicTicker, {
+    permissions: {
+        assets: [],
+        transactions: [types_1.TxTags.asset.ClaimClassicTicker],
+        portfolios: [],
+    },
+});
+exports.claimClassicTicker = claimClassicTicker;
+//# sourceMappingURL=claimClassicTicker.js.map

package/api/procedures/claimClassicTicker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"claimClassicTicker.js","sourceRoot":"","sources":["../../../src/api/procedures/claimClassicTicker.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAA0D;AAC1D,+CAAwD;AAExD,6CAAyE;AACzE,uCAA4C;AAC5C,qDAA6F;AAC7F,uDAK4B;AAe5B;;;;;;;GAOG;AACH,SAAS,8BAA8B,CAAC,GAAW;IACjD,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAE1C,OAAO,IAAA,kBAAW,EAAC,GAAG,0CAA8B,GAAG,WAAW,EAAE,CAAC,CAAC;AACxE,CAAC;AAED;;GAEG;AACH,SAAsB,yBAAyB,CAE7C,IAA8B;;QAE9B,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,EAAE,EACF,KAAK,EAAE,EAAE,KAAK,EAAE,GACjB,GACF,EACD,OAAO,GACR,GAAG,IAAI,CAAC;QACT,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;QAE3C,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3F,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC;YAC/B,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;YACxB,OAAO,CAAC,kBAAkB,EAAE;SAC7B,CAAC,CAAC;QAEH,IAAI,kBAAkB,CAAC,MAAM,EAAE;YAC7B,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,iBAAiB;gBACjC,OAAO,EAAE,gEAAgE;aAC1E,CAAC,CAAC;SACJ;QAED,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,IAAI,IAAA,yBAAY,EAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;QAEvF,IAAI,kBAAkB,EAAE;YACtB,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,iBAAiB;gBACjC,OAAO,EAAE,kDAAkD;aAC5D,CAAC,CAAC;SACJ;QAED,MAAM,QAAQ,GAAG,IAAA,+BAAkB,EAAC,gBAAgB,CAAC,CAAC;QAEtD,IAAI,QAAQ,KAAK,oCAAwB,EAAE;YACzC,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,iBAAiB;gBACjC,OAAO,EAAE,wBAAwB;gBACjC,IAAI,EAAE;oBACJ,QAAQ;iBACT;aACF,CAAC,CAAC;SACJ;QAED,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAE5D,IAAI,aAAqB,CAAC;QAE1B,IAAI;YACF,aAAa,GAAG,IAAA,uCAAwB,EAAC;gBACvC,IAAI,EAAE,8BAA8B,CAAC,GAAG,CAAC;gBACzC,GAAG,EAAE,iBAAiB;aACvB,CAAC,CAAC,WAAW,EAAE,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;gBAC/B,OAAO,EAAE,8BAA8B;gBACvC,IAAI,EAAE;oBACJ,KAAK,EAAE,GAAG,CAAC,OAAO;iBACnB;aACF,CAAC,CAAC;SACJ;QAED,IAAI,aAAa,KAAK,IAAA,kBAAW,EAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,EAAE;YACzD,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,iBAAiB;gBACjC,OAAO,EAAE,qEAAqE;gBAC9E,IAAI,EAAE;oBACJ,aAAa;iBACd;aACF,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,cAAc,CAAC;YAClB,WAAW,EAAE,EAAE,CAAC,KAAK,CAAC,kBAAkB;YACxC,IAAI,EAAE,CAAC,SAAS,EAAE,IAAA,mCAAsB,EAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;SACtE,CAAC,CAAC;QAEH,OAAO,IAAI,4BAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;CAAA;AAtFD,8DAsFC;AAED;;GAEG;AACI,MAAM,kBAAkB,GAAG,GAA2D,EAAE,CAC7F,IAAI,oBAAS,CAAC,yBAAyB,EAAE;IACvC,WAAW,EAAE;QACX,MAAM,EAAE,EAAE;QACV,YAAY,EAAE,CAAC,cAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC;QAC/C,UAAU,EAAE,EAAE;KACf;CACF,CAAC,CAAC;AAPQ,QAAA,kBAAkB,sBAO1B"}

package/api/procedures/claimDividends.d.ts

@@ -0,0 +1,16 @@
+import { DividendDistribution, Procedure } from "../../internal";
+/**
+ * @hidden
+ */
+export interface Params {
+    distribution: DividendDistribution;
+}
+/**
+ * @hidden
+ */
+export declare function prepareClaimDividends(this: Procedure<Params, void>, args: Params): Promise<void>;
+/**
+ * @hidden
+ */
+export declare const claimDividends: () => Procedure<Params, void>;
+//# sourceMappingURL=claimDividends.d.ts.map

package/api/procedures/claimDividends.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"claimDividends.d.ts","sourceRoot":"","sources":["../../../src/api/procedures/claimDividends.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAiB,SAAS,EAAE,uBAAmB;AAI5E;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,YAAY,EAAE,oBAAoB,CAAC;CACpC;AAED;;GAEG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,EAC7B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC,CA2Cf;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,QAAO,UAAU,MAAM,EAAE,IAAI,CAOpD,CAAC"}

package/api/procedures/claimDividends.js

@@ -0,0 +1,58 @@
+"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.claimDividends = exports.prepareClaimDividends = void 0;
+const utils_1 = require("./utils");
+const internal_1 = require("../../internal");
+const types_1 = require("../../types");
+const conversion_1 = require("../../utils/conversion");
+/**
+ * @hidden
+ */
+function prepareClaimDividends(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { context: { polymeshApi: { tx }, }, context, } = this;
+        const { distribution, distribution: { id: localId, asset: { ticker }, paymentDate, expiryDate, }, } = args;
+        (0, utils_1.assertDistributionOpen)(paymentDate, expiryDate);
+        const participant = yield distribution.getParticipant();
+        if (!participant) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.UnmetPrerequisite,
+                message: 'The signing Identity is not included in this Distribution',
+            });
+        }
+        const { paid } = participant;
+        if (paid) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.UnmetPrerequisite,
+                message: 'The signing Identity has already claimed dividends',
+            });
+        }
+        const rawCaId = (0, conversion_1.corporateActionIdentifierToCaId)({ ticker, localId }, context);
+        this.addTransaction({
+            transaction: tx.capitalDistribution.claim,
+            args: [rawCaId],
+        });
+    });
+}
+exports.prepareClaimDividends = prepareClaimDividends;
+/**
+ * @hidden
+ */
+const claimDividends = () => new internal_1.Procedure(prepareClaimDividends, {
+    permissions: {
+        transactions: [types_1.TxTags.capitalDistribution.Claim],
+        assets: [],
+        portfolios: [],
+    },
+});
+exports.claimDividends = claimDividends;
+//# sourceMappingURL=claimDividends.js.map

package/api/procedures/claimDividends.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"claimDividends.js","sourceRoot":"","sources":["../../../src/api/procedures/claimDividends.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAgE;AAChE,6CAA4E;AAC5E,uCAA4C;AAC5C,uDAAqE;AASrE;;GAEG;AACH,SAAsB,qBAAqB,CAEzC,IAAY;;QAEZ,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,EAAE,EAAE,GACpB,EACD,OAAO,GACR,GAAG,IAAI,CAAC;QACT,MAAM,EACJ,YAAY,EACZ,YAAY,EAAE,EACZ,EAAE,EAAE,OAAO,EACX,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,WAAW,EACX,UAAU,GACX,GACF,GAAG,IAAI,CAAC;QAET,IAAA,8BAAsB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAEhD,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAExD,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,iBAAiB;gBACjC,OAAO,EAAE,2DAA2D;aACrE,CAAC,CAAC;SACJ;QAED,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QAE7B,IAAI,IAAI,EAAE;YACR,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,iBAAiB;gBACjC,OAAO,EAAE,oDAAoD;aAC9D,CAAC,CAAC;SACJ;QAED,MAAM,OAAO,GAAG,IAAA,4CAA+B,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;QAE9E,IAAI,CAAC,cAAc,CAAC;YAClB,WAAW,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK;YACzC,IAAI,EAAE,CAAC,OAAO,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;CAAA;AA9CD,sDA8CC;AAED;;GAEG;AACI,MAAM,cAAc,GAAG,GAA4B,EAAE,CAC1D,IAAI,oBAAS,CAAC,qBAAqB,EAAE;IACnC,WAAW,EAAE;QACX,YAAY,EAAE,CAAC,cAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC;QAChD,MAAM,EAAE,EAAE;QACV,UAAU,EAAE,EAAE;KACf;CACF,CAAC,CAAC;AAPQ,QAAA,cAAc,kBAOtB"}

package/api/procedures/closeOffering.d.ts

@@ -0,0 +1,23 @@
+import BigNumber from 'bignumber.js';
+import { Procedure } from "../../internal";
+import { ProcedureAuthorization } from "../../types/internal";
+/**
+ * @hidden
+ */
+export interface Params {
+    ticker: string;
+    id: BigNumber;
+}
+/**
+ * @hidden
+ */
+export declare function prepareCloseOffering(this: Procedure<Params, void>, args: Params): Promise<void>;
+/**
+ * @hidden
+ */
+export declare function getAuthorization(this: Procedure<Params, void>, { ticker }: Params): ProcedureAuthorization;
+/**
+ * @hidden
+ */
+export declare const closeOffering: () => Procedure<Params, void>;
+//# sourceMappingURL=closeOffering.d.ts.map

package/api/procedures/closeOffering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"closeOffering.d.ts","sourceRoot":"","sources":["../../../src/api/procedures/closeOffering.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAkC,SAAS,EAAE,uBAAmB;AAEvE,OAAO,EAAE,sBAAsB,EAAE,6BAAyB;AAG1D;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,SAAS,CAAC;CACf;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,EAC7B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC,CA+Bf;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,EAC7B,EAAE,MAAM,EAAE,EAAE,MAAM,GACjB,sBAAsB,CASxB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,QAAO,UAAU,MAAM,EAAE,IAAI,CACA,CAAC"}

package/api/procedures/closeOffering.js

@@ -0,0 +1,59 @@
+"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.closeOffering = exports.getAuthorization = exports.prepareCloseOffering = void 0;
+const internal_1 = require("../../internal");
+const types_1 = require("../../types");
+const conversion_1 = require("../../utils/conversion");
+/**
+ * @hidden
+ */
+function prepareCloseOffering(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { context: { polymeshApi: { tx: { sto: txSto }, }, }, context, } = this;
+        const { ticker, id } = args;
+        const offering = new internal_1.Offering({ ticker, id }, context);
+        const { status: { sale }, } = yield offering.details();
+        if ([types_1.OfferingSaleStatus.Closed, types_1.OfferingSaleStatus.ClosedEarly].includes(sale)) {
+            throw new internal_1.PolymeshError({
+                code: types_1.ErrorCode.UnmetPrerequisite,
+                message: 'The Offering is already closed',
+            });
+        }
+        const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+        const rawId = (0, conversion_1.bigNumberToU64)(id, context);
+        this.addTransaction({
+            transaction: txSto.stop,
+            args: [rawTicker, rawId],
+        });
+    });
+}
+exports.prepareCloseOffering = prepareCloseOffering;
+/**
+ * @hidden
+ */
+function getAuthorization({ ticker }) {
+    const { context } = this;
+    return {
+        permissions: {
+            transactions: [types_1.TxTags.sto.Stop],
+            assets: [new internal_1.Asset({ ticker }, context)],
+            portfolios: [],
+        },
+    };
+}
+exports.getAuthorization = getAuthorization;
+/**
+ * @hidden
+ */
+const closeOffering = () => new internal_1.Procedure(prepareCloseOffering, getAuthorization);
+exports.closeOffering = closeOffering;
+//# sourceMappingURL=closeOffering.js.map

package/api/procedures/closeOffering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"closeOffering.js","sourceRoot":"","sources":["../../../src/api/procedures/closeOffering.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,6CAAuE;AACvE,uCAAgE;AAEhE,uDAAoE;AAUpE;;GAEG;AACH,SAAsB,oBAAoB,CAExC,IAAY;;QAEZ,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GACnB,GACF,EACD,OAAO,GACR,GAAG,IAAI,CAAC;QACT,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC;QAE5B,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAEvD,MAAM,EACJ,MAAM,EAAE,EAAE,IAAI,EAAE,GACjB,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;QAE7B,IAAI,CAAC,0BAAkB,CAAC,MAAM,EAAE,0BAAkB,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC9E,MAAM,IAAI,wBAAa,CAAC;gBACtB,IAAI,EAAE,iBAAS,CAAC,iBAAiB;gBACjC,OAAO,EAAE,gCAAgC;aAC1C,CAAC,CAAC;SACJ;QAED,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,KAAK,GAAG,IAAA,2BAAc,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,CAAC;YAClB,WAAW,EAAE,KAAK,CAAC,IAAI;YACvB,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC;SACzB,CAAC,CAAC;IACL,CAAC;CAAA;AAlCD,oDAkCC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAE9B,EAAE,MAAM,EAAU;IAElB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACzB,OAAO;QACL,WAAW,EAAE;YACX,YAAY,EAAE,CAAC,cAAM,CAAC,GAAG,CAAC,IAAI,CAAC;YAC/B,MAAM,EAAE,CAAC,IAAI,gBAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;YACxC,UAAU,EAAE,EAAE;SACf;KACF,CAAC;AACJ,CAAC;AAZD,4CAYC;AAED;;GAEG;AACI,MAAM,aAAa,GAAG,GAA4B,EAAE,CACzD,IAAI,oBAAS,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAC;AAD3C,QAAA,aAAa,iBAC8B"}

package/api/procedures/configureDividendDistribution.d.ts

@@ -0,0 +1,69 @@
+import { ISubmittableResult } from '@polkadot/types/types';
+import BigNumber from 'bignumber.js';
+import { Context, DefaultPortfolio, DividendDistribution, InitiateCorporateActionParams, NumberedPortfolio, PostTransactionValue, Procedure } from "../../internal";
+import { InputCaCheckpoint } from "../../types";
+import { ProcedureAuthorization } from "../../types/internal";
+/**
+ * @hidden
+ */
+export declare const createDividendDistributionResolver: (context: Context) => (receipt: ISubmittableResult) => Promise<DividendDistribution>;
+export declare type ConfigureDividendDistributionParams = Omit<InitiateCorporateActionParams, 'kind' | 'checkpoint'> & {
+    /**
+     * checkpoint to be used to calculate Dividends. If a Schedule is passed, the next Checkpoint it creates will be used.
+     *   If a Date is passed, a Checkpoint will be created at that date and used
+     */
+    checkpoint: InputCaCheckpoint;
+    /**
+     * portfolio from which the Dividends will be distributed. Optional, defaults to the Corporate Actions Agent's Default Portfolio
+     */
+    originPortfolio?: NumberedPortfolio | BigNumber;
+    /**
+     * ticker of the currency in which Dividends will be distributed
+     */
+    currency: string;
+    /**
+     * amount of `currency` to distribute per each share of the Asset that a target holds
+     */
+    perShare: BigNumber;
+    /**
+     * maximum amount of `currency` to distribute in total
+     */
+    maxAmount: BigNumber;
+    /**
+     * date from which Asset Holders can claim their Dividends
+     */
+    paymentDate: Date;
+    /**
+     * Optional, defaults to never expiring
+     */
+    expiryDate?: Date;
+};
+/**
+ * @hidden
+ */
+export declare type Params = ConfigureDividendDistributionParams & {
+    ticker: string;
+};
+/**
+ * @hidden
+ */
+export interface Storage {
+    portfolio: DefaultPortfolio | NumberedPortfolio;
+}
+/**
+ * @hidden
+ */
+export declare function prepareConfigureDividendDistribution(this: Procedure<Params, DividendDistribution, Storage>, args: Params): Promise<PostTransactionValue<DividendDistribution>>;
+/**
+ * @hidden
+ */
+export declare function getAuthorization(this: Procedure<Params, DividendDistribution, Storage>, { ticker }: Params): ProcedureAuthorization;
+/**
+ * @hidden
+ */
+export declare function prepareStorage(this: Procedure<Params, DividendDistribution, Storage>, { originPortfolio }: Params): Promise<Storage>;
+/**
+ * @hidden
+ */
+export declare const configureDividendDistribution: () => Procedure<Params, DividendDistribution, Storage>;
+//# sourceMappingURL=configureDividendDistribution.d.ts.map

package/api/procedures/configureDividendDistribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureDividendDistribution.d.ts","sourceRoot":"","sources":["../../../src/api/procedures/configureDividendDistribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,SAAS,MAAM,cAAc,CAAC;AAGrC,OAAO,EAGL,OAAO,EACP,gBAAgB,EAChB,oBAAoB,EAEpB,6BAA6B,EAC7B,iBAAiB,EAEjB,oBAAoB,EACpB,SAAS,EACV,uBAAmB;AACpB,OAAO,EAAkC,iBAAiB,EAAoB,oBAAgB;AAC9F,OAAO,EAAE,sBAAsB,EAAE,6BAAyB;AAc1D;;GAEG;AACH,eAAO,MAAM,kCAAkC,YACnC,OAAO,eACD,kBAAkB,KAAG,QAAQ,oBAAoB,CAqBhE,CAAC;AAEJ,oBAAY,mCAAmC,GAAG,IAAI,CACpD,6BAA6B,EAC7B,MAAM,GAAG,YAAY,CACtB,GAAG;IACF;;;OAGG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,MAAM,GAAG,mCAAmC,GAAG;IACzD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;CACjD;AAED;;GAEG;AACH,wBAAsB,oCAAoC,CACxD,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EACtD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC,CAwGrD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EACtD,EAAE,MAAM,EAAE,EAAE,MAAM,GACjB,sBAAsB,CAcxB;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EACtD,EAAE,eAAe,EAAE,EAAE,MAAM,GAC1B,OAAO,CAAC,OAAO,CAAC,CAclB;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B,QAAO,UAAU,MAAM,EAAE,oBAAoB,EAAE,OAAO,CACT,CAAC"}