canton-node-sdk

Low-level TypeScript SDK for Canton Network nodes (Ledger JSON API, Validator API, Scan API).

Developer documentation

The public GitHub wiki is the canonical guide for configuration, API boundaries, external signing, LocalNet, examples, and contribution. The public src/index.ts defines the supported package surface; use the installed declarations and public examples/ and test/ for exact methods, request shapes, and error behavior.

Install

npm install @fairmint/canton-node-sdk

import { Canton } from "@fairmint/canton-node-sdk";

async function main(): Promise<void> {
  const canton = new Canton({ network: "localnet" });
  const version = await canton.ledger.getVersion();
  console.log(version);
}

main().catch((error: unknown) => {
  console.error(error);
  process.exitCode = 1;
});

Repository setup and checks

git submodule update --init --depth 1 libs/splice
git submodule update --init --recursive libs/cn-quickstart
npm install
npm run fix
npm test
npm run build

Run npm run localnet:verify for the full LocalNet smoke and integration path.