Installation

Get up and running with PartyLayer in your project. The SDK supports React 18+ and Node.js 18+.

Prerequisites

Node.js 18 or later
React 18 or later (for React integration)
A Canton Network dApp (PartyLayer works with devnet, testnet, and mainnet)

Install Packages

Install the core SDK, the React bindings, and the TanStack Query peer:

bash

npm install @partylayer/sdk @partylayer/react @tanstack/react-query

ℹ️ Why @tanstack/react-query

It is a required peer dependency of @partylayer/react v2. The data hooks in the @partylayer/react/query entrypoint (DAML reads/writes, cost estimation) are built on TanStack Query, and you supply the QueryClient via QueryClientProvider. The base session and connect surface works without it; the provider is required only for the /query hooks. See the Quick Start for the setup.

ℹ️ Note

@partylayer/core is installed automatically as a dependency of @partylayer/sdk. You don't need to install it separately.

Vanilla JS Only

If you're not using React, you only need the core SDK:

bash

npm install @partylayer/sdk

Optional Packages

CIP-0103 Native Provider

For direct CIP-0103 provider integration (e.g., wrapping your PartyLayer client as a CIP-0103 compliant provider):

bash

npm install @partylayer/provider

Enterprise Wallet (Bron)

The Bron adapter requires explicit configuration and is not auto-registered:

tsx

import { BronAdapter } from '@partylayer/adapter-bron';
import { getBuiltinAdapters } from '@partylayer/sdk';

<PartyLayerKit
  network="mainnet"
  appName="My dApp"
  adapters={[
    ...getBuiltinAdapters(),
    new BronAdapter({
      auth: {
        clientId: '...',
        redirectUri: 'https://your-app.com/auth/callback',
        authorizationUrl: 'https://auth.bron.example/authorize',
        tokenUrl: 'https://auth.bron.example/token',
      },
      api: {
        baseUrl: 'https://api.bron.example',
        getAccessToken: async () => getStoredAccessToken(),
      },
    }),
  ]}
>
  {/* ... */}
</PartyLayerKit>

Verify Installation

After installing, verify everything works by importing the SDK:

tsx

import { createPartyLayer } from '@partylayer/sdk';
import { PartyLayerKit, ConnectButton } from '@partylayer/react';

// If these imports resolve without errors, you're good to go!
console.log('PartyLayer installed successfully');

Next, follow the Quick Start guide to build your first wallet integration.

PreviousIntroduction NextQuick Start