@polymeshassociation/polymesh-sdk 14.0.0-beta.11

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

@@ -0,0 +1,158 @@
+import BigNumber from 'bignumber.js';
+import { HumanReadable as CorporateActionHumanReadable, Params as CorporateActionParams, UniqueIdentifiers } from "../CorporateAction";
+import { Checkpoint, CheckpointSchedule, Context, CorporateActionBase, DefaultPortfolio, Identity, ModifyCaCheckpointParams, NumberedPortfolio, PayDividendsParams } from "../../../internal";
+import { CorporateActionKind, DistributionPayment, DividendDistributionDetails, InputCaCheckpoint, NoArgsProcedureMethod, ProcedureMethod, ResultSet } from "../../../types";
+import { HumanReadableType, Modify } from "../../../types/utils";
+import { DistributionParticipant } from './types';
+interface HumanReadable extends CorporateActionHumanReadable {
+    origin: HumanReadableType<DefaultPortfolio | NumberedPortfolio>;
+    currency: string;
+    perShare: string;
+    maxAmount: string;
+    expiryDate: string | null;
+    paymentDate: string;
+}
+export interface DividendDistributionParams {
+    origin: DefaultPortfolio | NumberedPortfolio;
+    currency: string;
+    perShare: BigNumber;
+    maxAmount: BigNumber;
+    expiryDate: null | Date;
+    paymentDate: Date;
+}
+export declare type Params = CorporateActionParams & DividendDistributionParams;
+/**
+ * Represents a Corporate Action via which an Asset issuer wishes to distribute dividends
+ *   between a subset of the Asset Holders (targets)
+ */
+export declare class DividendDistribution extends CorporateActionBase {
+    /**
+     * Portfolio from which the dividends will be distributed
+     */
+    origin: DefaultPortfolio | NumberedPortfolio;
+    /**
+     * ticker of the currency in which dividends are being distributed
+     */
+    currency: string;
+    /**
+     * amount of `currency` to pay for each share held by the Asset Holders
+     */
+    perShare: BigNumber;
+    /**
+     * maximum amount of `currency` to be distributed. Distributions are "first come, first served", so funds can be depleted before
+     *   every Asset Holder receives their corresponding amount
+     */
+    maxAmount: BigNumber;
+    /**
+     * date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires
+     */
+    expiryDate: null | Date;
+    /**
+     * date starting from which dividends can be paid/reclaimed
+     */
+    paymentDate: Date;
+    /**
+     * type of dividend distribution being represented. The chain enforces it to be either PredictableBenefit or UnpredictableBenefit
+     */
+    protected kind: CorporateActionKind.UnpredictableBenefit | CorporateActionKind.PredictableBenefit;
+    /**
+     * @hidden
+     */
+    constructor(args: UniqueIdentifiers & Params, context: Context);
+    /**
+     * Claim the Dividends corresponding to the signing Identity
+     *
+     * @note if `currency` is indivisible, the Identity's share will be rounded down to the nearest integer (after taxes are withheld)
+     */
+    claim: NoArgsProcedureMethod<void>;
+    /**
+     * Modify the Distribution's Checkpoint
+     */
+    modifyCheckpoint: ProcedureMethod<Modify<ModifyCaCheckpointParams, {
+        checkpoint: InputCaCheckpoint;
+    }>, void>;
+    /**
+     * Transfer the corresponding share of the dividends to a list of Identities
+     *
+     * @note due to performance issues, we do not validate that the distribution has enough remaining funds to pay the corresponding amount to the supplied Identities
+     * @note if `currency` is indivisible, the Identity's share will be rounded down to the nearest integer (after taxes are withheld)
+     */
+    pay: ProcedureMethod<PayDividendsParams, void>;
+    /**
+     * Reclaim any remaining funds back to the origin Portfolio. This can only be done after the Distribution has expired
+     *
+     * @note withheld taxes are also reclaimed in the same transaction
+     *
+     * @note required roles:
+     *   - Origin Portfolio Custodian
+     */
+    reclaimFunds: NoArgsProcedureMethod<void>;
+    /**
+     * Retrieve the Checkpoint associated with this Dividend Distribution. If the Checkpoint is scheduled and has not been created yet,
+     *   the corresponding CheckpointSchedule is returned instead
+     */
+    checkpoint(): Promise<Checkpoint | CheckpointSchedule>;
+    /**
+     * Retrieve whether the Distribution exists
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Retrieve details associated with this Dividend Distribution
+     */
+    details(): Promise<DividendDistributionDetails>;
+    /**
+     * Retrieve a comprehensive list of all Identities that are entitled to dividends in this Distribution (participants),
+     *   the amount they are entitled to and whether they have been paid or not
+     *
+     * @note this request can take a lot of time with large amounts of Asset Holders
+     * @note if the Distribution Checkpoint hasn't been created yet, the result will be an empty array.
+     *   This is because the Distribution participants cannot be determined without a Checkpoint
+     */
+    getParticipants(): Promise<DistributionParticipant[]>;
+    /**
+     * Retrieve an Identity that is entitled to dividends in this Distribution (participant),
+     *   the amount it is entitled to and whether it has been paid or not
+     *
+     * @param args.identity - defaults to the signing Identity
+     *
+     * @note if the Distribution Checkpoint hasn't been created yet, the result will be null.
+     *   This is because the Distribution participant's corresponding payment cannot be determined without a Checkpoint
+     */
+    getParticipant(args?: {
+        identity: string | Identity;
+    }): Promise<DistributionParticipant | null>;
+    /**
+     * @hidden
+     */
+    private assembleParticipant;
+    /**
+     * @hidden
+     */
+    private fetchDistribution;
+    /**
+     * Retrieve the amount of taxes that have been withheld up to this point in this Distribution
+     *
+     * @note uses the middleware
+     */
+    getWithheldTax(): Promise<BigNumber>;
+    /**
+     * Retrieve the payment history for this Distribution
+     *
+     * @note uses the middleware
+     * @note supports pagination
+     */
+    getPaymentHistory(opts?: {
+        size?: BigNumber;
+        start?: BigNumber;
+    }): Promise<ResultSet<DistributionPayment>>;
+    /**
+     * @hidden
+     */
+    private getParticipantStatuses;
+    /**
+     * Return the Dividend Distribution's static data
+     */
+    toHuman(): HumanReadable;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/DividendDistribution/index.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,cAAc,CAAC;AAIrC,OAAO,EACL,aAAa,IAAI,4BAA4B,EAC7C,MAAM,IAAI,qBAAqB,EAC/B,iBAAiB,EAClB,2BAAuC;AACxC,OAAO,EACL,UAAU,EACV,kBAAkB,EAElB,OAAO,EACP,mBAAmB,EACnB,gBAAgB,EAChB,QAAQ,EACR,wBAAwB,EAExB,iBAAiB,EAEjB,kBAAkB,EAGnB,0BAAmB;AAIpB,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,2BAA2B,EAG3B,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,SAAS,EAEV,uBAAgB;AACjB,OAAO,EAAW,iBAAiB,EAAE,MAAM,EAA0B,6BAAsB;AAkB3F,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAElD,UAAU,aAAc,SAAQ,4BAA4B;IAC1D,MAAM,EAAE,iBAAiB,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,CAAC;IAChE,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,SAAS,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,IAAI,CAAC;CACnB;AAED,oBAAY,MAAM,GAAG,qBAAqB,GAAG,0BAA0B,CAAC;AAIxE;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,mBAAmB;IAC3D;;OAEG;IACI,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;IAEpD;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAC;IAExB;;OAEG;IACI,QAAQ,EAAE,SAAS,CAAC;IAE3B;;;OAGG;IACI,SAAS,EAAE,SAAS,CAAC;IAE5B;;OAEG;IACI,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACI,WAAW,EAAE,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAkB,IAAI,EAClB,mBAAmB,CAAC,oBAAoB,GACxC,mBAAmB,CAAC,kBAAkB,CAAC;IAE3C;;OAEG;gBACgB,IAAI,EAAE,iBAAiB,GAAG,MAAM,EAAE,OAAO,EAAE,OAAO;IAsDrE;;;;OAIG;IACI,KAAK,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAE1C;;OAEG;IACI,gBAAgB,EAAE,eAAe,CACtC,MAAM,CACJ,wBAAwB,EACxB;QACE,UAAU,EAAE,iBAAiB,CAAC;KAC/B,CACF,EACD,IAAI,CACL,CAAC;IAEF;;;;;OAKG;IACI,GAAG,EAAE,eAAe,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACI,YAAY,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEjD;;;OAGG;IACmB,UAAU,IAAI,OAAO,CAAC,UAAU,GAAG,kBAAkB,CAAC;IAgB5E;;OAEG;IACmB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAMhD;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,2BAA2B,CAAC;IAkB5D;;;;;;;OAOG;IACU,eAAe,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;IA8ClE;;;;;;;;OAQG;IACU,cAAc,CAAC,IAAI,CAAC,EAAE;QACjC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC;KAC7B,GAAG,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAgD3C;;OAEG;IACH,OAAO,CAAC,mBAAmB;IA6B3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAYzB;;;;OAIG;IACU,cAAc,IAAI,OAAO,CAAC,SAAS,CAAC;IA6BjD;;;;;OAKG;IACU,iBAAiB,CAC5B,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,SAAS,CAAA;KAAO,GACjD,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IA8E1C;;OAEG;YACW,sBAAsB;IA4CpC;;OAEG;IACa,OAAO,IAAI,aAAa;CAUzC"}

package/api/entities/DividendDistribution/index.js

@@ -0,0 +1,346 @@
+"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 __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DividendDistribution = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const bluebird_1 = __importDefault(require("bluebird"));
+const lodash_1 = require("lodash");
+const internal_1 = require("../../../internal");
+const queries_1 = require("../../../middleware/queries");
+const types_1 = require("../../../types");
+const utils_1 = require("../../../types/utils");
+const constants_1 = require("../../../utils/constants");
+const conversion_1 = require("../../../utils/conversion");
+const internal_2 = require("../../../utils/internal");
+const notExistsMessage = 'The Dividend Distribution no longer exists';
+/**
+ * Represents a Corporate Action via which an Asset issuer wishes to distribute dividends
+ *   between a subset of the Asset Holders (targets)
+ */
+class DividendDistribution extends internal_1.CorporateActionBase {
+    /**
+     * @hidden
+     */
+    constructor(args, context) {
+        const { origin, currency, perShare, maxAmount, expiryDate, paymentDate } = args, corporateActionArgs = __rest(args, ["origin", "currency", "perShare", "maxAmount", "expiryDate", "paymentDate"]);
+        super(Object.assign({}, corporateActionArgs), context);
+        this.origin = origin;
+        this.currency = currency;
+        this.perShare = perShare;
+        this.maxAmount = maxAmount;
+        this.expiryDate = expiryDate;
+        this.paymentDate = paymentDate;
+        this.pay = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: payDividendsArgs => [
+                internal_1.payDividends,
+                Object.assign(Object.assign({}, payDividendsArgs), { distribution: this }),
+            ],
+        }, context);
+        this.claim = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: () => [internal_1.claimDividends, { distribution: this }], voidArgs: true }, context);
+        this.modifyCheckpoint = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: modifyCheckpointArgs => [
+                internal_1.modifyDistributionCheckpoint,
+                Object.assign({ distribution: this }, modifyCheckpointArgs),
+            ],
+        }, context);
+        this.reclaimFunds = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: () => [internal_1.reclaimDividendDistributionFunds, { distribution: this }],
+            voidArgs: true,
+        }, context);
+    }
+    /**
+     * Retrieve the Checkpoint associated with this Dividend Distribution. If the Checkpoint is scheduled and has not been created yet,
+     *   the corresponding CheckpointSchedule is returned instead
+     */
+    checkpoint() {
+        const _super = Object.create(null, {
+            checkpoint: { get: () => super.checkpoint }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const exists = yield this.exists();
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            const checkpoint = yield _super.checkpoint.call(this);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return checkpoint;
+        });
+    }
+    /**
+     * Retrieve whether the Distribution exists
+     */
+    exists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const distribution = yield this.fetchDistribution();
+            return distribution.isSome;
+        });
+    }
+    /**
+     * Retrieve details associated with this Dividend Distribution
+     */
+    details() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const distribution = yield this.fetchDistribution();
+            if (distribution.isNone) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            const { reclaimed, remaining } = distribution.unwrap();
+            return {
+                remainingFunds: (0, conversion_1.balanceToBigNumber)(remaining),
+                fundsReclaimed: (0, conversion_1.boolToBoolean)(reclaimed),
+            };
+        });
+    }
+    /**
+     * Retrieve a comprehensive list of all Identities that are entitled to dividends in this Distribution (participants),
+     *   the amount they are entitled to and whether they have been paid or not
+     *
+     * @note this request can take a lot of time with large amounts of Asset Holders
+     * @note if the Distribution Checkpoint hasn't been created yet, the result will be an empty array.
+     *   This is because the Distribution participants cannot be determined without a Checkpoint
+     */
+    getParticipants() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { targets: { identities: targetIdentities, treatment }, paymentDate, } = this;
+            let balances = [];
+            const checkpoint = yield this.checkpoint();
+            if (checkpoint instanceof internal_1.CheckpointSchedule) {
+                return [];
+            }
+            let allFetched = false;
+            let start;
+            while (!allFetched) {
+                const { data, next } = yield checkpoint.allBalances({ size: constants_1.MAX_PAGE_SIZE, start });
+                start = next || undefined;
+                allFetched = !next;
+                balances = [...balances, ...data];
+            }
+            const isExclusion = treatment === types_1.TargetTreatment.Exclude;
+            const participants = [];
+            const clonedTargets = [...targetIdentities];
+            balances.forEach(({ identity, balance }) => {
+                const isTarget = !!(0, lodash_1.remove)(clonedTargets, target => identity.isEqual(target)).length;
+                if (balance.gt(0) && (0, internal_2.xor)(isTarget, isExclusion)) {
+                    participants.push(this.assembleParticipant(identity, balance));
+                }
+            });
+            // participants can't be paid before the payment date
+            if (paymentDate < new Date()) {
+                return participants;
+            }
+            const paidStatuses = yield this.getParticipantStatuses(participants);
+            return paidStatuses.map((paid, index) => (Object.assign(Object.assign({}, participants[index]), { paid })));
+        });
+    }
+    /**
+     * Retrieve an Identity that is entitled to dividends in this Distribution (participant),
+     *   the amount it is entitled to and whether it has been paid or not
+     *
+     * @param args.identity - defaults to the signing Identity
+     *
+     * @note if the Distribution Checkpoint hasn't been created yet, the result will be null.
+     *   This is because the Distribution participant's corresponding payment cannot be determined without a Checkpoint
+     */
+    getParticipant(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id: localId, asset: { ticker }, targets: { identities: targetIdentities, treatment }, paymentDate, context, context: { polymeshApi: { query }, }, } = this;
+            const checkpoint = yield this.checkpoint();
+            if (checkpoint instanceof internal_1.CheckpointSchedule) {
+                return null;
+            }
+            const [identity, balance] = yield Promise.all([
+                (0, internal_2.getIdentity)(args === null || args === void 0 ? void 0 : args.identity, context),
+                checkpoint.balance(args),
+            ]);
+            const isTarget = !!targetIdentities.find(target => identity.isEqual(target));
+            let participant;
+            const isExclusion = treatment === types_1.TargetTreatment.Exclude;
+            if (balance.gt(0) && (0, internal_2.xor)(isTarget, isExclusion)) {
+                participant = this.assembleParticipant(identity, balance);
+            }
+            else {
+                return null;
+            }
+            // participant can't be paid before the payment date
+            if (paymentDate < new Date()) {
+                return participant;
+            }
+            const rawDid = (0, conversion_1.stringToIdentityId)(identity.did, context);
+            const rawCaId = (0, conversion_1.corporateActionIdentifierToCaId)({ ticker, localId }, context);
+            const holderPaid = yield query.capitalDistribution.holderPaid([rawCaId, rawDid]);
+            const paid = (0, conversion_1.boolToBoolean)(holderPaid);
+            return Object.assign(Object.assign({}, participant), { paid });
+        });
+    }
+    /**
+     * @hidden
+     */
+    assembleParticipant(identity, balance) {
+        const { defaultTaxWithholding, taxWithholdings, perShare } = this;
+        let taxWithholdingPercentage = defaultTaxWithholding;
+        const taxWithholding = taxWithholdings.find(({ identity: taxIdentity }) => identity.isEqual(taxIdentity));
+        if (taxWithholding) {
+            taxWithholdingPercentage = taxWithholding.percentage;
+        }
+        const amount = balance.multipliedBy(perShare);
+        const amountAfterTax = amount
+            .minus(amount.multipliedBy(taxWithholdingPercentage).dividedBy(100).decimalPlaces(constants_1.MAX_DECIMALS))
+            .decimalPlaces(constants_1.MAX_DECIMALS);
+        return {
+            identity,
+            amount,
+            taxWithholdingPercentage,
+            amountAfterTax,
+            paid: false,
+        };
+    }
+    /**
+     * @hidden
+     */
+    fetchDistribution() {
+        const { asset: { ticker }, id, context, } = this;
+        return context.polymeshApi.query.capitalDistribution.distributions((0, conversion_1.corporateActionIdentifierToCaId)({ ticker, localId: id }, context));
+    }
+    /**
+     * Retrieve the amount of taxes that have been withheld up to this point in this Distribution
+     *
+     * @note uses the middleware
+     */
+    getWithheldTax() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id, asset: { ticker }, context, } = this;
+            const taxPromise = context.queryMiddleware((0, queries_1.getWithholdingTaxesOfCa)({
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                CAId: { ticker, localId: id.toNumber() },
+            }));
+            const [exists, result] = yield Promise.all([this.exists(), taxPromise]);
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const { taxes } = result.data.getWithholdingTaxesOfCA;
+            return new bignumber_js_1.default(taxes);
+        });
+    }
+    /**
+     * Retrieve the payment history for this Distribution
+     *
+     * @note uses the middleware
+     * @note supports pagination
+     */
+    getPaymentHistory(opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id, asset: { ticker }, context, context: { polymeshApi: { query: { system }, }, }, } = this;
+            const { size, start } = opts;
+            const paymentsPromise = context.queryMiddleware((0, queries_1.getHistoryOfPaymentEventsForCa)({
+                CAId: { ticker, localId: id.toNumber() },
+                fromDate: null,
+                toDate: null,
+                count: size === null || size === void 0 ? void 0 : size.toNumber(),
+                skip: start === null || start === void 0 ? void 0 : start.toNumber(),
+            }));
+            const [exists, result] = yield Promise.all([this.exists(), paymentsPromise]);
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            const { data: { getHistoryOfPaymentEventsForCA: getHistoryOfPaymentEventsForCaResult }, } = result;
+            const { items, totalCount } = getHistoryOfPaymentEventsForCaResult;
+            const count = new bignumber_js_1.default(totalCount);
+            const data = [];
+            const multiParams = [];
+            /* eslint-disable @typescript-eslint/no-non-null-assertion */
+            items.forEach(item => {
+                const { blockId, datetime, eventDid: did, balance, tax } = item;
+                const blockNumber = new bignumber_js_1.default(blockId);
+                multiParams.push((0, conversion_1.bigNumberToU32)(blockNumber, context));
+                data.push({
+                    blockNumber,
+                    date: new Date(datetime),
+                    target: new internal_1.Identity({ did }, context),
+                    amount: new bignumber_js_1.default(balance).shiftedBy(-6),
+                    withheldTax: new bignumber_js_1.default(tax).shiftedBy(-4),
+                });
+            });
+            /* eslint-enable @typescript-eslint/no-non-null-assertion */
+            const next = (0, internal_2.calculateNextKey)(count, size, start);
+            let hashes = [];
+            if (multiParams.length) {
+                hashes = yield system.blockHash.multi(multiParams);
+            }
+            return {
+                data: data.map((payment, index) => (Object.assign(Object.assign({}, payment), { blockHash: (0, conversion_1.hashToString)(hashes[index]) }))),
+                next,
+                count,
+            };
+        });
+    }
+    /**
+     * @hidden
+     */
+    getParticipantStatuses(participants) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { asset: { ticker }, id: localId, context: { polymeshApi: { query: { capitalDistribution }, }, }, context, } = this;
+            /*
+             * For optimization, we separate the participants into chunks that can fit into one multi call
+             * and then sequentially perform bunches of said multi requests in parallel
+             */
+            const participantChunks = (0, lodash_1.chunk)(participants, constants_1.MAX_PAGE_SIZE.toNumber());
+            const parallelCallChunks = (0, lodash_1.chunk)(participantChunks, constants_1.MAX_CONCURRENT_REQUESTS);
+            let paidStatuses = [];
+            const caId = (0, conversion_1.corporateActionIdentifierToCaId)({ localId, ticker }, context);
+            yield bluebird_1.default.each(parallelCallChunks, (callChunk) => __awaiter(this, void 0, void 0, function* () {
+                const parallelMultiCalls = callChunk.map(participantChunk => {
+                    const multiParams = participantChunk.map(({ identity: { did } }) => (0, utils_1.tuple)(caId, (0, conversion_1.stringToIdentityId)(did, context)));
+                    return capitalDistribution.holderPaid.multi(multiParams);
+                });
+                const results = yield Promise.all(parallelMultiCalls);
+                paidStatuses = [...paidStatuses, ...(0, lodash_1.flatten)(results).map(paid => (0, conversion_1.boolToBoolean)(paid))];
+            }));
+            return paidStatuses;
+        });
+    }
+    /**
+     * Return the Dividend Distribution's static data
+     */
+    toHuman() {
+        const { origin, currency, perShare, maxAmount, expiryDate, paymentDate } = this;
+        const parentReadable = super.toHuman();
+        return Object.assign(Object.assign({}, (0, internal_2.toHumanReadable)({ origin, currency, perShare, maxAmount, expiryDate, paymentDate })), parentReadable);
+    }
+}
+exports.DividendDistribution = DividendDistribution;
+//# sourceMappingURL=index.js.map

