@ottochain/sdk 1.7.0-beta.2 → 2.1.0

package/dist/types/apps/corporate/state-machines/corp-securities.d.ts

@@ -0,0 +1,1381 @@
+/**
+ * Securities state machine tracking the lifecycle of equity from authorization through issuance, transfer, and retirement.
+ * Manages stock certificates, book entry positions, and restricted securities.
+ */
+export declare const corpSecuritiesDef: {
+    metadata: {
+        name: string;
+        app: string;
+        type: string;
+        version: string;
+        description: string;
+        crossReferences: {
+            entity: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+            resolutions: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+            shareholders: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+        };
+    };
+    createSchema: {
+        required: readonly ["securityId", "entityId", "shareClass", "shareClassName", "shareCount", "parValue"];
+        properties: {
+            securityId: {
+                type: "string";
+                description: string;
+                immutable: true;
+            };
+            entityId: {
+                type: "string";
+                description: string;
+                immutable: true;
+            };
+            shareClass: {
+                type: "string";
+                description: string;
+            };
+            shareClassName: {
+                type: "string";
+                description: string;
+            };
+            shareCount: {
+                type: "integer";
+                description: string;
+            };
+            parValue: {
+                type: "number";
+                description: string;
+            };
+        };
+    };
+    stateSchema: {
+        properties: {
+            securityId: {
+                type: "string";
+                immutable: true;
+            };
+            entityId: {
+                type: "string";
+                immutable: true;
+            };
+            shareClass: {
+                type: "string";
+            };
+            shareClassName: {
+                type: "string";
+            };
+            certificateNumber: {
+                type: "string";
+                nullable: true;
+                description: string;
+            };
+            cusip: {
+                type: "string";
+                nullable: true;
+                description: string;
+            };
+            shareCount: {
+                type: "integer";
+            };
+            parValue: {
+                type: "number";
+            };
+            issuancePrice: {
+                type: "number";
+                nullable: true;
+                description: string;
+                computed: true;
+            };
+            issuanceDate: {
+                type: "string";
+                format: string;
+                nullable: true;
+                computed: true;
+            };
+            form: {
+                type: "string";
+                enum: readonly ["CERTIFICATED", "BOOK_ENTRY", "DRS"];
+                description: string;
+                computed: true;
+            };
+            holder: {
+                $ref: string;
+                nullable: true;
+                computed: true;
+            };
+            restrictions: {
+                $ref: string;
+                computed: true;
+            };
+            authorization: {
+                $ref: string;
+                nullable: true;
+                computed: true;
+            };
+            issuanceDetails: {
+                $ref: string;
+                nullable: true;
+                computed: true;
+            };
+            transferHistory: {
+                type: "array";
+                items: {
+                    $ref: string;
+                };
+                computed: true;
+            };
+            corporateActions: {
+                type: "array";
+                items: {
+                    $ref: string;
+                };
+                computed: true;
+            };
+            retirementDetails: {
+                $ref: string;
+                nullable: true;
+                computed: true;
+            };
+            status: {
+                type: "string";
+                enum: readonly ["AUTHORIZED", "ISSUED", "TREASURY", "TRANSFERRED", "RETIRED"];
+                computed: true;
+            };
+            createdAt: {
+                type: "timestamp";
+                computed: true;
+            };
+            updatedAt: {
+                type: "timestamp";
+                computed: true;
+            };
+        };
+    };
+    eventSchemas: {
+        authorize_shares: {
+            description: string;
+            required: readonly ["securityId", "entityId", "shareClass", "shareClassName", "shareCount", "parValue", "authorizedDate"];
+            properties: {
+                securityId: {
+                    type: "string";
+                };
+                entityId: {
+                    type: "string";
+                };
+                shareClass: {
+                    type: "string";
+                };
+                shareClassName: {
+                    type: "string";
+                };
+                shareCount: {
+                    type: "integer";
+                };
+                parValue: {
+                    type: "number";
+                };
+                authorizedDate: {
+                    type: "string";
+                    format: string;
+                };
+                charterProvision: {
+                    type: "string";
+                };
+            };
+        };
+        issue_shares: {
+            description: string;
+            required: readonly ["holderId", "holderType", "holderName", "issuanceDate", "form", "boardResolutionRef", "consideration"];
+            properties: {
+                holderId: {
+                    type: "string";
+                };
+                holderType: {
+                    type: "string";
+                };
+                holderName: {
+                    type: "string";
+                };
+                address: {
+                    type: "object";
+                };
+                issuanceDate: {
+                    type: "string";
+                    format: string;
+                };
+                issuancePrice: {
+                    type: "number";
+                };
+                form: {
+                    type: "string";
+                    enum: readonly ["CERTIFICATED", "BOOK_ENTRY", "DRS"];
+                };
+                certificateNumber: {
+                    type: "string";
+                };
+                boardResolutionRef: {
+                    type: "string";
+                };
+                consideration: {
+                    type: "object";
+                };
+                isRestricted: {
+                    type: "boolean";
+                    default: boolean;
+                };
+                restrictionType: {
+                    type: "array";
+                };
+                legends: {
+                    type: "array";
+                };
+                exemptionUsed: {
+                    type: "string";
+                };
+                accreditedInvestor: {
+                    type: "boolean";
+                };
+            };
+        };
+        initiate_transfer: {
+            description: string;
+            required: readonly ["transferId", "toHolderId", "toHolderName", "toHolderType", "transferType", "transferDate"];
+            properties: {
+                transferId: {
+                    type: "string";
+                };
+                toHolderId: {
+                    type: "string";
+                };
+                toHolderName: {
+                    type: "string";
+                };
+                toHolderType: {
+                    type: "string";
+                };
+                toAddress: {
+                    type: "object";
+                };
+                transferType: {
+                    type: "string";
+                };
+                pricePerShare: {
+                    type: "number";
+                };
+                transferDate: {
+                    type: "string";
+                    format: string;
+                };
+            };
+        };
+        complete_transfer: {
+            description: string;
+            required: readonly ["toHolderId", "toHolderName", "toHolderType", "completedDate"];
+            properties: {
+                transferAgentConfirmation: {
+                    type: "string";
+                };
+                newCertificateNumber: {
+                    type: "string";
+                };
+                toHolderId: {
+                    type: "string";
+                };
+                toHolderName: {
+                    type: "string";
+                };
+                toHolderType: {
+                    type: "string";
+                };
+                toAddress: {
+                    type: "object";
+                };
+                completedDate: {
+                    type: "string";
+                    format: string;
+                };
+                costBasis: {
+                    type: "number";
+                };
+            };
+        };
+        repurchase: {
+            description: string;
+            required: readonly ["repurchaseDate", "pricePerShare", "boardResolutionRef"];
+            properties: {
+                repurchaseDate: {
+                    type: "string";
+                    format: string;
+                };
+                pricePerShare: {
+                    type: "number";
+                };
+                boardResolutionRef: {
+                    type: "string";
+                };
+                repurchaseAgreementRef: {
+                    type: "string";
+                };
+            };
+        };
+        reissue_from_treasury: {
+            description: string;
+            required: readonly ["holderId", "holderName", "holderType", "reissueDate", "boardResolutionRef"];
+            properties: {
+                holderId: {
+                    type: "string";
+                };
+                holderName: {
+                    type: "string";
+                };
+                holderType: {
+                    type: "string";
+                };
+                address: {
+                    type: "object";
+                };
+                reissueDate: {
+                    type: "string";
+                    format: string;
+                };
+                issuancePrice: {
+                    type: "number";
+                };
+                boardResolutionRef: {
+                    type: "string";
+                };
+            };
+        };
+        retire: {
+            description: string;
+            required: readonly ["retiredDate", "retirementMethod", "boardResolutionRef"];
+            properties: {
+                retiredDate: {
+                    type: "string";
+                    format: string;
+                };
+                retirementMethod: {
+                    type: "string";
+                };
+                boardResolutionRef: {
+                    type: "string";
+                };
+                repurchasePrice: {
+                    type: "number";
+                };
+            };
+        };
+        stock_split: {
+            description: string;
+            required: readonly ["actionId", "splitRatio", "effectiveDate", "resolutionRef", "newShareCount"];
+            properties: {
+                actionId: {
+                    type: "string";
+                };
+                splitRatio: {
+                    type: "string";
+                    description: string;
+                };
+                effectiveDate: {
+                    type: "string";
+                    format: string;
+                };
+                resolutionRef: {
+                    type: "string";
+                };
+                newShareCount: {
+                    type: "integer";
+                };
+            };
+        };
+        declare_dividend: {
+            description: string;
+            required: readonly ["actionId", "dividendType", "recordDate", "paymentDate", "resolutionRef"];
+            properties: {
+                actionId: {
+                    type: "string";
+                };
+                dividendType: {
+                    type: "string";
+                    enum: readonly ["CASH", "STOCK"];
+                };
+                recordDate: {
+                    type: "string";
+                    format: string;
+                };
+                paymentDate: {
+                    type: "string";
+                    format: string;
+                };
+                cashAmount: {
+                    type: "number";
+                };
+                stockShares: {
+                    type: "integer";
+                };
+                resolutionRef: {
+                    type: "string";
+                };
+            };
+        };
+        remove_restriction: {
+            description: string;
+            required: readonly ["restrictionType", "removedDate"];
+            properties: {
+                restrictionType: {
+                    type: "string";
+                };
+                removedDate: {
+                    type: "string";
+                    format: string;
+                };
+                reason: {
+                    type: "string";
+                };
+                legalOpinionRef: {
+                    type: "string";
+                };
+            };
+        };
+    };
+    definitions: {
+        Holder: {
+            type: "object";
+            nullable: true;
+            properties: {
+                holderId: {
+                    type: "string";
+                };
+                holderType: {
+                    type: "string";
+                    enum: readonly ["INDIVIDUAL", "ENTITY", "TRUST", "TREASURY"];
+                };
+                name: {
+                    type: "string";
+                };
+                taxId: {
+                    type: "string";
+                    nullable: true;
+                };
+                address: {
+                    type: "object";
+                    nullable: true;
+                };
+                acquisitionDate: {
+                    type: "string";
+                    format: string;
+                };
+                acquisitionMethod: {
+                    type: "string";
+                    enum: readonly ["ORIGINAL_ISSUANCE", "PURCHASE", "GIFT", "INHERITANCE", "STOCK_SPLIT", "CONVERSION", "EXERCISE"];
+                };
+                costBasis: {
+                    type: "number";
+                    nullable: true;
+                };
+            };
+        };
+        Restrictions: {
+            type: "object";
+            properties: {
+                isRestricted: {
+                    type: "boolean";
+                    default: boolean;
+                };
+                restrictionType: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                        enum: readonly ["RULE_144", "SECTION_4(a)(2)", "REG_D", "REG_S", "LOCK_UP", "VESTING", "RIGHT_OF_FIRST_REFUSAL"];
+                    };
+                };
+                restrictionEndDate: {
+                    type: "string";
+                    format: string;
+                    nullable: true;
+                };
+                legends: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    description: string;
+                };
+                vestingSchedule: {
+                    type: "object";
+                    nullable: true;
+                    properties: {
+                        vestingStartDate: {
+                            type: "string";
+                            format: string;
+                        };
+                        totalShares: {
+                            type: "integer";
+                        };
+                        vestedShares: {
+                            type: "integer";
+                        };
+                        vestingScheduleRef: {
+                            type: "string";
+                        };
+                    };
+                };
+                lockUpExpiration: {
+                    type: "string";
+                    format: string;
+                    nullable: true;
+                };
+                rofr: {
+                    type: "object";
+                    nullable: true;
+                    description: string;
+                    properties: {
+                        holderIds: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                        };
+                        noticePeriodDays: {
+                            type: "integer";
+                        };
+                    };
+                };
+            };
+        };
+        Authorization: {
+            type: "object";
+            nullable: true;
+            description: string;
+            properties: {
+                authorizedDate: {
+                    type: "string";
+                    format: string;
+                };
+                charterProvision: {
+                    type: "string";
+                };
+                authorizedShares: {
+                    type: "integer";
+                };
+            };
+        };
+        IssuanceDetails: {
+            type: "object";
+            nullable: true;
+            properties: {
+                boardResolutionRef: {
+                    type: "string";
+                };
+                issuanceAgreementRef: {
+                    type: "string";
+                };
+                consideration: {
+                    type: "object";
+                    properties: {
+                        type: {
+                            type: "string";
+                            enum: readonly ["CASH", "PROPERTY", "SERVICES", "DEBT_CONVERSION", "STOCK_CONVERSION"];
+                        };
+                        value: {
+                            type: "number";
+                        };
+                        description: {
+                            type: "string";
+                        };
+                    };
+                };
+                exemptionUsed: {
+                    type: "string";
+                    nullable: true;
+                };
+                accreditedInvestor: {
+                    type: "boolean";
+                    nullable: true;
+                };
+            };
+        };
+        TransferRecord: {
+            type: "object";
+            properties: {
+                transferId: {
+                    type: "string";
+                };
+                transferDate: {
+                    type: "string";
+                    format: string;
+                };
+                fromHolderId: {
+                    type: "string";
+                };
+                toHolderId: {
+                    type: "string";
+                };
+                shares: {
+                    type: "integer";
+                };
+                transferType: {
+                    type: "string";
+                    enum: readonly ["SALE", "GIFT", "INHERITANCE", "INTERNAL"];
+                };
+                pricePerShare: {
+                    type: "number";
+                    nullable: true;
+                };
+                transferAgentConfirmation: {
+                    type: "string";
+                    nullable: true;
+                };
+            };
+        };
+        CorporateAction: {
+            type: "object";
+            description: string;
+            properties: {
+                actionId: {
+                    type: "string";
+                };
+                actionType: {
+                    type: "string";
+                    enum: readonly ["STOCK_SPLIT", "REVERSE_SPLIT", "STOCK_DIVIDEND", "CONVERSION", "RECLASSIFICATION"];
+                };
+                actionDate: {
+                    type: "string";
+                    format: string;
+                };
+                ratio: {
+                    type: "string";
+                    nullable: true;
+                    description: string;
+                };
+                sharesBeforeAction: {
+                    type: "integer";
+                };
+                sharesAfterAction: {
+                    type: "integer";
+                };
+                resolutionRef: {
+                    type: "string";
+                };
+            };
+        };
+        RetirementDetails: {
+            type: "object";
+            nullable: true;
+            properties: {
+                retiredDate: {
+                    type: "string";
+                    format: string;
+                };
+                retirementMethod: {
+                    type: "string";
+                    enum: readonly ["REPURCHASE", "REDEMPTION", "CANCELLATION", "CONVERSION"];
+                };
+                repurchasePrice: {
+                    type: "number";
+                    nullable: true;
+                };
+                boardResolutionRef: {
+                    type: "string";
+                };
+            };
+        };
+    };
+    states: {
+        AUTHORIZED: {
+            id: string;
+            isFinal: false;
+            description: string;
+        };
+        ISSUED: {
+            id: string;
+            isFinal: false;
+            description: string;
+        };
+        TREASURY: {
+            id: string;
+            isFinal: false;
+            description: string;
+        };
+        TRANSFERRED: {
+            id: string;
+            isFinal: false;
+            description: string;
+        };
+        RETIRED: {
+            id: string;
+            isFinal: true;
+            description: string;
+        };
+    };
+    initialState: "AUTHORIZED";
+    transitions: ({
+        from: "AUTHORIZED";
+        to: "AUTHORIZED";
+        eventName: "authorize_shares";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                securityId?: undefined;
+                entityId?: undefined;
+                shareClass?: undefined;
+                shareClassName?: undefined;
+                shareCount?: undefined;
+                parValue?: undefined;
+                authorization?: undefined;
+                transferHistory?: undefined;
+                corporateActions?: undefined;
+            } | {
+                securityId: {
+                    var: string;
+                };
+                entityId: {
+                    var: string;
+                };
+                shareClass: {
+                    var: string;
+                };
+                shareClassName: {
+                    var: string;
+                };
+                shareCount: {
+                    var: string;
+                };
+                parValue: {
+                    var: string;
+                };
+                authorization: {
+                    authorizedDate: {
+                        var: string;
+                    };
+                    charterProvision: {
+                        var: string;
+                    };
+                    authorizedShares: {
+                        var: string;
+                    };
+                };
+                transferHistory: never[];
+                corporateActions: never[];
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        dependencies?: undefined;
+        emits?: undefined;
+    } | {
+        from: "AUTHORIZED";
+        to: "ISSUED";
+        eventName: "issue_shares";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                form?: undefined;
+                certificateNumber?: undefined;
+                issuanceDate?: undefined;
+                issuancePrice?: undefined;
+                holder?: undefined;
+                restrictions?: undefined;
+                issuanceDetails?: undefined;
+            } | {
+                status: string;
+                form: {
+                    var: string;
+                };
+                certificateNumber: {
+                    var: string;
+                };
+                issuanceDate: {
+                    var: string;
+                };
+                issuancePrice: {
+                    var: string;
+                };
+                holder: {
+                    holderId: {
+                        var: string;
+                    };
+                    holderType: {
+                        var: string;
+                    };
+                    name: {
+                        var: string;
+                    };
+                    address: {
+                        var: string;
+                    };
+                    acquisitionDate: {
+                        var: string;
+                    };
+                    acquisitionMethod: string;
+                    costBasis: {
+                        "*": {
+                            var: string;
+                        }[];
+                    };
+                };
+                restrictions: {
+                    isRestricted: {
+                        var: string;
+                    };
+                    restrictionType: {
+                        var: string;
+                    };
+                    legends: {
+                        var: string;
+                    };
+                };
+                issuanceDetails: {
+                    boardResolutionRef: {
+                        var: string;
+                    };
+                    consideration: {
+                        var: string;
+                    };
+                    exemptionUsed: {
+                        var: string;
+                    };
+                    accreditedInvestor: {
+                        var: string;
+                    };
+                };
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+    } | {
+        from: "ISSUED";
+        to: "TRANSFERRED";
+        eventName: "initiate_transfer";
+        guard: {
+            and: ({
+                or: ({
+                    "==": (boolean | {
+                        var: string;
+                    })[];
+                    ">="?: undefined;
+                } | {
+                    "==": ({
+                        var: string;
+                    } | null)[];
+                    ">="?: undefined;
+                } | {
+                    ">=": {
+                        var: string;
+                    }[];
+                    "=="?: undefined;
+                })[];
+                "=="?: undefined;
+            } | {
+                "==": ({
+                    var: string;
+                } | null)[];
+                or?: undefined;
+            })[];
+            "=="?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                transferHistory?: undefined;
+            } | {
+                status: string;
+                transferHistory: {
+                    cat: ({
+                        var: string;
+                    } | {
+                        transferId: {
+                            var: string;
+                        };
+                        transferDate: {
+                            var: string;
+                        };
+                        fromHolderId: {
+                            var: string;
+                        };
+                        toHolderId: {
+                            var: string;
+                        };
+                        shares: {
+                            var: string;
+                        };
+                        transferType: {
+                            var: string;
+                        };
+                        pricePerShare: {
+                            var: string;
+                        };
+                    }[])[];
+                };
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+        dependencies?: undefined;
+    } | {
+        from: "TRANSFERRED";
+        to: "ISSUED";
+        eventName: "complete_transfer";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                holder?: undefined;
+                certificateNumber?: undefined;
+            } | {
+                status: string;
+                holder: {
+                    holderId: {
+                        var: string;
+                    };
+                    holderType: {
+                        var: string;
+                    };
+                    name: {
+                        var: string;
+                    };
+                    address: {
+                        var: string;
+                    };
+                    acquisitionDate: {
+                        var: string;
+                    };
+                    acquisitionMethod: string;
+                    costBasis: {
+                        var: string;
+                    };
+                };
+                certificateNumber: {
+                    if: ({
+                        "!=": ({
+                            var: string;
+                        } | null)[];
+                        var?: undefined;
+                    } | {
+                        var: string;
+                        "!="?: undefined;
+                    })[];
+                };
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+        dependencies?: undefined;
+    } | {
+        from: "ISSUED";
+        to: "TREASURY";
+        eventName: "repurchase";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                transferHistory?: undefined;
+                holder?: undefined;
+            } | {
+                status: string;
+                transferHistory: {
+                    cat: ({
+                        var: string;
+                    } | {
+                        transferId: {
+                            cat: (string | {
+                                var: string;
+                            })[];
+                        };
+                        transferDate: {
+                            var: string;
+                        };
+                        fromHolderId: {
+                            var: string;
+                        };
+                        toHolderId: string;
+                        shares: {
+                            var: string;
+                        };
+                        transferType: string;
+                        pricePerShare: {
+                            var: string;
+                        };
+                    }[])[];
+                };
+                holder: {
+                    holderId: string;
+                    holderType: string;
+                    name: string;
+                    acquisitionDate: {
+                        var: string;
+                    };
+                    acquisitionMethod: string;
+                    costBasis: {
+                        "*": {
+                            var: string;
+                        }[];
+                    };
+                };
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+    } | {
+        from: "TREASURY";
+        to: "ISSUED";
+        eventName: "reissue_from_treasury";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                holder?: undefined;
+            } | {
+                status: string;
+                holder: {
+                    holderId: {
+                        var: string;
+                    };
+                    holderType: {
+                        var: string;
+                    };
+                    name: {
+                        var: string;
+                    };
+                    address: {
+                        var: string;
+                    };
+                    acquisitionDate: {
+                        var: string;
+                    };
+                    acquisitionMethod: string;
+                    costBasis: {
+                        "*": {
+                            var: string;
+                        }[];
+                    };
+                };
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+    } | {
+        from: "ISSUED";
+        to: "RETIRED";
+        eventName: "retire";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                retirementDetails?: undefined;
+                holder?: undefined;
+            } | {
+                status: string;
+                retirementDetails: {
+                    retiredDate: {
+                        var: string;
+                    };
+                    retirementMethod: {
+                        var: string;
+                    };
+                    repurchasePrice: {
+                        var: string;
+                    };
+                    boardResolutionRef: {
+                        var: string;
+                    };
+                };
+                holder: null;
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+    } | {
+        from: "TREASURY";
+        to: "RETIRED";
+        eventName: "retire";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                retirementDetails?: undefined;
+                holder?: undefined;
+            } | {
+                status: string;
+                retirementDetails: {
+                    retiredDate: {
+                        var: string;
+                    };
+                    retirementMethod: {
+                        var: string;
+                    };
+                    repurchasePrice: {
+                        var: string;
+                    };
+                    boardResolutionRef: {
+                        var: string;
+                    };
+                };
+                holder: null;
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+    } | {
+        from: "ISSUED";
+        to: "ISSUED";
+        eventName: "stock_split";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                corporateActions?: undefined;
+                shareCount?: undefined;
+            } | {
+                corporateActions: {
+                    cat: ({
+                        var: string;
+                    } | {
+                        actionId: {
+                            var: string;
+                        };
+                        actionType: string;
+                        actionDate: {
+                            var: string;
+                        };
+                        ratio: {
+                            var: string;
+                        };
+                        sharesBeforeAction: {
+                            var: string;
+                        };
+                        sharesAfterAction: {
+                            var: string;
+                        };
+                        resolutionRef: {
+                            var: string;
+                        };
+                    }[])[];
+                };
+                shareCount: {
+                    var: string;
+                };
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+        dependencies?: undefined;
+    } | {
+        from: "ISSUED";
+        to: "ISSUED";
+        eventName: "declare_dividend";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            if: ({
+                "==": (string | {
+                    var: string;
+                })[];
+                merge?: undefined;
+                var?: undefined;
+            } | {
+                merge: ({
+                    var: string;
+                    corporateActions?: undefined;
+                    shareCount?: undefined;
+                } | {
+                    corporateActions: {
+                        cat: ({
+                            var: string;
+                        } | {
+                            actionId: {
+                                var: string;
+                            };
+                            actionType: string;
+                            actionDate: {
+                                var: string;
+                            };
+                            sharesBeforeAction: {
+                                var: string;
+                            };
+                            sharesAfterAction: {
+                                "+": {
+                                    var: string;
+                                }[];
+                            };
+                            resolutionRef: {
+                                var: string;
+                            };
+                        }[])[];
+                    };
+                    shareCount: {
+                        "+": {
+                            var: string;
+                        }[];
+                    };
+                    var?: undefined;
+                })[];
+                "=="?: undefined;
+                var?: undefined;
+            } | {
+                var: string;
+                "=="?: undefined;
+                merge?: undefined;
+            })[];
+            merge?: undefined;
+        };
+        emits?: undefined;
+    } | {
+        from: "ISSUED";
+        to: "ISSUED";
+        eventName: "remove_restriction";
+        guard: {
+            "==": number[];
+            and?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                restrictions?: undefined;
+            } | {
+                restrictions: {
+                    merge: ({
+                        var: string;
+                        restrictionType?: undefined;
+                        isRestricted?: undefined;
+                    } | {
+                        restrictionType: {
+                            filter: ({
+                                var: string;
+                                "!="?: undefined;
+                            } | {
+                                "!=": {
+                                    var: string;
+                                }[];
+                                var?: undefined;
+                            })[];
+                        };
+                        isRestricted: {
+                            ">": (number | {
+                                reduce: (number | {
+                                    filter: ({
+                                        var: string;
+                                        "!="?: undefined;
+                                    } | {
+                                        "!=": {
+                                            var: string;
+                                        }[];
+                                        var?: undefined;
+                                    })[];
+                                    "+"?: undefined;
+                                } | {
+                                    "+": (number | {
+                                        var: string;
+                                    })[];
+                                    filter?: undefined;
+                                })[];
+                            })[];
+                        };
+                        var?: undefined;
+                    })[];
+                };
+                var?: undefined;
+            })[];
+            if?: undefined;
+        };
+        emits: string[];
+        dependencies?: undefined;
+    })[];
+};
+export type CorpSecuritiesState = keyof typeof corpSecuritiesDef.states;
+export type CorpSecuritiesEvent = (typeof corpSecuritiesDef.transitions)[number]["eventName"];