Documentation/canton-network-docs/SDKsdApp SDKView on canton-network-docs ↗
canton-network-docs/SDKsdApp SDK

Overview

The dApp SDK is a TypeScript library for connecting web applications to wallets on Canton Network. It lets your frontend discover wallets, authenticate the user, read their parties, request signatures, and submit transactions. Use the SDK to:
  • Discover available wallets: browser extensions, remote wallets, and WalletConnect.
  • Connect and restore sessions: open a wallet picker and reconnect returning users silently.
  • Access the user’s parties: list accounts and read the primary party. A party is a user’s identity on the Canton ledger.
  • Request signatures: sign human-readable messages.
  • Prepare and execute transactions: submit Daml commands for user approval.
  • Call the JSON Ledger API: proxy authenticated requests through the user’s wallet session.
The SDK is framework agnostic and works with any browser-based application, including React, Next.js, Vue, Svelte, or vanilla TypeScript.

​
How it fits together

Your application talks to the SDK. The SDK speaks the CIP-0103 provider protocol to whichever wallet the user chose, and the wallet remains solely responsible for authorization and signing.
LayerResponsibility
dApp SDKHigh-level, convenient API. The recommended entry point for dApps.
CIP-0103 providerLow-level, EIP-1193–style interface. Use directly only for infrastructure or existing provider integrations.
AdaptersLocate and connect to CIP-0103 implementations (announced extensions, remote wallets, or WalletConnect).
WalletHolds the user’s parties, authorizes requests, and signs transactions.
Wallets connect in one of two ways:
  • Browser wallets run in the user’s browser, such as a browser extension. They make themselves discoverable by announcing to the dApp.
  • Remote wallets are server-side wallets reached over a CIP-0103 RPC endpoint.
By default, the wallet picker lists the browser wallets that announce themselves, together with the SDK’s built-in list of remote wallets. You can add more wallets, such as WalletConnect or a custom remote wallet, by registering adapters. See Wallet discovery.
The SDK is built over the CIP-0103 provider API. Most dApps should use the SDK. Use the Provider API directly only when building lower-level infrastructure or adapting an existing provider-based integration.

​
Quickstart

Ready to build? The Quickstart walks through installing the SDK, connecting a wallet, reading the user’s party, and submitting a transaction, using only the high-level SDK.