@polymeshassociation/polymesh-sdk 14.0.0-beta.11

package/api/entities/Checkpoint.d.ts

@@ -0,0 +1,71 @@
+import BigNumber from 'bignumber.js';
+import { Asset, Context, Entity, Identity } from "../../internal";
+import { IdentityBalance, PaginationOptions, ResultSet } from "../../types";
+export interface UniqueIdentifiers {
+    id: BigNumber;
+    ticker: string;
+}
+interface HumanReadable {
+    id: string;
+    ticker: string;
+}
+/**
+ * Represents a snapshot of the Asset's holders and their respective balances
+ *   at a certain point in time
+ */
+export declare class Checkpoint extends Entity<UniqueIdentifiers, HumanReadable> {
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier: unknown): identifier is UniqueIdentifiers;
+    /**
+     * Checkpoint identifier number
+     */
+    id: BigNumber;
+    /**
+     * Asset whose balances are being recorded in this Checkpoint
+     */
+    asset: Asset;
+    /**
+     * @hidden
+     */
+    constructor(identifiers: UniqueIdentifiers, context: Context);
+    /**
+     * Retrieve the Asset's total supply at this checkpoint
+     */
+    totalSupply(): Promise<BigNumber>;
+    /**
+     * Retrieve this Checkpoint's creation date
+     */
+    createdAt(): Promise<Date>;
+    /**
+     * Retrieve all Asset Holder balances at this Checkpoint
+     *
+     * @note supports pagination
+     * @note current Asset holders who didn't hold any tokens when the Checkpoint was created will be listed with a balance of 0.
+     * This arises from a chain storage optimization and pagination. @see {@link balance} for a more detailed explanation of the logic
+     */
+    allBalances(paginationOpts?: PaginationOptions): Promise<ResultSet<IdentityBalance>>;
+    /**
+     * Retrieve the balance of a specific Asset Holder Identity at this Checkpoint
+     *
+     * @param args.identity - defaults to the signing Identity
+     * @note A checkpoint only records balances when they change. The implementation is to query for all balance updates for [ticker, did] pair.
+     * If no balance updates have happened since the Checkpoint has been created, then the storage will not have an entry for the user. Instead the current balance should be used.
+     * The balance is stored only when the Identity makes a transaction after a Checkpoint is created. This helps keep storage usage to a minimum
+     */
+    balance(args?: {
+        identity: string | Identity;
+    }): Promise<BigNumber>;
+    /**
+     * Determine whether this Checkpoint exists on chain
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Return the Checkpoint's ticker and identifier
+     */
+    toHuman(): HumanReadable;
+}
+export {};
+//# sourceMappingURL=Checkpoint.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Checkpoint.d.ts","sourceRoot":"","sources":["../../../src/api/entities/Checkpoint.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAGrC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,uBAAmB;AAC9D,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,SAAS,EAAE,oBAAgB;AAaxE,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,SAAS,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,UAAW,SAAQ,MAAM,CAAC,iBAAiB,EAAE,aAAa,CAAC;IACtE;;;OAGG;WACoB,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,iBAAiB;IAMhG;;OAEG;IACI,EAAE,EAAE,SAAS,CAAC;IAErB;;OAEG;IACI,KAAK,EAAE,KAAK,CAAC;IAEpB;;OAEG;gBACgB,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IASnE;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC;IAe9C;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAevC;;;;;;OAMG;IACU,WAAW,CACtB,cAAc,CAAC,EAAE,iBAAiB,GACjC,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAmFtC;;;;;;;OAOG;IACU,OAAO,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,CAAC;IAyChF;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAiBvC;;OAEG;IACI,OAAO,IAAI,aAAa;CAQhC"}

package/api/entities/Checkpoint.js

