Canton Node SDK

A TypeScript SDK for interacting with Canton blockchain.

Quick Start

import { CantonRuntime, EnvLoader, LedgerJsonApiClient } from '@fairmint/canton-node-sdk';

// Optionally load configuration from environment variables
const config = EnvLoader.getConfig('LEDGER_JSON_API', {
  network: 'devnet',
  provider: '5n',
});

// Create a shared runtime, then lightweight client views
const runtime = new CantonRuntime(config);
const client = new LedgerJsonApiClient(runtime);

// Use the client
const version = await client.getVersion();
console.log(`Connected to Canton ${version.version}`);

Key Features

• Type-Safe: Full TypeScript support
• OAuth2 Authentication: Automatic token management and refresh
• Multi-Environment: Support for devnet, testnet, and mainnet
• Production-Ready: Comprehensive error handling and logging

Documentation

• Getting Started - Installation, setup, and configuration
• Features - Detailed capabilities overview
• Utility Functions - Helper functions for common operations
• Ledger JSON API Operations - Complete Ledger JSON API reference
• Validator API Operations - Complete Validator API reference

Requirements

• Node.js >= 18.0.0
• TypeScript (recommended)