Documentation

Advanced This section covers advanced topics including telemetry, session persistence, registry internals, security best practices, and production deployment. Telemetry & Metrics PartyLayer includes an opt-in telemetry system for collecting anonymous usage metrics. Telemetry is disabled by default a

Canton application authentication Wallet connection and application sign-in are separate. Add your backend to the ready-made ConnectButton without installing another wallet adapter or package. This uses a backend integration like RainbowKit custom authentication . The readable PartyLayer Canton Sign

Canton swap integration and settlement PartyLayer supplies wallet connection, supported approvals and transaction lifecycle. Your chosen protocol supplies liquidity, quotes, execution rules and settlement. A message signature, allocation approval or confirmed deposit alone does not prove a completed

Canton wallet integration support Start with the ready-made React kit or a generated application. If an integration gets stuck, a small reproduction helps maintainers isolate application configuration, PartyLayer behavior and wallet-provider responses. bash Copy npm install @partylayer/react @ta

CIP-0103: interface, integration and limits CIP-0103 is the Canton dApp Standard, the specification for how wallets and dApps communicate on the Canton Network. PartyLayer exposes the provider interface, shared wallet integrations and typed errors. Backing capabilities and the client compatibility l

ConnectButton ConnectButton is a ready-to-use component that handles the entire wallet connection lifecycle. It renders a connect button when disconnected and shows the connected party ID with a disconnect dropdown when connected. Basic Usage tsx Copy import { ConnectButton } from '@partylayer

Dev and Staging: From Zero to a Working Integration This guide is the practical path for a team integrating PartyLayer, from a first look with nothing installed, through local development against a mock wallet, to a real connection on devnet, and finally to staging and production. It consolidates th

Error Handling PartyLayer provides 14 typed error classes with stable error codes, human-readable messages, and structured metadata. All errors extend PartyLayerError. PartyLayerError typescript Copy class PartyLayerError extends Error { code: ErrorCode; // Stable string error code message: st

Event Spec This document defines the event payloads emitted by PartyLayer SDK. Event System Overview PartyLayer uses a typed event system for state changes: ts Copy client.on('session:connected', (event) => { console.log('Connected:', event.session.partyId); }); // Unsubscribe const unsubscribe

Adapterless CIP-0103 integration: the two generic paths PartyLayer connects dApps to Canton wallets. You do not need a PartyLayer-specific adapter package to be one of those wallets. There are exactly two generic paths, and every CIP-0103 wallet fits one of them. Neither puts any wallet-specific cod

Installation Install once to get the React connection kit, SDK and supported wallet runtimes. Choose an existing app integration or generate a new project. ℹ️ Version scope This guide requires React 3.1.0+ / SDK 0.20.0+ and CLI 0.6.0+ for the listed templates. See release validation for publication

Integrate with an AI coding assistant Give your coding assistant the current setup guides so it can use the right packages, connection boundary and wallet requirements. This is documentation for generating application code; it does not require an AI runtime, a new API key or wallet access. Start wit

The Canton wallet connection kit PartyLayer is an open-source TypeScript SDK and React UI for connecting Canton dApps to supported wallets. Install the kit once, mount it at your application boundary and render the default Connect Wallet button. bash Copy npm install @partylayer/react @tanstack/

The Canton wallet connection kit PartyLayer is an open-source TypeScript SDK and React UI for connecting Canton dApps to supported wallets. Install the kit once, mount it at your application boundary and render the default Connect Wallet button. bash Copy npm install @partylayer/react @tanstack/

Multi-Party Patterns Multi-party flows on Canton are expressed as on-ledger workflows between parties. A transfer is a contract the receiver acts on; a settlement is a contract whose choice moves several parties ' assets at once. The atomicity of these flows lives in Daml, in the choice bodies, not

Observability PartyLayer is vendor neutral about telemetry. It defines a small adapter interface, ships one reference implementation, and forwards every event it emits to whatever adapter you plug in. It never talks to a specific backend, so you choose the vendor and keep the privacy guarantees. Thi

PartyLayer and Canton Topology: Where Your DARs Go When integrating PartyLayer alongside your own DAML templates, a natural point of confusion is where DAR files need to be published: to the wallets' validators, or to a PartyLayer validator that then bridges them to the wallets. Neither is correct.

PartyLayerKit PartyLayerKit is the zero-config wrapper component that sets up everything your dApp needs for wallet connectivity. It creates the SDK client, registers adapters, fetches the wallet registry, and provides theme and session context to all child components. Basic Usage tsx Copy imp

Pattern Cookbook Copy-paste-ready recipes for the most common Canton wallet flows, built on the real PartyLayer hooks. Every recipe has a matching live, editable scenario in PartyLayer Studio , open it, edit the code, and watch it run against a mock CIP-0103 wallet, plus a frank “When not to use” no

Performance This document is anchored to measurements, not advice. Every number here is reproducible with pnpm gate:size (the bundle scenarios) or the commands noted in each section. Measured baseline: raw dist per package Total JavaScript shipped in each package ' s dist (CommonJS .js plus ES

Privacy and Reads On Canton the ledger itself enforces what a party can see. A contract is only visible to the parties that are stakeholders on it, so a wallet kit does not filter privacy on the client. The job is not to hide data that arrived; it is to read the right slice and to key caches per par

Production Migration Checklist Checks to run before taking a PartyLayer dApp to production. This checklist links to the docs that already cover each topic and writes only what is missing. For each item it states what the kit provides, what the dApp owns, and the concrete checks to run. Where a topic

Quick start Add the PartyLayer wallet picker and account menu to your React app. One installation includes the SDK and reviewed wallet runtimes. No wallet-specific imports or stylesheet import are required. ℹ️ Version scope This guide requires React 3.1.0+ / SDK 0.20.0+. See release validation for p

A RainbowKit-style wallet connection kit for Canton PartyLayer gives React applications on Canton a ready-made Connect Wallet button, wallet picker, account menu, themes and connection hooks. One installation includes supported wallet runtimes. CIP-0103 remains the wallet communication standard; Par

React Hooks PartyLayer provides React hooks for accessing wallet state, performing operations, and managing sessions. The hooks below are the main entrypoint (@partylayer/react): they use useSyncExternalStore and must be used within a PartyLayerKit or PartyLayerProvider. v2 also adds a TanSt

Send Wallet Send is a passkey-based Canton wallet that speaks the splice-wallet-kernel OpenRPC contract and announces itself over canton:announceProvider rather than binding the shared window.canton slot. The dApp connection layer is open-sourced as Sigilry ; this PartyLayer adapter wraps that c

Theming PartyLayer includes a built-in theme system with light, dark, and auto modes. You can also create fully custom themes to match your application ' s design. Built-in Themes Pass a theme preset to PartyLayerKit: tsx Copy // Light theme (default) <PartyLayerKit theme="light" network="main

Token Transfers Transferring Amulet (or any CIP-56 token) on Canton goes through the Token Standard : you exercise a factory choice by interface , not a choice on the holding contract itself. The wallet prompts the user. Depending on the registry and receiver preapproval, the result can settle direc

Transaction lifecycle and recent activity Use useTransactionFlow for wallet approval, submission, independent ledger confirmation and recent activity in the ready-made account panel. The application/protocol still constructs valid Canton commands and the operation-specific transfer or swap flow. Sub

TypeScript Types PartyLayer is built with TypeScript strict mode and exports comprehensive types for all APIs. This page documents the core types you ' ll work with most frequently. 💡 Tip All types are exported from @partylayer/core and re-exported from @partylayer/sdk. You can import from eith