Quickstart

Prerequisites

Node.js (v18+)
A running Canton validator node (either self-hosted or via a node-as-a-service provider). Any network validator can be used — Splice LocalNet is convenient for development and testing, but DevNet, TestNet, or MainNet validators work as well.

Installation

The Wallet SDK is available as a package on the NPM registry. You can install it using your preferred package manager.

npm
yarn
pnpm

npm install @canton-network/wallet-sdk

yarn add @canton-network/wallet-sdk

pnpm add @canton-network/wallet-sdk

Alternatively, to do dApp development only, the dApp SDK can be used which has a smaller bundle size and is optimized for browser usage. The dApp SDK can be installed with:

npm
yarn
pnpm

npm install @canton-network/dapp-sdk

yarn add @canton-network/dapp-sdk

pnpm add @canton-network/dapp-sdk

Both SDKs use the same underlying core packages and where only partial code is needed (like for transaction visualization or hash verification) those packages can be used independently.

Configuration

The SDK requires configuration for authentication, ledger access, and token standard connectivity. For local development against a Splice LocalNet, you can use the built-in defaults:

import {
    WalletSDKImpl,
    localNetAuthDefault,
    localNetLedgerDefault,
    localNetTokenStandardDefault,
    localValidatorDefault,
} from '@canton-network/wallet-sdk'

const sdk = new WalletSDKImpl().configure({
    logger: console,
    authFactory: localNetAuthDefault,
    ledgerFactory: localNetLedgerDefault,
    tokenStandardFactory: localNetTokenStandardDefault,
    validatorFactory: localValidatorDefault,
})

When moving to a production or non-LocalNet environment, you need custom factory functions that point to your specific endpoints. See Configuration for details.

Next steps

Guides — See how to create external parties, read data, signing transactions, and more
Using the SDK: Configuration — configure the SDK for other environments

Overview

SDKs

Language Bindings

CLI Tools

Development Tools

API Overview

Reference Projects

Prerequisites

Installation

Configuration

Next steps

​Prerequisites

​Installation

​Configuration

​Next steps

Prerequisites

Installation

Configuration

Next steps