Open Cap Table Protocol Canton SDK - v0.2.287
    Preparing search index...

    Interface CapTableState

    Current state of a CapTable on Canton, with all canonical object IDs grouped by entity type.

    interface CapTableState {
        capTableContractId: string;
        contractIds: Map<OcfEntityType, Map<string, string>>;
        entities: Map<OcfEntityType, Set<string>>;
        issuerContractId: string;
        securityIds: Map<OcfEntityType, Set<string>>;
    }
    Index

    Properties

    capTableContractId contractIds entities issuerContractId securityIds

    Properties

    capTableContractId: string

    Contract ID of the CapTable contract.

    contractIds: Map<OcfEntityType, Map<string, string>>

    Map of entity type to (canonical object ID → Contract ID) for fetching individual contracts. Useful for deep verification where contract data needs to be compared.

    entities: Map<OcfEntityType, Set<string>>

    Map of entity type to canonical object IDs currently on-chain. Each entry contains all object IDs of that type in the CapTable.

    issuerContractId: string

    Contract ID of the Issuer contract (referenced by the CapTable).

    securityIds: Map<OcfEntityType, Set<string>>

    Map of issuance entity type to security_ids currently on-chain.

    Only populated for issuance types that enforce security_id uniqueness: stockIssuance, convertibleIssuance, equityCompensationIssuance, warrantIssuance.

    Used by computeReplicationDiff to detect duplicate security_id conflicts before submitting batch commands (avoiding DAML "security_id already exists" errors).

    Settings

    Member Visibility

    On This Page

    Properties