Installation
Install once to get the React connection kit, SDK and supported wallet runtimes. Choose an existing app integration or generate a new project.
Choose your framework
The connection protocol is shared; the UI and runtime requirements depend on your application stack.
| Application | Integration | Connection UI and requirements |
|---|---|---|
| React / Vite | @partylayer/react | PartyLayerKit and ConnectButton; browser wallet access. |
| Next.js App Router | @partylayer/react | Same kit in a client boundary. SSR cookies restore UI hints; verify authentication on your backend. |
| Vue / Nuxt | @partylayer/vue | Composables and application-owned connection UI. Start with the vue-nuxt-pinia template. |
| Other web frameworks | @partylayer/sdk | Framework-independent client; your app supplies the picker and lifecycle. |
| React Native | @partylayer/react-native | Separate native UI entrypoint and storage setup. Browser extension discovery does not establish mobile-wallet compatibility. |
For native setup and peer dependencies, use the React Native guide. Validate each wallet's transport on the target platform; package availability alone is not live acceptance.
Prerequisites
- React 18+ for the connection kit.
- Node.js: package minimum 18; use a supported LTS version that also meets your framework requirements.
- Wallet access: a supported account/extension on your target network for an actual connection.
Existing React application
No separate SDK, core or wallet installation is needed. No stylesheet import is required. In Next.js, mount the kit in a client provider boundary; the quick start includes the root layout.
QueryClientProvider when using @partylayer/react/query data hooks; your app owns that client and the authorized data sources.Create a new app
The CLI creates the project and installs dependencies. Use next-ssr for Next.js. Vue/Nuxt, vanilla TypeScript and two demo vertical templates are also available; see the CLI guide.
Recover a dependency installation failure
If your package manager reports an installation error, keep the generated project, resolve the reported registry, network or dependency issue, then retry the install before starting the development server:
Use the package manager you selected. With --no-install, these installation steps are intentionally left to you.
Wallet setup
- Default runtimes are included and load as needed. Network and registry channel filter the catalog.
- Vala: Devnet with
channel="beta". - Send: Mainnet-only in the catalog.
- WalletConnect: your project ID through
walletConnect. - Bron: your OAuth/API configuration through
bron. - Use
additionalAdaptersto extend the catalog;adaptersreplaces it.
Accounts, wallet login, approval and test funding remain separate prerequisites. See kit configuration for complete options.
Other application stacks
Framework-independent TypeScript
Build your own interface and manage the client lifecycle with the SDK. The React ConnectButton is available from the React kit.
Provider infrastructure
The client already exposes asProvider(). You do not need a separate provider package to use the default kit. Advanced provider implementors can use @partylayer/provider; see the provider integration guide.
Verify installation
Run your app, open Connect Wallet, select a supported wallet and complete approval. Confirm the connected party and actual network with useAccount(). An import resolving proves installation only; connection and ledger outcomes require their own checks.
Continue with the quick start, then authentication or transactions.
Common setup questions
Upgrading an existing integration? Follow the migration guide. For a coding assistant, use the AI integration guide and maintained plain-text reference.
Why is a wallet missing from Connect Wallet?
Check the configured network and registry channel first. Send requires Mainnet; Vala requires Devnet beta. Then check required application configuration for WalletConnect or Bron and whether the wallet is installed or logged in. See the wallet support matrix and error-handling guide.
Does signing a message prove that transfers and swaps work?
A message signature verifies only that signing operation. Transfers and swaps also require supported capabilities, valid protocol commands, authorization, funding and confirmed ledger outcomes. Follow the transaction lifecycle before showing a successful payment or swap.
How should an AI coding assistant use these docs?
Provide the maintained integration reference, your installed package versions and your target network. Ask it to follow protocol ownership when migrating an existing app. Compile and run the resulting integration, then verify connection and ledger operations separately.