@fairmint/canton-fairmint-sdk

Shared SDK utilities for Canton blockchain integration at Fairmint.

Installation

npm install @fairmint/canton-fairmint-sdk

Usage

import {
  CantonDbClient,
  PostgresDbClient,
} from '@fairmint/canton-fairmint-sdk';

// Create a Canton database client
const client = new CantonDbClient({
  host: 'localhost',
  port: 5432,
  database: 'canton',
  user: 'canton',
  password: 'password',
});

// Use the client
const result = await client.query('SELECT * FROM events LIMIT 10');

Features

• PostgresDbClient: Base PostgreSQL client with connection pooling
• CantonDbClient: Specialized client for Canton blockchain database queries
• FairmintDbClient: Client for Fairmint-specific database operations
• SDK Helper: Utilities for working with the Canton JSON API

Development

# Install dependencies
npm install

# Build
npm run build

# Type check
npm run typecheck

# Lint
npm run lint

# Format
npm run format

Publishing

This package is automatically published to NPM when changes are merged to main. The version is automatically incremented and a changelog is generated from commit messages.

License

MIT