package/api/entities/DividendDistribution/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/entities/DividendDistribution/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,gEAAqC;AACrC,wDAAyB;AACzB,mCAAgD;AAOhD,gDAeoB;AACpB,yDAA+F;AAG/F,0CAWiB;AACjB,gDAA2F;AAC3F,wDAAyF;AACzF,0DAO4B;AAC5B,sDAM0B;AAwB1B,MAAM,gBAAgB,GAAG,4CAA4C,CAAC;AAEtE;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,8BAAmB;IAuC3D;;OAEG;IACH,YAAmB,IAAgC,EAAE,OAAgB;QACnE,MAAM,EACJ,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,UAAU,EACV,WAAW,KAET,IAAI,EADH,mBAAmB,UACpB,IAAI,EARF,4EAQL,CAAO,CAAC;QAET,KAAK,mBAAM,mBAAmB,GAAI,OAAO,CAAC,CAAC;QAE3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAE/B,IAAI,CAAC,GAAG,GAAG,IAAA,gCAAqB,EAC9B;YACE,mBAAmB,EAAE,gBAAgB,CAAC,EAAE,CAAC;gBACvC,uBAAY;gDACP,gBAAgB,KAAE,YAAY,EAAE,IAAI;aAC1C;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,IAAA,gCAAqB,EAChC,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,yBAAc,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EACvF,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C;YACE,mBAAmB,EAAE,oBAAoB,CAAC,EAAE,CAAC;gBAC3C,uCAA4B;gCAC1B,YAAY,EAAE,IAAI,IAAK,oBAAoB;aAC9C;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,IAAA,gCAAqB,EACvC;YACE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,2CAAgC,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;YACrF,QAAQ,EAAE,IAAI;SACf,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAwCD;;;OAGG;IACmB,UAAU;;;;;YAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;YAEnC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,MAAM,UAAU,GAAG,MAAM,OAAM,UAAU,WAAE,CAAC;YAE5C,oEAAoE;YACpE,OAAO,UAAW,CAAC;QACrB,CAAC;KAAA;IAED;;OAEG;IACmB,MAAM;;YAC1B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAEpD,OAAO,YAAY,CAAC,MAAM,CAAC;QAC7B,CAAC;KAAA;IAED;;OAEG;IACU,OAAO;;YAClB,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAEpD,IAAI,YAAY,CAAC,MAAM,EAAE;gBACvB,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YAEvD,OAAO;gBACL,cAAc,EAAE,IAAA,+BAAkB,EAAC,SAAS,CAAC;gBAC7C,cAAc,EAAE,IAAA,0BAAa,EAAC,SAAS,CAAC;aACzC,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;;OAOG;IACU,eAAe;;YAC1B,MAAM,EACJ,OAAO,EAAE,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,EACpD,WAAW,GACZ,GAAG,IAAI,CAAC;YAET,IAAI,QAAQ,GAAsB,EAAE,CAAC;YAErC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAE3C,IAAI,UAAU,YAAY,6BAAkB,EAAE;gBAC5C,OAAO,EAAE,CAAC;aACX;YAED,IAAI,UAAU,GAAG,KAAK,CAAC;YACvB,IAAI,KAAyB,CAAC;YAE9B,OAAO,CAAC,UAAU,EAAE;gBAClB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,yBAAa,EAAE,KAAK,EAAE,CAAC,CAAC;gBACpF,KAAK,GAAI,IAAe,IAAI,SAAS,CAAC;gBACtC,UAAU,GAAG,CAAC,IAAI,CAAC;gBACnB,QAAQ,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;aACnC;YAED,MAAM,WAAW,GAAG,SAAS,KAAK,uBAAe,CAAC,OAAO,CAAC;YAE1D,MAAM,YAAY,GAA8B,EAAE,CAAC;YACnD,MAAM,aAAa,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC;YAE5C,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;gBACzC,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAA,eAAM,EAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;gBACpF,IAAI,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAA,cAAG,EAAC,QAAQ,EAAE,WAAW,CAAC,EAAE;oBAC/C,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;iBAChE;YACH,CAAC,CAAC,CAAC;YAEH,qDAAqD;YACrD,IAAI,WAAW,GAAG,IAAI,IAAI,EAAE,EAAE;gBAC5B,OAAO,YAAY,CAAC;aACrB;YAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;YAErE,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,iCAAM,YAAY,CAAC,KAAK,CAAC,KAAE,IAAI,IAAG,CAAC,CAAC;QAC/E,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,cAAc,CAAC,IAE3B;;YACC,MAAM,EACJ,EAAE,EAAE,OAAO,EACX,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,EACpD,WAAW,EACX,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAE3C,IAAI,UAAU,YAAY,6BAAkB,EAAE;gBAC5C,OAAO,IAAI,CAAC;aACb;YAED,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC5C,IAAA,sBAAW,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE,OAAO,CAAC;gBACpC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;aACzB,CAAC,CAAC;YAEH,MAAM,QAAQ,GAAG,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAoC,CAAC;YAEzC,MAAM,WAAW,GAAG,SAAS,KAAK,uBAAe,CAAC,OAAO,CAAC;YAE1D,IAAI,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAA,cAAG,EAAC,QAAQ,EAAE,WAAW,CAAC,EAAE;gBAC/C,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC3D;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;YAED,oDAAoD;YACpD,IAAI,WAAW,GAAG,IAAI,IAAI,EAAE,EAAE;gBAC5B,OAAO,WAAW,CAAC;aACpB;YAED,MAAM,MAAM,GAAG,IAAA,+BAAkB,EAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,IAAA,4CAA+B,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;YAC9E,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;YACjF,MAAM,IAAI,GAAG,IAAA,0BAAa,EAAC,UAAU,CAAC,CAAC;YAEvC,uCAAY,WAAW,KAAE,IAAI,IAAG;QAClC,CAAC;KAAA;IAED;;OAEG;IACK,mBAAmB,CAAC,QAAkB,EAAE,OAAkB;QAChE,MAAM,EAAE,qBAAqB,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAElE,IAAI,wBAAwB,GAAG,qBAAqB,CAAC;QAErD,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,EAAE,CACxE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAC9B,CAAC;QACF,IAAI,cAAc,EAAE;YAClB,wBAAwB,GAAG,cAAc,CAAC,UAAU,CAAC;SACtD;QAED,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE9C,MAAM,cAAc,GAAG,MAAM;aAC1B,KAAK,CACJ,MAAM,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,wBAAY,CAAC,CACzF;aACA,aAAa,CAAC,wBAAY,CAAC,CAAC;QAE/B,OAAO;YACL,QAAQ;YACR,MAAM;YACN,wBAAwB;YACxB,cAAc;YACd,IAAI,EAAE,KAAK;SACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,iBAAiB;QACvB,MAAM,EACJ,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,EACF,OAAO,GACR,GAAG,IAAI,CAAC;QAET,OAAO,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAChE,IAAA,4CAA+B,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACU,cAAc;;YACzB,MAAM,EACJ,EAAE,EACF,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CACxC,IAAA,iCAAuB,EAAC;gBACtB,gEAAgE;gBAChE,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE;aACzC,CAAC,CACH,CAAC;YAEF,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YAExE,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,oEAAoE;YACpE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,uBAAwB,CAAC;YAEvD,OAAO,IAAI,sBAAS,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;KAAA;IAED;;;;;OAKG;IACU,iBAAiB,CAC5B,OAAgD,EAAE;;YAElD,MAAM,EACJ,EAAE,EACF,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,MAAM,EAAE,GAClB,GACF,GACF,GAAG,IAAI,CAAC;YACT,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;YAE7B,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAG7C,IAAA,wCAA8B,EAAC;gBAC7B,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACxC,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,IAAI;gBACZ,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;gBACvB,IAAI,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,EAAE;aACxB,CAAC,CACH,CAAC;YAEF,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC;YAE7E,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,MAAM,EACJ,IAAI,EAAE,EAAE,8BAA8B,EAAE,oCAAoC,EAAE,GAC/E,GAAG,MAAM,CAAC;YAEX,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,oCAAoC,CAAC;YAEnE,MAAM,KAAK,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,IAAI,GAA6C,EAAE,CAAC;YAC1D,MAAM,WAAW,GAAkB,EAAE,CAAC;YAEtC,6DAA6D;YAC7D,KAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACpB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAK,CAAC;gBAEjE,MAAM,WAAW,GAAG,IAAI,sBAAS,CAAC,OAAO,CAAC,CAAC;gBAC3C,WAAW,CAAC,IAAI,CAAC,IAAA,2BAAc,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;gBACvD,IAAI,CAAC,IAAI,CAAC;oBACR,WAAW;oBACX,IAAI,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC;oBACxB,MAAM,EAAE,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC;oBACtC,MAAM,EAAE,IAAI,sBAAS,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC5C,WAAW,EAAE,IAAI,sBAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;iBAC9C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,4DAA4D;YAE5D,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAElD,IAAI,MAAM,GAAW,EAAE,CAAC;YAExB,IAAI,WAAW,CAAC,MAAM,EAAE;gBACtB,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAA2C,WAAW,CAAC,CAAC;aAC9F;YAED,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,iCAC9B,OAAO,KACV,SAAS,EAAE,IAAA,yBAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IACtC,CAAC;gBACH,IAAI;gBACJ,KAAK;aACN,CAAC;QACJ,CAAC;KAAA;IAED;;OAEG;IACW,sBAAsB,CAClC,YAAuC;;YAEvC,MAAM,EACJ,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,EAAE,OAAO,EACX,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,mBAAmB,EAAE,GAC/B,GACF,EACD,OAAO,GACR,GAAG,IAAI,CAAC;YAET;;;eAGG;YACH,MAAM,iBAAiB,GAAG,IAAA,cAAK,EAAC,YAAY,EAAE,yBAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxE,MAAM,kBAAkB,GAAG,IAAA,cAAK,EAAC,iBAAiB,EAAE,mCAAuB,CAAC,CAAC;YAE7E,IAAI,YAAY,GAAc,EAAE,CAAC;YAEjC,MAAM,IAAI,GAAG,IAAA,4CAA+B,EAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;YAE3E,MAAM,kBAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAM,SAAS,EAAC,EAAE;gBACjD,MAAM,kBAAkB,GAAG,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE;oBAC1D,MAAM,WAAW,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CACjE,IAAA,aAAK,EAAC,IAAI,EAAE,IAAA,+BAAkB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAC9C,CAAC;oBAEF,OAAO,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAEzC,WAAW,CAAC,CAAC;gBACjB,CAAC,CAAC,CAAC;gBAEH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAEtD,YAAY,GAAG,CAAC,GAAG,YAAY,EAAE,GAAG,IAAA,gBAAO,EAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,0BAAa,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACzF,CAAC,CAAA,CAAC,CAAC;YAEH,OAAO,YAAY,CAAC;QACtB,CAAC;KAAA;IAED;;OAEG;IACa,OAAO;QACrB,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAEhF,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;QAEvC,uCACK,IAAA,0BAAe,EAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,GACnF,cAAc,EACjB;IACJ,CAAC;CACF;AA5gBD,oDA4gBC"}

