Documentation

Service account automation lets a backend job, CI pipeline, or other service submit ledger transactions through the Wallet Gateway without a person in the loop. It uses the same dApp API as interactive dApps (prepareExecute, txChanged events), but the request is authenticated with a user-generat

The dApp API is the CIP-0103 JSON-RPC 2.0 API that dApps call to connect to a wallet, list accounts, and prepare and execute transactions. The Wallet Gateway exposes it, but you almost never call it directly. • Base path : /api/v0/dapp (configurable via server.dappPath) • Protocol : JSON-RPC 2

Self issued access token is a way to authenticate to a canton ledger without an external Identity Provider, by signing access token with party private key. Ledger will accept access token signed by party if following requirements are fulfilled: • Ledger User has property primary_party_authenticati

Common issues you may hit when running the Wallet Gateway, with fixes. Database connection errors The Wallet Gateway fails to start with database connection errors. • PostgreSQL : verify the database exists (psql -U postgres -l), check credentials in your config, ensure PostgreSQL is running

The Wallet Gateway does not have to hold private keys. Signing is delegated to a signing provider chosen per wallet, so you decide where each wallet’s keys live and who performs the cryptographic signing. Different wallets in the same Wallet Gateway can use different providers, and you select the pr

For anything beyond local development, run the Wallet Gateway as a container. It ships in both Docker and Helm variants, and the images and charts are public on the GitHub Container Registry, so no access request is required. • Docker registry : ghcr.io/digital-asset/wallet-gateway/docker/wallet-

This reference complements the task-oriented guides with the details you need for production: the store backends in full, backup and recovery, signing store security, and how to handle secrets across environments. For the config file’s overall shape, see Configure the Wallet Gateway . For networks

The Wallet Gateway reads a single JSON configuration file that defines who the Wallet Gateway is, how it serves requests, where it persists data, and which networks and identity providers it starts with. This guide covers the file’s structure and the kernel, server, store, and hashing scheme section

Overview Circle and Digital Asset have partnered to develop and implement a USDC token on Canton Network. This implementation requires users to send USDC on L1 chains (starting with Ethereum) to Circle’s xReserve contract which is then created as a USDC token on Canton Network. Conversely a withdr

Once a wallet is connected, your dApp can read the user’s Canton parties, sign messages, submit transactions, and query the ledger through the authenticated session. All examples use the high-level SDK. For the equivalent low-level calls, see the Provider API . List the user’s parties A user m

This is the shortest working integration: install the SDK, initialize it, let the user connect a wallet, read their party, and submit a transaction. It uses only the high-level SDK. You do not need the Provider API to build a dApp. 1 Install the SDK • npm • yarn • pnpm npm install @canto

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