Documentation

High-level Signing Process The basic steps of preparing and signing a transaction using an external party are as follows: • Creating a command - You start by simply creating a command. • Preparing the transaction - You send the command to the blockchain RPC, offered by your node, to prepare the

The Wallet SDK has functionality for creating and managing user rights, by default when you are connecting it uses whichever user is defined in your token provider config. If the user is an admin user on the ledger api they can be used to create other users and grant them rights. How do I quickly

The Wallet SDK provides a TypeScript library for interacting with the Canton Network via the Ledger API. The Wallet SDK makes common patterns which wallets and exchanges will commonly use much easier to implement; patterns such as party creation, making token standard transfers and reading data. The

This is the shortest working path with the Wallet SDK: install it, connect to a validator, and create an external party. The example runs against a local validator. To use DevNet, TestNet or MainNet, change the configuration as described in Configuration . Prerequisites • Node.js. The SDK current

The amulet namespace is used for Canton coin specific operations. Availability and extensibility The amulet namespace is an extended namespace that requires configuration. You can initialize it either during SDK creation or later using the extend() method. Option 1: Initialize during SDK crea

Wallet SDK Configuration The following code examples show you how to initialize the wallet-sdk. This is the default config that can be used in combination with a non-altered Localnet running instance. However as soon as you need to migrate your script, code and deployment to a different environmen

The Wallet SDK supports extending its functionality through a plugin system. Plugins allow you to add custom methods and functionality to the SDK instance while maintaining access to the SDK context and logger. Creating and Registering a Plugin To create a plugin, extend the SDKPlugin class an

Overview Parties represent acting entities in the network and all transaction happens between one or more parties. To understand more about parties see the Parties in the Overview. A detailed tutorial of the steps below can be seen in the External Signing Tutorial here using python example script

Two-step transfer vs one-step transfer The default behavior for all tokens are a two-step transfer, this matches how funds are usually transferred in TradFi, however this is counter-intuitive in the blockchain world. Canton Coin supports setting up a “Transfer Pre-approval”, this allows a party to

The asset namespace provides methods to discover and find token assets from registries on the Canton Network. In v1, the asset namespace introduces a dedicated API for asset discovery and management. Key changes from v0 to v1 v0 required accessing asset information through the token standard ser

Wallet SDK v1 is not backwards compatible with v0. Quick links • Configuration — Detailed configuration guide • Preparing and signing a transaction — Preparing and signing transactions • Migration cheat sheet — Full v0 → v1 method lookup We have removed the configure() and connect() pattern in

The ledger namespace is used for preparing, signing, and executing transactions and other Ledger API operations. Availability The ledger namespace is always available as part of the basic SDK interface. It’s initialized automatically when you create an SDK instance and doesn’t require additional

The dApp API adopts standardized error codes from EIP-1193 and EIP-1474 . Branch on the code rather than the message string. Error codes Code | Message | Meaning | 4001 | User Rejected Request | The user rejected the request. | 4100 | Unauthorized | The requested method or account has

A browser-extension wallet becomes discoverable by announcing itself with an event, or by being registered explicitly by the host dApp. Extensions communicate with the dApp over targeted postMessage and implement the synchronous dApp API . The SDK does not scan window for injected providers (

Remote wallets are server-side wallets. They are not injected into the page; instead they expose a CIP-103 RPC endpoint over HTTP/SSE, and dApps register that endpoint with a RemoteAdapter. Remote wallets implement the asynchronous dApp API , where actions that need user interaction are completed

The wallet SDK primarily focus on an on-party basis interaction, therefore it is almost always required to define the party you are using for each command. Reading Available Parties Reading all available parties to you can easily be done using the wallet SDK as shown in the example below, and th

When writing scripts and setup it is important to have funds present, this can be very tedious on blockchains. Therefore most blockchains support some form of a faucet (that allows to receive a small amount of funds to play with). On canton we allow the tap method that is only present on DevNet (o

A normal flow on blockchain applications is to have dApps that interact with the blockchain on the clients behalf, these flows usually require the user to sign transactions that the dApp prepares and submit it. To facilitate this in Canton it is required that the prepared transaction is sent to the

The party namespace provides methods to manage wallet parties on the Canton Network. In v1, the party namespace replaces the stateful party management from v0. Availability The party namespace is always available as part of the basic SDK interface. It’s initialized automatically when you create

The token namespace provides methods to manage token operations including transfers, holdings, UTXOs, and allocations on the Canton Network. In v1, the token namespace replaces the tokenStandard controller from v0. Availability and extensibility The token namespace is an extended namespace tha

The user namespace provides methods for user management on the Canton Network. Availability The user namespace is always available as part of the basic SDK interface. It’s initialized automatically when you create an SDK instance and doesn’t require additional configuration via extend().

Canton Network applications are not limited to just the Global Synchronizer. You can operate dedicated synchronizers (also called extension synchronizers or private synchronizers) alongside the Global Synchronizer for workloads that require different privacy, performance, or governance characteristi

This tutorial walks you through deploying a dedicated synchronizer (also called an extension synchronizer): configure sequencer and mediator nodes, start them, bootstrap topology, connect validators, and verify the deployment. It is for operators who run their own synchronizer alongside — or instea

Introduction External parties control their cryptographic signing keys, which removes the need to trust any participant node with transaction authorization. External parties provide full control over transaction signing, ensure regulatory compliance for transaction authorization, and are independe

External calls require a synchronizer running protocol version 36 or later and a Daml package targeting LF 2.4 or later. This page covers the practical side of external calls: a worked example, the participant configuration, and the externalCall function. For how calls travel through the transac

External calls require a synchronizer running protocol version 36 or later and a Daml package targeting LF 2.4 or later. External calls let a Daml choice invoke a function on an extension service : a deterministic service that the participant node operator configures and runs alongside the partici

Canton Network docs expose a public Model Context Protocol (MCP) server, so an AI agent can search and read this documentation directly instead of relying on training data or a generic web search. URL: https://docs.canton.network/mcp Transport: HTTP. Authentication: none — the server is public a

1.13.0 — 2026-10-22 🚀 Features • sign message for external signing providers ( #2712 ) • wallet-gateway-remote: cache idp keystores ( #2727 ) • wallet-gateway-remote: return 503 instead of 401 for unavailable idp ( #2707 ) • optional signing providers ( #2295 ) • wallet sync in self issued l

0.17.1 — 2025-12-18 🩹 Fixes • stop double popup for prepareExecute ( #1049 ) 🧱 Updated Dependencies • Updated @canton-network/core-splice-provider to 0.17.1 ❤️ Thank You • Alex Matson @alexmatson-da

0.16.0 — 2025-12-12 🚀 Features • extend StatusEvent props ( #977 ) 🩹 Fixes • dapp-sdk: improve switching between different gateways ( #1020 ) • dapp-sdk: prevent duplicated socket events ( #1015 ) • consolidate specs and fix open() ( #1010 ) • dapp-sdk,core-splice-provider: minor code cle