Home

Canton Node SDK

@fairmint/canton-node-sdk is the low-level public TypeScript SDK for Canton Ledger JSON, Validator, and Scan APIs.

Read by depth

1. Getting started covers installation, the unified client, and configuration.
2. Features maps the three API clients and higher-level helpers.
3. Examples points to maintained runnable flows.
4. External signing explains the prepare-sign-submit custody boundary.
5. LocalNet testing covers the published launcher and repository integration path.
6. Reference links each subsystem to current source and types.

The supported package surface is src/index.ts. Use this wiki for narrative; use the installed declarations, generated-client source, examples, and tests for exact methods, request shapes, and error behavior.

npm install @fairmint/canton-node-sdk

The package requires Node.js 22 or newer and is published under the MIT license.