package/api/entities/DividendDistribution/types.d.ts

@@ -0,0 +1,24 @@
+import BigNumber from 'bignumber.js';
+import { Identity } from "../../../internal";
+export interface DividendDistributionDetails {
+    remainingFunds: BigNumber;
+    /**
+     * whether the unclaimed funds have been reclaimed
+     */
+    fundsReclaimed: boolean;
+}
+export interface DistributionParticipant {
+    identity: Identity;
+    amount: BigNumber;
+    /**
+     * percentage (0-100) of tax withholding for this participant
+     */
+    taxWithholdingPercentage: BigNumber;
+    /**
+     * amount to be paid to the participant after tax deductions
+     */
+    amountAfterTax: BigNumber;
+    paid: boolean;
+}
+export { DividendDistributionParams } from '.';
+//# sourceMappingURL=types.d.ts.map

package/api/entities/DividendDistribution/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/DividendDistribution/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,0BAAmB;AAEtC,MAAM,WAAW,2BAA2B;IAC1C,cAAc,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,wBAAwB,EAAE,SAAS,CAAC;IACpC;;OAEG;IACH,cAAc,EAAE,SAAS,CAAC;IAC1B,IAAI,EAAE,OAAO,CAAC;CACf;AAED,OAAO,EAAE,0BAA0B,EAAE,MAAM,GAAG,CAAC"}