@@ -0,0 +1,180 @@
+"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.Checkpoint = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const internal_1 = require("../../internal");
+const utils_1 = require("../../types/utils");
+const conversion_1 = require("../../utils/conversion");
+const internal_2 = require("../../utils/internal");
+/**
+ * Represents a snapshot of the Asset's holders and their respective balances
+ *   at a certain point in time
+ */
+class Checkpoint extends internal_1.Entity {
+    /**
+     * @hidden
+     */
+    constructor(identifiers, context) {
+        super(identifiers, context);
+        const { id, ticker } = identifiers;
+        this.id = id;
+        this.asset = new internal_1.Asset({ ticker }, context);
+    }
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier) {
+        const { id, ticker } = identifier;
+        return id instanceof bignumber_js_1.default && typeof ticker === 'string';
+    }
+    /**
+     * Retrieve the Asset's total supply at this checkpoint
+     */
+    totalSupply() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, asset: { ticker }, id, } = this;
+            const rawSupply = yield context.polymeshApi.query.checkpoint.totalSupply((0, conversion_1.stringToTicker)(ticker, context), (0, conversion_1.bigNumberToU64)(id, context));
+            return (0, conversion_1.balanceToBigNumber)(rawSupply);
+        });
+    }
+    /**
+     * Retrieve this Checkpoint's creation date
+     */
+    createdAt() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, asset: { ticker }, id, } = this;
+            const creationTime = yield context.polymeshApi.query.checkpoint.timestamps((0, conversion_1.stringToTicker)(ticker, context), (0, conversion_1.bigNumberToU64)(id, context));
+            return (0, conversion_1.momentToDate)(creationTime);
+        });
+    }
+    /**
+     * Retrieve all Asset Holder balances at this Checkpoint
+     *
+     * @note supports pagination
+     * @note current Asset holders who didn't hold any tokens when the Checkpoint was created will be listed with a balance of 0.
+     * This arises from a chain storage optimization and pagination. @see {@link balance} for a more detailed explanation of the logic
+     */
+    allBalances(paginationOpts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { checkpoint, asset }, }, }, context, asset: { ticker }, id, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            // Get one page of current Asset balances
+            const { entries, lastKey: next } = yield (0, internal_2.requestPaginated)(asset.balanceOf, {
+                arg: rawTicker,
+                paginationOpts,
+            });
+            const currentDidBalances = [];
+            const balanceUpdatesMultiParams = [];
+            // Prepare the query for balance updates. Push to currentDidBalances to be used if there are no updates for the balance
+            entries.forEach(([storageKey, balance]) => {
+                const { args: [, identityId], } = storageKey;
+                currentDidBalances.push({
+                    did: (0, conversion_1.identityIdToString)(identityId),
+                    balance: (0, conversion_1.balanceToBigNumber)(balance),
+                });
+                balanceUpdatesMultiParams.push((0, utils_1.tuple)(rawTicker, identityId));
+            });
+            // Query for balance updates
+            const rawBalanceUpdates = yield checkpoint.balanceUpdates.multi(balanceUpdatesMultiParams);
+            const checkpointBalanceMultiParams = [];
+            const currentIdentityBalances = [];
+            rawBalanceUpdates.forEach((rawCheckpointIds, index) => {
+                const firstUpdatedCheckpoint = rawCheckpointIds.find(checkpointId => (0, conversion_1.u64ToBigNumber)(checkpointId).gte(id));
+                const { did, balance } = currentDidBalances[index];
+                if (firstUpdatedCheckpoint) {
+                    // If a balance update has occurred for the Identity since the desired Checkpoint, then query Checkpoint storage directly
+                    checkpointBalanceMultiParams.push({
+                        did,
+                        params: (0, utils_1.tuple)([rawTicker, firstUpdatedCheckpoint], (0, conversion_1.stringToIdentityId)(did, context)),
+                    });
+                }
+                else {
+                    // Otherwise use the current balance
+                    currentIdentityBalances.push({
+                        identity: new internal_1.Identity({ did }, context),
+                        balance,
+                    });
+                }
+            });
+            // Query for Identities with balance updates
+            const checkpointBalances = yield checkpoint.balance.multi(checkpointBalanceMultiParams.map(({ params }) => params));
+            return {
+                data: [
+                    ...checkpointBalanceMultiParams.map(({ did }, index) => ({
+                        identity: new internal_1.Identity({ did }, context),
+                        balance: (0, conversion_1.balanceToBigNumber)(checkpointBalances[index]),
+                    })),
+                    ...currentIdentityBalances,
+                ],
+                next,
+            };
+        });
+    }
+    /**
+     * Retrieve the balance of a specific Asset Holder Identity at this Checkpoint
+     *
+     * @param args.identity - defaults to the signing Identity
+     * @note A checkpoint only records balances when they change. The implementation is to query for all balance updates for [ticker, did] pair.
+     * If no balance updates have happened since the Checkpoint has been created, then the storage will not have an entry for the user. Instead the current balance should be used.
+     * The balance is stored only when the Identity makes a transaction after a Checkpoint is created. This helps keep storage usage to a minimum
+     */
+    balance(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, context: { polymeshApi: { query: { checkpoint }, }, }, asset: { ticker }, id, } = this;
+            const identity = yield (0, internal_2.getIdentity)(args === null || args === void 0 ? void 0 : args.identity, context);
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const rawIdentityId = (0, conversion_1.stringToIdentityId)(identity.did, context);
+            const balanceUpdates = yield checkpoint.balanceUpdates(rawTicker, rawIdentityId);
+            const firstUpdatedCheckpoint = balanceUpdates.find(checkpointId => (0, conversion_1.u64ToBigNumber)(checkpointId).gte(id));
+            /*
+             * If there has been a balance change since the Checkpoint was created, then query the Checkpoint storage.
+             * Otherwise, the storage will not have an entry for the Identity. The current balance should be queried instead.
+             */
+            let balance;
+            if (firstUpdatedCheckpoint) {
+                const rawBalance = yield checkpoint.balance((0, utils_1.tuple)(rawTicker, firstUpdatedCheckpoint), rawIdentityId);
+                balance = (0, conversion_1.balanceToBigNumber)(rawBalance);
+            }
+            else {
+                // if no balanceUpdate has occurred since the Checkpoint has been created, then the current balance should be used. The Checkpoint storage will not have an entry
+                balance = yield identity.getAssetBalance({ ticker });
+            }
+            return balance;
+        });
+    }
+    /**
+     * Determine whether this Checkpoint exists on chain
+     */
+    exists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { checkpoint }, }, }, context, asset: { ticker }, id, } = this;
+            const rawCheckpointId = yield checkpoint.checkpointIdSequence((0, conversion_1.stringToTicker)(ticker, context));
+            return id.lte((0, conversion_1.u64ToBigNumber)(rawCheckpointId));
+        });
+    }
+    /**
+     * Return the Checkpoint's ticker and identifier
+     */
+    toHuman() {
+        const { asset, id } = this;
+        return (0, internal_2.toHumanReadable)({
+            ticker: asset,
+            id,
+        });
+    }
+}
+exports.Checkpoint = Checkpoint;
+//# sourceMappingURL=Checkpoint.js.map

