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

    Class OcpClient

    High-level client for interacting with Open Cap Table Protocol (OCP) contracts on Canton.

    import { OcpClient, toContractId } from '@open-captable-protocol/canton';

    const ocp = new OcpClient({ baseUrl: 'http://localhost:3975' });

    // Read an issuer - all get() methods return { data, contractId }
    const { data: issuer } = await ocp.OpenCapTable.issuer.get({
      contractId: toContractId('00abc123'),
    });
    console.log(issuer.legal_name);
    console.log(issuer.object_type); // 'ISSUER' - enables discriminated unions
    Index

    Constructors

    constructor

    Properties

    CantonPayments client context CouponMinter OpenCapTable OpenCapTableReports PaymentStreams

    Methods

    createBatch

    Constructors

    Properties

    CantonPayments: CantonPaymentsMethods

    Payment and airdrop operations using Canton's native token

    client: LedgerJsonApiClient

    The underlying LedgerJsonApiClient for direct ledger access

    context: OcpContextManager = ...

    Context manager for caching commonly used values.

    Use this to store FeaturedAppRight details, issuer party, and cap table contract ID after fetching them once, so they can be reused across operations.

    CouponMinter: CouponMinterMethods

    CouponMinter utilities for TPS rate limit checking

    OpenCapTable: OpenCapTableMethods

    Core cap table operations

    OpenCapTableReports: OpenCapTableReportsMethods

    Reporting operations for cap table analytics

    PaymentStreams: PaymentStreamsMethodsWithClient

    Recurring payment stream management

    Methods

    • Create a new transaction batch for submitting multiple commands atomically

      Parameters

      • params: { actAs: string[]; readAs?: string[] }

      Returns TransactionBatch

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods