OCP Canton SDK

Guides

Contributor workflow, workflow recipes for OCP on Canton, troubleshooting, and where public ADRs live.

Application developers

Quickstart — peers, OcpClient, FeaturedAppRight context
Workflow recipes — Canton wiring, cap table batches, streams, valuations, validation
Reference catalog — searchable namespace list + sources

Transport (OAuth / JSON API / Validator commands) stays in @fairmint/canton-node-sdk — treat that package as the dependency you install beside @open-captable-protocol/canton. Detailed transport docs ship from the Canton Node SDK repository; this header stays OCP-focused by design.

Contributors & testing

Testing strategy

Test type	Command	Purpose
Unit	`npm test`	Conversions + validation with mocks
Integration	`npm run test:integration`	LocalNet + DAML contracts
Types	`npm run typecheck`	`tsc` / project references

Integration tests expect cn-quickstart (LocalNet) to be running.

LocalNet scripts

npm run localnet:start
npm run localnet:status
npm run localnet:smoke
npm run localnet:test
npm run localnet:stop

One-shot: npm run localnet:verify · Force rebuild: CANTON_LOCALNET_FORCE_FULL_START=true npm run localnet:start

Pre-push checklist

npm run fix
npm run test:ci
npm run test:integration (when converters or DAML bindings move)

Protocol Architecture Decision Records (ADRs) and governance write-ups remain in the ocp-canton-sdk wiki — this docs site avoids duplicating that archive.

Repository layout & policies

Deep layering reference: Architecture

Wiki hub: ocp-canton-sdk wiki · Contributing: Contributing wiki.