package/api/entities/Checkpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Checkpoint.js","sourceRoot":"","sources":["../../../src/api/entities/Checkpoint.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gEAAqC;AAGrC,6CAA8D;AAE9D,6CAAuD;AACvD,uDAQ4B;AAC5B,mDAAkF;AAYlF;;;GAGG;AACH,MAAa,UAAW,SAAQ,iBAAwC;IAqBtE;;OAEG;IACH,YAAmB,WAA8B,EAAE,OAAgB;QACjE,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;QAEnC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IA9BD;;;OAGG;IACI,MAAM,CAAU,mBAAmB,CAAC,UAAmB;QAC5D,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,UAA+B,CAAC;QAEvD,OAAO,EAAE,YAAY,sBAAS,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC;IAC/D,CAAC;IAwBD;;OAEG;IACU,WAAW;;YACtB,MAAM,EACJ,OAAO,EACP,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,GACH,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CACtE,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAA,2BAAc,EAAC,EAAE,EAAE,OAAO,CAAC,CAC5B,CAAC;YAEF,OAAO,IAAA,+BAAkB,EAAC,SAAS,CAAC,CAAC;QACvC,CAAC;KAAA;IAED;;OAEG;IACU,SAAS;;YACpB,MAAM,EACJ,OAAO,EACP,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,GACH,GAAG,IAAI,CAAC;YAET,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CACxE,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAA,2BAAc,EAAC,EAAE,EAAE,OAAO,CAAC,CAC5B,CAAC;YAEF,OAAO,IAAA,yBAAY,EAAC,YAAY,CAAC,CAAC;QACpC,CAAC;KAAA;IAED;;;;;;OAMG;IACU,WAAW,CACtB,cAAkC;;YAElC,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,GAC7B,GACF,EACD,OAAO,EACP,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,GACH,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,yCAAyC;YACzC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,2BAAgB,EAAC,KAAK,CAAC,SAAS,EAAE;gBACzE,GAAG,EAAE,SAAS;gBACd,cAAc;aACf,CAAC,CAAC;YAEH,MAAM,kBAAkB,GAA0C,EAAE,CAAC;YACrE,MAAM,yBAAyB,GAA2B,EAAE,CAAC;YAE7D,uHAAuH;YACvH,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,EAAE;gBACxC,MAAM,EACJ,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,GACrB,GAAG,UAAU,CAAC;gBACf,kBAAkB,CAAC,IAAI,CAAC;oBACtB,GAAG,EAAE,IAAA,+BAAkB,EAAC,UAAU,CAAC;oBACnC,OAAO,EAAE,IAAA,+BAAkB,EAAC,OAAO,CAAC;iBACrC,CAAC,CAAC;gBACH,yBAAyB,CAAC,IAAI,CAAC,IAAA,aAAK,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YAEH,4BAA4B;YAC5B,MAAM,iBAAiB,GAAG,MAAM,UAAU,CAAC,cAAc,CAAC,KAAK,CAE7D,yBAAyB,CAAC,CAAC;YAE7B,MAAM,4BAA4B,GAG5B,EAAE,CAAC;YACT,MAAM,uBAAuB,GAAsB,EAAE,CAAC;YAEtD,iBAAiB,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,KAAK,EAAE,EAAE;gBACpD,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAClE,IAAA,2BAAc,EAAC,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CACrC,CAAC;gBACF,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBACnD,IAAI,sBAAsB,EAAE;oBAC1B,yHAAyH;oBACzH,4BAA4B,CAAC,IAAI,CAAC;wBAChC,GAAG;wBACH,MAAM,EAAE,IAAA,aAAK,EAAC,CAAC,SAAS,EAAE,sBAAsB,CAAC,EAAE,IAAA,+BAAkB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;qBACrF,CAAC,CAAC;iBACJ;qBAAM;oBACL,oCAAoC;oBACpC,uBAAuB,CAAC,IAAI,CAAC;wBAC3B,QAAQ,EAAE,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC;wBACxC,OAAO;qBACR,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;YAEH,4CAA4C;YAC5C,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,CAEvD,4BAA4B,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;YAE5D,OAAO;gBACL,IAAI,EAAE;oBACJ,GAAG,4BAA4B,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;wBACvD,QAAQ,EAAE,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC;wBACxC,OAAO,EAAE,IAAA,+BAAkB,EAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;qBACvD,CAAC,CAAC;oBACH,GAAG,uBAAuB;iBAC3B;gBACD,IAAI;aACL,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;;OAOG;IACU,OAAO,CAAC,IAAsC;;YACzD,MAAM,EACJ,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,UAAU,EAAE,GACtB,GACF,EACD,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,GACH,GAAG,IAAI,CAAC;YAET,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAW,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAE5D,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,aAAa,GAAG,IAAA,+BAAkB,EAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAEhE,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACjF,MAAM,sBAAsB,GAAG,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAChE,IAAA,2BAAc,EAAC,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CACrC,CAAC;YAEF;;;eAGG;YACH,IAAI,OAAkB,CAAC;YACvB,IAAI,sBAAsB,EAAE;gBAC1B,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,OAAO,CACzC,IAAA,aAAK,EAAC,SAAS,EAAE,sBAAsB,CAAC,EACxC,aAAa,CACd,CAAC;gBACF,OAAO,GAAG,IAAA,+BAAkB,EAAC,UAAU,CAAC,CAAC;aAC1C;iBAAM;gBACL,iKAAiK;gBACjK,OAAO,GAAG,MAAM,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;aACtD;YAED,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;OAEG;IACU,MAAM;;YACjB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,UAAU,EAAE,GACtB,GACF,EACD,OAAO,EACP,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,GACH,GAAG,IAAI,CAAC;YAET,MAAM,eAAe,GAAG,MAAM,UAAU,CAAC,oBAAoB,CAAC,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAE/F,OAAO,EAAE,CAAC,GAAG,CAAC,IAAA,2BAAc,EAAC,eAAe,CAAC,CAAC,CAAC;QACjD,CAAC;KAAA;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC;QAE3B,OAAO,IAAA,0BAAe,EAAC;YACrB,MAAM,EAAE,KAAK;YACb,EAAE;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAjPD,gCAiPC"}

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

