Documentation

Production Migration Checklist > Published on the docs site: partylayer.xyz/docs/production-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

Canton protocol ownership decision Status: published in SDK 0.20.1 and React 3.1.2 for browser-native announce/injected and official ProviderAdapter connections. Live-wallet acceptance remains open; see release evidence. Review baseline:

Public API Stability This document defines the public API stability guarantees for PartyLayer SDK. Versioning Policy PartyLayer follows Semantic Versioning: - MAJOR (X.0.0): Breaking changes to public API - MINOR (0.X.0): New features, backward compatible - **PATC

Quick start Add PartyLayer's branded wallet picker and account menu to a React app. One npm command installs the kit, 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 [re

Cookie-backed session storage for SSR (React) The default React kit keeps its live session projection in memory. An application can explicitly provide cookie storage when it wants server-readable UI hints. That cookie contains public account/network metadata, not a verified login. Wallet restorati

Optimistic updates and automatic rollback (React mutation hooks) PartyLayer's mutation hooks (useConnect, useDisconnect, useSignMessage, useSubmitTransaction, useChoice) are thin wrappers over TanStack useMutation. They manage only mutationFn and mutationKey; every lifecycle callba

@partylayer/react v1.x to v2.0 migration guide > Historical v1-to-v2 transition only. For the current React 3.1.2+ / SDK 0.20.1+ setup, use the current migration guide. Examples below describe the v2 transition and may require application-specific client/components. v2.0 adopts T

PartyLayer documentation Start with the ready-made React connection kit. Supported wallet runtimes are included; no per-wallet PartyLayer package installation is required. npm install @partylayer/react @tanstack/react-query These guides cover React 3.1.0+ / SDK 0.20.0+. See [release st

Registry Onboarding Guide How to get your wallet listed in the PartyLayer registry Overview The PartyLayer wallet registry is a versioned JSON file that lists available wallets. It is schema-validated on every build and published in public; it is not signed today (see SIGNING.md). Wallets

Registry Operations Guide This guide covers how to safely update, promote, and rollback the wallet registry. Prerequisites 1. Signing Keys: Generate keys using: pnpm registry:sign --generate-key ⚠️ Never commit private keys (.key files) to git. 2. Registry CLI: Install

Release Process This document describes how to cut releases and publish packages for PartyLayer. The owner-approved release workflow is the publication contract. It has completed a real tokenless CLI release. Other packages require their trust settings to be audited and

Security Checklist for Wallet Providers Security requirements for PartyLayer wallet adapters State Parameter (Nonce) ✅ Required: Use a cryptographically random state parameter for CSRF protection private generateState(): string { const array = new Uint8Array(32); crypto.ge

Production Security Guide This guide covers security requirements and best practices for deploying dApps that use PartyLayer SDK in production. Table of Contents - HTTPS Requirements - Content Security Policy (CSP) - [Platform-Specific Conf

Canton swap integration and settlement PartyLayer is the connection, approval and transaction lifecycle layer. It is not a liquidity venue or a universal swap router. A real swap additionally needs a chosen protocol, supported token pair/network, current quote, explicit user intent and proof of ou

Transaction lifecycle and recent activity Use useTransactionFlow for the ready-made wallet transaction lifecycle. It submits once, separates wallet approval from ledger confirmation and records recent activity in the same PartyLayerProvider/PartyLayerKit as ConnectButton. It does not const

Transport Layer Guide Deep link, popup, and postMessage transports for wallet communication Overview PartyLayer provides transport abstractions for different wallet communication patterns: - DeepLinkTransport - Mobile wallet deep links - PopupTransport - Popup window flows - **PostM

Owner-approved npm releases The selected release model uses one protected GitHub approval per release run. npm-publish.yml builds and records exact package files, then waits for the owner in the npm-release environment. After approval, an isolated job publishes those files through npm OIDC

Typed transfer: integration status requestTransfer is an optional intent-level convenience API: receiver, exact amount, issuer-scoped instrument, memo and expiry. It is separate from generic CIP-0103 command submission. The following inventory describes the current candidate code, not live walle

Typed transfer requestTransfer asks the connected wallet to make a transfer. The application says what it wants; the wallet does everything else. const result = await client.requestTransfer({ receiver: 'party::bob', amount: '10.5', instrumentId: { admin: 'party::registry', id: 'CC' }, meta

Nuxt 3 SSR and hydration @partylayer/vue is SSR-safe and works under Nuxt 3, with server-side fetching of the dApp's query data (cost, contracts) and clean hydration. The wallet connection itself is client-only, which is correct for a wallet. This page covers the guarantees, the Nuxt plugin setu

Pinia integration (optional) @partylayer/vue ships an optional Pinia integration for teams that centralize state in Pinia. It is an OPTION, not the default. The default is provide/inject (provideSessionStore / createPartyLayerSession) plus the composables (useSession / useAccount / useP

Suspense with the Vue query composables The @partylayer/vue query composables (useTransactionCostEstimate, usePaidTrafficCost, useDamlContract) are already Suspense-ready. You do not need a separate "suspense" composable, because Vue's Suspense works differently from React's. Why there

Wallet acceptance evidence and test environments Review date: 2026-10-24. This page distinguishes automated code evidence, actual wallet approvals and independently confirmed ledger outcomes. The candidate is not a certification of every wallet deployment or complete WCAG conformance. Accessibi

Wallet balances Canton holdings are private contracts, not a universal public balance endpoint. Read them through an authorized application backend or supported wallet ledger proxy, then supply typed holdings to PartyLayer's default account panel. Prerequisites Connect on the intended network.

Wallet integration and verification matrix Reviewed on 2026-10-24 against this candidate branch, the registry and installed published wallet runtimes. This is an integration inventory, not a certification that every deployed wallet can sign or settle every transaction. The stable registry contains

Authorized wallet ledger reads The ready readers require SDK 0.21.0 / React 3.2.0 or later. If those versions are not yet available on npm during the coordinated rollout, the existing application-fetcher hooks remain the supported released path. Install the normal React integration in one comm

Wallet Provider Guide > Compatibility reference: New wallets must use the generic CIP-0103 paths; > packages/adapters is closed to new wallet packages. Historical starter/copy > examples below apply only to maintaining existing compatibility integrations. > dApp developers should use the [on

Console Wallet Integration References: - Console DApp SDK - Wallet Integration Guide Overview The default PartyLayer catalog connects Console through CIP-0103 announce and

Loop wallet integration Loop is included in the default PartyLayer catalog. Install the React kit and its React Query peer in one command; no separate Loop package, script tag or window.loop setup is required. npm install @partylayer/react @tanstack/react-query import { PartyL

Canton application authentication server A runnable reference for PartyLayerKit.authentication. It provides the four same-origin /api/auth/{challenge,verify,session,logout} endpoints from the authentication guide. It is an application backend, not a hosted Party