Skip to content

Reference

OpenCapTable — entity matrix

Mapped overview of ocp.OpenCapTable namespaces — read paths, batch edits, issuer create, issuer authorization.

Everything below hangs off new OcpClient({ ledger, validator? })OpenCapTable. Per-entity reads, batch writes, and issuer creation all share this namespace.

Legend

  • get() — Ledger read returning ContractResult<T> with OCF discriminant (object_type).
  • capTable.update — Fluent CapTableBatch for atomic UpdateCapTable.
  • issuer.buildCreateCreateCapTable command bundle (requires batch submit).
  • issuerAuthorization — Factory AuthorizeIssuer and WithdrawAuthorization submissions.
  • capTable. lifecycle* — classify, getState, archive on OcpClient; packaged helpers (archiveFullCapTable, getSystemOperatorPartyId, buildUpdateCapTableCommand) are exported from @open-captable-protocol/canton but not namespaced under OcpClient.

Entity namespaces

NamespaceReadsWrites / builders
`/issuer/get` · issuergetcapTable.update (create/edit/delete)
`/stakeholder/get` · stakeholdergetcapTable.update (create/edit/delete)
`/stock-class/get` · stockClassgetcapTable.update (create/edit/delete)
`/stock-legend-template/get` · stockLegendTemplategetcapTable.update (create/edit/delete)
`/stock-plan/get` · stockPlangetcapTable.update (create/edit/delete)
`/vesting-terms/get` · vestingTermsgetcapTable.update (create/edit/delete)
`/valuation/get` · valuationgetcapTable.update (create/edit/delete)
`/document/get` · documentgetcapTable.update (create/edit/delete)
`/stock-issuance/get` · stockIssuancegetcapTable.update (create/edit/delete)
`/equity-compensation-issuance/get` · equityCompensationIssuancegetcapTable.update (create/edit/delete)
`/warrant-issuance/get` · warrantIssuancegetcapTable.update (create/edit/delete)
`/convertible-issuance/get` · convertibleIssuancegetcapTable.update (create/edit/delete)
`/stock-transfer/get` · stockTransfergetcapTable.update (create/edit/delete)
`/warrant-transfer/get` · warrantTransfergetcapTable.update (create/edit/delete)
`/convertible-transfer/get` · convertibleTransfergetcapTable.update (create/edit/delete)
`/equity-compensation-transfer/get` · equityCompensationTransfergetcapTable.update (create/edit/delete)
`/stock-cancellation/get` · stockCancellationgetcapTable.update (create/edit/delete)
`/warrant-cancellation/get` · warrantCancellationgetcapTable.update (create/edit/delete)
`/convertible-cancellation/get` · convertibleCancellationgetcapTable.update (create/edit/delete)
`/equity-compensation-cancellation/get` · equityCompensationCancellationgetcapTable.update (create/edit/delete)
`/equity-compensation-exercise/get` · equityCompensationExercisegetcapTable.update (create/edit/delete)
`/warrant-exercise/get` · warrantExercisegetcapTable.update (create/edit/delete)
`/stock-conversion/get` · stockConversiongetcapTable.update (create/edit/delete)
`/convertible-conversion/get` · convertibleConversiongetcapTable.update (create/edit/delete)
`/stock-acceptance/get` · stockAcceptancegetcapTable.update (create/edit/delete)
`/warrant-acceptance/get` · warrantAcceptancegetcapTable.update (create/edit/delete)
`/convertible-acceptance/get` · convertibleAcceptancegetcapTable.update (create/edit/delete)
`/equity-compensation-acceptance/get` · equityCompensationAcceptancegetcapTable.update (create/edit/delete)
`/issuer-authorized-shares-adjustment/get` · issuerAuthorizedSharesAdjustmentgetcapTable.update (create/edit/delete)
`/stock-class-authorized-shares-adjustment/get` · stockClassAuthorizedSharesAdjustmentgetcapTable.update (create/edit/delete)
`/stock-class-conversion-ratio-adjustment/get` · stockClassConversionRatioAdjustmentgetcapTable.update (create/edit/delete)
`/stock-class-split/get` · stockClassSplitgetcapTable.update (create/edit/delete)
`/stock-plan-pool-adjustment/get` · stockPlanPoolAdjustmentgetcapTable.update (create/edit/delete)
`/stock-repurchase/get` · stockRepurchasegetcapTable.update (create/edit/delete)
`/stock-consolidation/get` · stockConsolidationgetcapTable.update (create/edit/delete)
`/stock-reissuance/get` · stockReissuancegetcapTable.update (create/edit/delete)
`/vesting-start/get` · vestingStartgetcapTable.update (create/edit/delete)
`/vesting-event/get` · vestingEventgetcapTable.update (create/edit/delete)
`/vesting-acceleration/get` · vestingAccelerationgetcapTable.update (create/edit/delete)
`/stakeholder-relationship-change-event/get` · stakeholderRelationshipChangeEventgetcapTable.update (create/edit/delete)
`/stakeholder-status-change-event/get` · stakeholderStatusChangeEventgetcapTable.update (create/edit/delete)
`/issuer/build-create`issuer.buildCreate (CreateCapTable via batch)
issuerAuthorizationauthorize / withdraw
capTableclassify, getStateupdate → CapTableBatch; archive

OcpClient.ts — OpenCapTableMethods