@@ -0,0 +1,83 @@
+import BigNumber from 'bignumber.js';
+import { Asset, Checkpoint, Context, Entity } from "../../../internal";
+import { CalendarPeriod, CalendarUnit, ScheduleDetails } from "../../../types";
+export interface UniqueIdentifiers {
+    id: BigNumber;
+    ticker: string;
+}
+interface CalendarPeriodHumanReadable {
+    unit: CalendarUnit;
+    amount: string;
+}
+interface HumanReadable {
+    id: string;
+    ticker: string;
+    period: CalendarPeriodHumanReadable | null;
+    start: string;
+    expiryDate: string | null;
+    complexity: string;
+}
+export interface Params {
+    period: CalendarPeriod;
+    start: Date;
+    remaining: BigNumber;
+    nextCheckpointDate: Date;
+}
+/**
+ * Represents a Checkpoint Schedule for an Asset. Schedules can be set up to create Checkpoints at regular intervals
+ */
+export declare class CheckpointSchedule extends Entity<UniqueIdentifiers, HumanReadable> {
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier: unknown): identifier is UniqueIdentifiers;
+    /**
+     * schedule identifier number
+     */
+    id: BigNumber;
+    /**
+     * Asset for which Checkpoints are scheduled
+     */
+    asset: Asset;
+    /**
+     * how often this Schedule creates a Checkpoint. A null value means this Schedule
+     *   creates a single Checkpoint and then expires
+     */
+    period: CalendarPeriod | null;
+    /**
+     * first Checkpoint creation date
+     */
+    start: Date;
+    /**
+     * date at which the last Checkpoint will be created with this Schedule.
+     *   A null value means that this Schedule never expires
+     */
+    expiryDate: Date | null;
+    /**
+     * abstract measure of the complexity of this Schedule. Shorter periods translate into more complexity
+     */
+    complexity: BigNumber;
+    /**
+     * @hidden
+     */
+    constructor(args: UniqueIdentifiers & Params, context: Context);
+    /**
+     * Retrieve information specific to this Schedule
+     */
+    details(): Promise<ScheduleDetails>;
+    /**
+     * Retrieve all Checkpoints created by this Schedule
+     */
+    getCheckpoints(): Promise<Checkpoint[]>;
+    /**
+     * Determine whether this Checkpoint Schedule exists on chain
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Return the Schedule's static data
+     */
+    toHuman(): HumanReadable;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/CheckpointSchedule/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAGrC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAiB,0BAAmB;AAC/E,OAAO,EAAE,cAAc,EAAE,YAAY,EAAa,eAAe,EAAE,uBAAgB;AAUnF,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,SAAS,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,2BAA2B;IACnC,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,2BAA2B,GAAG,IAAI,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,cAAc,CAAC;IACvB,KAAK,EAAE,IAAI,CAAC;IACZ,SAAS,EAAE,SAAS,CAAC;IACrB,kBAAkB,EAAE,IAAI,CAAC;CAC1B;AAID;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,MAAM,CAAC,iBAAiB,EAAE,aAAa,CAAC;IAC9E;;;OAGG;WACoB,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,iBAAiB;IAMhG;;OAEG;IACI,EAAE,EAAE,SAAS,CAAC;IAErB;;OAEG;IACI,KAAK,EAAE,KAAK,CAAC;IAEpB;;;OAGG;IACI,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAErC;;OAEG;IACI,KAAK,EAAE,IAAI,CAAC;IAEnB;;;OAGG;IACI,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACI,UAAU,EAAE,SAAS,CAAC;IAE7B;;OAEG;gBACgB,IAAI,EAAE,iBAAiB,GAAG,MAAM,EAAE,OAAO,EAAE,OAAO;IA4BrE;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC;IA+BhD;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IA6BpD;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAmBvC;;OAEG;IACI,OAAO,IAAI,aAAa;CAYhC"}

package/api/entities/CheckpointSchedule/index.js

@@ -0,0 +1,137 @@
+"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.CheckpointSchedule = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const dayjs_1 = __importDefault(require("dayjs"));
+const internal_1 = require("../../../internal");
+const types_1 = require("../../../types");
+const conversion_1 = require("../../../utils/conversion");
+const internal_2 = require("../../../utils/internal");
+const notExistsMessage = 'Schedule no longer exists. It was either removed or it expired';
+/**
+ * Represents a Checkpoint Schedule for an Asset. Schedules can be set up to create Checkpoints at regular intervals
+ */
+class CheckpointSchedule extends internal_1.Entity {
+    /**
+     * @hidden
+     */
+    constructor(args, context) {
+        const { period, start, remaining, nextCheckpointDate } = args, identifiers = __rest(args, ["period", "start", "remaining", "nextCheckpointDate"]);
+        super(identifiers, context);
+        const { id, ticker } = identifiers;
+        const noPeriod = period.amount.isZero();
+        this.id = id;
+        this.asset = new internal_1.Asset({ ticker }, context);
+        this.period = noPeriod ? null : period;
+        this.start = start;
+        this.complexity = (0, internal_2.periodComplexity)(period);
+        if (remaining.isZero() && !noPeriod) {
+            this.expiryDate = null;
+        }
+        else if (!this.period) {
+            this.expiryDate = start;
+        }
+        else {
+            const { amount, unit } = period;
+            this.expiryDate = (0, dayjs_1.default)(nextCheckpointDate)
+                .add(amount.multipliedBy(remaining.minus(1)).toNumber(), unit)
+                .toDate();
+        }
+    }
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier) {
+        const { id, ticker } = identifier;
+        return id instanceof bignumber_js_1.default && typeof ticker === 'string';
+    }
+    /**
+     * Retrieve information specific to this Schedule
+     */
+    details() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { checkpoint }, }, }, id, context, asset: { ticker }, } = this;
+            const rawSchedules = yield checkpoint.schedules((0, conversion_1.stringToTicker)(ticker, context));
+            const schedule = rawSchedules.find(({ id: scheduleId }) => (0, conversion_1.u64ToBigNumber)(scheduleId).eq(id));
+            if (!schedule) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            const { at, remaining } = schedule;
+            return {
+                remainingCheckpoints: (0, conversion_1.u32ToBigNumber)(remaining),
+                nextCheckpointDate: (0, conversion_1.momentToDate)(at),
+            };
+        });
+    }
+    /**
+     * Retrieve all Checkpoints created by this Schedule
+     */
+    getCheckpoints() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { checkpoint }, }, }, context, asset: { ticker }, id, } = this;
+            const exists = yield this.exists();
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            const result = yield checkpoint.schedulePoints((0, conversion_1.stringToTicker)(ticker, context), (0, conversion_1.bigNumberToU64)(id, context));
+            return result.map(rawId => new internal_1.Checkpoint({ id: (0, conversion_1.u64ToBigNumber)(rawId), ticker }, context));
+        });
+    }
+    /**
+     * Determine whether this Checkpoint Schedule exists on chain
+     */
+    exists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { checkpoint }, }, }, context, asset: { ticker }, id, } = this;
+            const rawSchedules = yield checkpoint.schedules((0, conversion_1.stringToTicker)(ticker, context));
+            const exists = rawSchedules.find(({ id: scheduleId }) => (0, conversion_1.u64ToBigNumber)(scheduleId).eq(id));
+            return !!exists;
+        });
+    }
+    /**
+     * Return the Schedule's static data
+     */
+    toHuman() {
+        const { asset, id, expiryDate, complexity, start, period } = this;
+        return (0, internal_2.toHumanReadable)({
+            ticker: asset,
+            id,
+            start,
+            expiryDate,
+            period,
+            complexity,
+        });
+    }
+}
+exports.CheckpointSchedule = CheckpointSchedule;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/entities/CheckpointSchedule/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAqC;AACrC,kDAA0B;AAE1B,gDAA+E;AAC/E,0CAAmF;AACnF,0DAM4B;AAC5B,sDAAqE;AA4BrE,MAAM,gBAAgB,GAAG,gEAAgE,CAAC;AAE1F;;GAEG;AACH,MAAa,kBAAmB,SAAQ,iBAAwC;IA2C9E;;OAEG;IACH,YAAmB,IAAgC,EAAE,OAAgB;QACnE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,kBAAkB,KAAqB,IAAI,EAApB,WAAW,UAAK,IAAI,EAAvE,sDAAgE,CAAO,CAAC;QAE9E,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;QAEnC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAA,2BAAgB,EAAC,MAAM,CAAC,CAAC;QAE3C,IAAI,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;SACxB;aAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACvB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;SACzB;aAAM;YACL,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;YAEhC,IAAI,CAAC,UAAU,GAAG,IAAA,eAAK,EAAC,kBAAkB,CAAC;iBACxC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC;iBAC7D,MAAM,EAAE,CAAC;SACb;IACH,CAAC;IAvED;;;OAGG;IACI,MAAM,CAAU,mBAAmB,CAAC,UAAmB;QAC5D,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,UAA+B,CAAC;QAEvD,OAAO,EAAE,YAAY,sBAAS,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC;IAC/D,CAAC;IAiED;;OAEG;IACU,OAAO;;YAClB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,UAAU,EAAE,GACtB,GACF,EACD,EAAE,EACF,OAAO,EACP,KAAK,EAAE,EAAE,MAAM,EAAE,GAClB,GAAG,IAAI,CAAC;YAET,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAEjF,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,IAAA,2BAAc,EAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAE9F,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;YAEnC,OAAO;gBACL,oBAAoB,EAAE,IAAA,2BAAc,EAAC,SAAS,CAAC;gBAC/C,kBAAkB,EAAE,IAAA,yBAAY,EAAC,EAAE,CAAC;aACrC,CAAC;QACJ,CAAC;KAAA;IAED;;OAEG;IACU,cAAc;;YACzB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,UAAU,EAAE,GACtB,GACF,EACD,OAAO,EACP,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,GACH,GAAG,IAAI,CAAC;YAET,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,MAAM,GAAG,MAAM,UAAU,CAAC,cAAc,CAC5C,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAA,2BAAc,EAAC,EAAE,EAAE,OAAO,CAAC,CAC5B,CAAC;YAEF,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,qBAAU,CAAC,EAAE,EAAE,EAAE,IAAA,2BAAc,EAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7F,CAAC;KAAA;IAED;;OAEG;IACU,MAAM;;YACjB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,UAAU,EAAE,GACtB,GACF,EACD,OAAO,EACP,KAAK,EAAE,EAAE,MAAM,EAAE,EACjB,EAAE,GACH,GAAG,IAAI,CAAC;YAET,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAEjF,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,IAAA,2BAAc,EAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAE5F,OAAO,CAAC,CAAC,MAAM,CAAC;QAClB,CAAC;KAAA;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAElE,OAAO,IAAA,0BAAe,EAAC;YACrB,MAAM,EAAE,KAAK;YACb,EAAE;YACF,KAAK;YACL,UAAU;YACV,MAAM;YACN,UAAU;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAjLD,gDAiLC"}

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