package/api/entities/DividendDistribution/types.js

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

package/api/entities/DividendDistribution/types.js.map

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

package/api/entities/Entity.d.ts

@@ -0,0 +1,43 @@
+import { Context } from "../../internal";
+/**
+ * Represents an object or resource in the Polymesh Ecosystem with its own set of properties and functionality
+ */
+export declare abstract class Entity<UniqueIdentifiers, HumanReadable> {
+    /**
+     * Generate the Entity's UUID from its identifying properties
+     *
+     * @param identifiers
+     */
+    static generateUuid<Identifiers>(identifiers: Identifiers): string;
+    /**
+     * Unserialize a UUID into its Unique Identifiers
+     *
+     * @param serialized - UUID to unserialize
+     */
+    static unserialize<Identifiers>(serialized: string): Identifiers;
+    /**
+     * Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden
+     *
+     * @param identifiers - object to type check
+     */
+    static isUniqueIdentifiers(identifiers: unknown): boolean;
+    uuid: string;
+    protected context: Context;
+    /**
+     * @hidden
+     */
+    constructor(identifiers: UniqueIdentifiers, context: Context);
+    /**
+     * Determine whether this Entity is the same as another one
+     */
+    isEqual(entity: Entity<unknown, unknown>): boolean;
+    /**
+     * Determine whether this Entity exists on chain
+     */
+    abstract exists(): Promise<boolean>;
+    /**
+     * Returns Entity data in a human readable (JSON) format
+     */
+    abstract toHuman(): HumanReadable;
+}
+//# sourceMappingURL=Entity.d.ts.map

package/api/entities/Entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../src/api/entities/Entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,uBAAmB;AAIpD;;GAEG;AACH,8BAAsB,MAAM,CAAC,iBAAiB,EAAE,aAAa;IAC3D;;;;OAIG;WACW,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,GAAG,MAAM;IAIzE;;;;OAIG;WACW,WAAW,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,GAAG,WAAW;IAcvE;;;;OAIG;WACW,mBAAmB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAIzD,IAAI,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAE3B;;OAEG;gBACS,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IAK5D;;OAEG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO;IAIzD;;OAEG;aACa,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAE1C;;OAEG;aACa,OAAO,IAAI,aAAa;CACzC"}