Open Cap Table Protocol DAML

This repository implements the Open Cap Format (OCF) as DAML contracts for Canton. It also publishes generated JavaScript bindings and the built DARs as @fairmint/open-captable-protocol-daml-js.

Packages

multi-package.yaml lists the DAML packages:

OpenCapTable-v36 data-depends on OpenCapTableApi-v01, embeds it in its DAR and has no Splice dependency. The interfaces' comments name OpenCapTable-v35, the line they shipped with; the package never changes, so read them as the current register line (v36). Its design is ADR-040. v36 deploys to DevNet only; MainNet is out of scope. Older majors stay in dars/ and in git history.

Two more directories belong to v36:

• ocf-extension/ holds the JSON schemas of the one Fairmint OCF extension, the hold pair TX_STOCK_HOLD / TX_STOCK_HOLD_CANCELLATION.
• test-vectors/v35.json holds the derived-ID, claim-hash and floor-function vectors that the Daml tests, the SDK and apiv2 must all reproduce. v36 keeps the ID scheme v35 introduced, so the shared file keeps its name. npm run test:vectors recomputes them and checks the generated TestVectors.daml.

Install and use the package

npm install @fairmint/open-captable-protocol-daml-js

The browser-safe root entry point exports the generated Fairmint.OpenCapTable and Fairmint.OpenCapTableApi namespaces, the bundled DAML standard-library types, and the entry-point IDs:

import { Fairmint, OCP_INTERFACES, OCP_TEMPLATES } from '@fairmint/open-captable-protocol-daml-js';

OCP_TEMPLATES.capTable; // also ocpFactory, issuerAuthorization, stockSecurity, stockClassEpoch, ocfIdShard
OCP_INTERFACES.ocfObject; // and registerContract: what readers filter by

The package also exposes stable subpaths for deployment metadata and the DARs:

import factories from '@fairmint/open-captable-protocol-daml-js/ocp-factory-contract-id.json';
import {
  getOpenCapTableDarPaths,
  resolveOpenCapTableDarPath,
} from '@fairmint/open-captable-protocol-daml-js/openCapTableDarPath';

The v36 OcpFactory is consumed by each authorization, so ocp-factory-contract-id.json records each network's factory identity (templateId, system_operator, factory_id), not a contract ID. Find the live factory with an active-contracts query for that template, filtered on both fields. A network is absent until its factory is created.

The DARs are exported at ./opencaptable.dar (OpenCapTable-v36) and ./opencaptable-api.dar; getOpenCapTableDarPaths() lists both in upload order. Check package.json for the complete export map and scripts/test-imports.ts for the executable package-surface contract. resolveOpenCapTableDarPath checks OPEN_CAP_TABLE_DAR_PATH, then the packaged DAR, then optional local-checkout paths; see its source and options for exact resolution behavior.

Deployment

Every push to main publishes the npm package (publish.yml) and tags the commit v<npm version>. Publishing deploys nothing.

The ledger providers accept traffic only from allowlisted IPs, so the DARs are deployed by the Deploy OCP to ledger workflow of Fairmint/canton, from its allowlisted scripts box. Given an npm version, it:

1. checks out this repository at that version's v<version> tag, or at the commit on main its ocp_daml_ref input names (for a version published without its tag), and runs the deployment preflight of npm run check:dar-version-policy for each DAR, dependency first;
2. uploads and vets the published DARs on both DevNet participants and makes sure the OCP factory exists;
3. records each deployment as the annotated tag dar-deploy/devnet/<package>/v<version> on that commit.

Those tags are the deployment evidence the DAR version policy reads. record_only records them for DARs that are already deployed. Record a factory identity the workflow reports in generated/ocp-factory-contract-id.json.

Public documentation

The public GitHub wiki is the canonical guide for contract architecture, OCF validation, development, testing, DAR backup, and release policy. Each package's daml.yaml, multi-package.yaml, package.json, and scripts/ remain the source of truth for current versions, dependencies, and automation.

Build and validate

Requires Node.js 22+ (see @fairmint/canton-dev-tools).

npm install
npx canton-dev-tools install-dpm-sdks
npm run build
npm test

npm run build generates OpenCapTable-v36/daml/Fairmint/OpenCapTable/OcfRecords.daml (the OCF record dispatch, from scripts/codegen/), runs prepare-build into generated/build/, then builds every package with dpm.

When generated bindings or the published npm surface are affected, also run:

npm run codegen
npm run verify-package

npm run check:schema-gaps compares the DAML types with the pinned OCF schemas (pass --ocf-schema-dir unless ../ocp-canton-sdk/libs/Open-Cap-Format-OCF is checked out) and with the extension in ocf-extension/.

The LocalNet OCF replay and cross-participant traffic scripts drove the ledger through ocp-canton-sdk, which does not support v36 yet. They were removed and return with SDK support; the last versions are in git history, the scripts before 0a15f5c and the replay-ocf-database workflow, with its sdk_ref input, at 7d693fa.

See Development and Testing for the generated-file boundary and specialized checks.