@@ -0,0 +1,8 @@
+import BigNumber from 'bignumber.js';
+import { Params, UniqueIdentifiers } from '.';
+export interface ScheduleDetails {
+    remainingCheckpoints: BigNumber;
+    nextCheckpointDate: Date;
+}
+export declare type CheckpointScheduleParams = Omit<UniqueIdentifiers & Params, 'ticker'>;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/CheckpointSchedule/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAE9C,MAAM,WAAW,eAAe;IAC9B,oBAAoB,EAAE,SAAS,CAAC;IAChC,kBAAkB,EAAE,IAAI,CAAC;CAC1B;AAED,oBAAY,wBAAwB,GAAG,IAAI,CAAC,iBAAiB,GAAG,MAAM,EAAE,QAAQ,CAAC,CAAC"}

package/api/entities/CheckpointSchedule/types.js

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

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

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

package/api/entities/CorporateAction.d.ts

@@ -0,0 +1,40 @@
+import BigNumber from 'bignumber.js';
+import { Context, CorporateActionBase, ModifyCaCheckpointParams } from "../../internal";
+import { CorporateActionKind, CorporateActionTargets, ProcedureMethod, TaxWithholding } from "../../types";
+import { HumanReadableType } from "../../types/utils";
+export interface UniqueIdentifiers {
+    id: BigNumber;
+    ticker: string;
+}
+export interface HumanReadable {
+    id: string;
+    ticker: string;
+    declarationDate: string;
+    description: string;
+    targets: HumanReadableType<CorporateActionTargets>;
+    defaultTaxWithholding: string;
+    taxWithholdings: HumanReadableType<TaxWithholding[]>;
+}
+export interface Params {
+    kind: CorporateActionKind;
+    declarationDate: Date;
+    description: string;
+    targets: CorporateActionTargets;
+    defaultTaxWithholding: BigNumber;
+    taxWithholdings: TaxWithholding[];
+}
+/**
+ * Represents an action initiated by the issuer of an Asset which may affect the positions of
+ *   the Asset Holders
+ */
+export declare class CorporateAction extends CorporateActionBase {
+    /**
+     * @hidden
+     */
+    constructor(args: UniqueIdentifiers & Params, context: Context);
+    /**
+     * Modify the Corporate Action's Checkpoint
+     */
+    modifyCheckpoint: ProcedureMethod<ModifyCaCheckpointParams, void>;
+}
+//# sourceMappingURL=CorporateAction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CorporateAction.d.ts","sourceRoot":"","sources":["../../../src/api/entities/CorporateAction.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,OAAO,EACP,mBAAmB,EAEnB,wBAAwB,EACzB,uBAAmB;AACpB,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EACf,cAAc,EACf,oBAAgB;AACjB,OAAO,EAAE,iBAAiB,EAAE,0BAAsB;AAGlD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,SAAS,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;IACnD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,iBAAiB,CAAC,cAAc,EAAE,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,eAAe,EAAE,IAAI,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,sBAAsB,CAAC;IAChC,qBAAqB,EAAE,SAAS,CAAC;IACjC,eAAe,EAAE,cAAc,EAAE,CAAC;CACnC;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,mBAAmB;IACtD;;OAEG;gBACgB,IAAI,EAAE,iBAAiB,GAAG,MAAM,EAAE,OAAO,EAAE,OAAO;IAcrE;;OAEG;IACI,gBAAgB,EAAE,eAAe,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;CAC1E"}

