Skip to content
← Open Cap Table Protocol OCP Canton SDK

Reference

Types — common contracts & re-exports

ContractResult, GetByContractIdParams, ReadScopeParams, CommandWithDisclosedContracts, WithObjectType, and canton-node-sdk type re-exports for consumers.

common.ts defines the SDK’s shared read/write shapes and forwards a few @fairmint/canton-node-sdk types so apps avoid deep relative imports.

Key interfaces

  • ReadScopeParams — optional readAs?: string[] hint forwarded on most get*AsOcf / readSingleContract paths (document edge cases in source comments).
  • GetByContractIdParams — contractId: string + ReadScopeParams.
  • ContractResult<T> — { readonly data: T; readonly contractId: string } for all OpenCapTable.*.get readers.
  • WithObjectType<T, OT> — intersection adding readonly object_type: OT for outputs.
  • CommandWithDisclosedContracts (declared in types/index.ts) — { command: Command; disclosedContracts: DisclosedContract[] }.

Re-exports

Command, DisclosedContract, LedgerJsonApiClient, ValidatorApiClient, ClientConfig, SubmitAndWaitForTransactionTreeResponse.

See also

Source