Home

OCP Canton SDK

@open-captable-protocol/canton is the high-level TypeScript SDK for Open Cap Table Protocol contracts on Canton.

Read by depth

1. Getting started covers installation, client ownership, and factory coordinates.
2. Cap Table operations explains OCF-shaped reads and atomic updates.
3. Architecture identifies the schema, contract, package, and test boundaries.
4. Environment and observability covers runtime configuration and command evidence.
5. ADRs records the durable batch and entity-registry decisions.

The supported package surface is the curated export list in src/index.ts. Generated DAML codecs and internal converters are not supported deep-import APIs. Use the wiki for narrative and drill into current source, declaration tests, and integration tests for exact behavior.

Install

npm install @open-captable-protocol/canton

The repository is public under GPL-3.0-only. Package metadata and the repository LICENSE are the authority for the distributed version.