package/api/entities/CorporateAction.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CorporateAction = void 0;
+const internal_1 = require("../../internal");
+const internal_2 = require("../../utils/internal");
+/**
+ * Represents an action initiated by the issuer of an Asset which may affect the positions of
+ *   the Asset Holders
+ */
+class CorporateAction extends internal_1.CorporateActionBase {
+    /**
+     * @hidden
+     */
+    constructor(args, context) {
+        super(args, context);
+        this.modifyCheckpoint = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: modifyCaCheckpointArgs => [
+                internal_1.modifyCaCheckpoint,
+                Object.assign({ corporateAction: this }, modifyCaCheckpointArgs),
+            ],
+        }, context);
+    }
+}
+exports.CorporateAction = CorporateAction;
+//# sourceMappingURL=CorporateAction.js.map

package/api/entities/CorporateAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CorporateAction.js","sourceRoot":"","sources":["../../../src/api/entities/CorporateAction.ts"],"names":[],"mappings":";;;AAEA,6CAKoB;AAQpB,mDAAyD;AA0BzD;;;GAGG;AACH,MAAa,eAAgB,SAAQ,8BAAmB;IACtD;;OAEG;IACH,YAAmB,IAAgC,EAAE,OAAgB;QACnE,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAErB,IAAI,CAAC,gBAAgB,GAAG,IAAA,gCAAqB,EAC3C;YACE,mBAAmB,EAAE,sBAAsB,CAAC,EAAE,CAAC;gBAC7C,6BAAkB;gCAChB,eAAe,EAAE,IAAI,IAAK,sBAAsB;aACnD;SACF,EACD,OAAO,CACR,CAAC;IACJ,CAAC;CAMF;AAtBD,0CAsBC"}