create-partylayer-app 0.5.3 → 0.6.0

package/README.md

@@ -1,41 +1,80 @@
 # create-partylayer-app
 
-Scaffold a [PartyLayer](https://partylayer.xyz) dApp — Canton wallet integration — in seconds.
+Create a Canton dApp with PartyLayer wallet connectivity, configuration and a working development setup. React starters use the ready-made `ConnectButton` and show **Powered by PartyLayer** by default.
+
+## Create an app
+
+```bash
+npm create partylayer-app@latest my-dapp -- --template react-vite --pm npm
+```
+
+The CLI creates the directory and installs dependencies. Then:
 
 ```bash
-npm create partylayer-app@latest
-# or
-pnpm create partylayer-app
-# or
-yarn create partylayer-app
+cd my-dapp
+npm run dev
 ```
 
-Then follow the prompts (project directory → template → package manager).
+For an interactive setup, run `npm create partylayer-app@latest` and choose a directory, template and package manager. pnpm and Yarn are also supported.
+
+> This guide covers CLI **0.6.0+** and its coordinated wallet-kit templates. See [release validation](https://github.com/PartyLayer/PartyLayer/blob/main/docs/releasing.md#default-wallet-release-validation) for release status.
+
+## Templates
+
+| Template | Use it for |
+| --- | --- |
+| `react-vite` | React + Vite with `PartyLayerKit` and the default `ConnectButton` |
+| `next-ssr` | Next.js App Router with a client provider boundary and a cookie-based UI session projection |
+| `vue-nuxt-pinia` | Nuxt + Vue + Pinia with a custom connection UI and PartyLayer attribution |
+| `vanilla` | TypeScript + Vite with the SDK and a custom connection UI |
+| `react-tokenization` | Tokenization UI over an application-owned demo backend |
+| `react-dvp` | Delivery-versus-payment UI over an application-owned demo backend |
+
+The vertical templates start with in-memory demo backends. Real ledger mode needs application-owned fetchers and authorization; scaffolding does not deploy a ledger backend. SSR cookies are UI hints, not an authenticated server session. Use backend verification for protected routes.
 
-## Non-interactive
+## Existing React application
 
-Pass flags to skip the prompts (useful in CI):
+You can add the kit without creating a new app:
 
 ```bash
-npm create partylayer-app@latest my-app -- --template react-vite --pm npm
+npm install @partylayer/react @tanstack/react-query
 ```
 
+```tsx
+import { PartyLayerKit, ConnectButton } from '@partylayer/react';
+
+<PartyLayerKit network="devnet" appName="My dApp">
+  <ConnectButton />
+</PartyLayerKit>
+```
+
+Reviewed wallet runtimes come with the kit. Network/channel selection and wallet capabilities control availability. Vala requires Devnet with `channel="beta"`; Send is Mainnet-only in the catalog. WalletConnect requires your project ID and Bron requires OAuth/API configuration. No additional per-wallet package installation is required.
+
+## CLI options
+
 | Flag | Description |
 | --- | --- |
-| `<dir>` | Target directory (positional) |
-| `-t, --template <id>` | Template to use (`react-vite`) |
-| `--pm <manager>` | `npm` \| `pnpm` \| `yarn` |
-| `--no-install` | Skip dependency install |
-| `--no-git` | Skip git init |
-| `-h, --help` | Show help |
+| `<dir>` | Target directory; an existing directory must be empty |
+| `-t, --template <id>` | One of the template IDs above |
+| `--pm <manager>` | `npm`, `pnpm` or `yarn` |
+| `--no-install` | Generate files without installing dependencies |
+| `--no-git` | Skip Git initialization |
+| `-h, --help` | Print help |
 
-## Templates
+Provide directory, template and package manager to skip prompts. For example:
 
-| Template | Stack |
-| --- | --- |
-| `react-vite` | React 18 + Vite + zero-config `PartyLayerKit` |
+```bash
+npm create partylayer-app@latest my-dapp -- --template next-ssr --pm npm --no-git
+```
+
+Node.js 18 is the CLI minimum. Follow the generated framework's Node requirements as well; use a supported Node LTS release for new projects.
+
+## Next steps
 
-More templates (Next SSR, Vue/Nuxt/Pinia, Vanilla) are on the way.
+- [Quick start](https://partylayer.xyz/docs/quick-start)
+- [Wallet configuration](https://partylayer.xyz/docs/partylayer-kit)
+- [Authentication](https://partylayer.xyz/docs/authentication)
+- [Transaction lifecycle](https://partylayer.xyz/docs/transaction-lifecycle)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-partylayer-app",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "Scaffold a PartyLayer dApp (Canton wallet integration) in seconds.",
   "type": "module",
   "bin": {

package/templates/next-ssr/README.md

@@ -1,28 +1,56 @@
 # {{PROJECT_NAME}}
 
-A [PartyLayer](https://partylayer.xyz) dApp: Next.js App Router with **SSR session**.
+A Canton dApp using Next.js App Router, PartyLayer's default `ConnectButton` and
+explicit cookie-based UI session hints. The connection modal shows **Powered by
+PartyLayer** by default.
 
 ## Develop
 
+The CLI installs dependencies unless `--no-install` was selected. If installation
+was skipped, run `npm install` first.
+
 ```bash
 npm run dev
 ```
 
-## How SSR session works
+## Application structure
+
+- `app/providers.tsx` is the client boundary. It mounts `QueryClientProvider` and
+  `PartyLayerKit` and supplies stable cookie storage through `sessionOptions`.
+- `lib/session.ts` reads the same UI cookie on the server through a Next.js cookie
+  adapter. This can render an initial account hint without waiting for browser storage.
+- The default button reads the live session after hydration; wallet restoration still
+  requires the SDK's live identity/network checks.
+
+**The UI cookie is not authentication or authorization.** Do not protect backend data
+or actions with its party ID. For protected server routes, use a backend challenge,
+independent signature/key verification and a server-managed authenticated session.
+
+## Wallet configuration
+
+Change `network` in `app/providers.tsx`; keep the application name and any server-side
+network assumptions aligned. The default is Devnet. Runtime dependencies are included;
+no per-wallet installation or registration is needed.
 
-- **Server** ([lib/session.ts](lib/session.ts)) reads the session cookie via `next/headers` `cookies()` + `@partylayer/session`'s `createCookieStorage` → the connected party is rendered in the **initial HTML** (no disconnected→connected flash). `app/page.tsx` is a Server Component that gates on `getServerSession()`.
-- **Client** ([app/providers.tsx](app/providers.tsx)) wraps the app in `PartyLayerKit` with `sessionOptions={{ storage: createCookieStorage() }}`. This uses `document.cookie` (synchronous), the **same** cookie the server reads.
-- `next/headers` is imported only in your app (`lib/session.ts`), never in `@partylayer/session`. The library stays framework-agnostic.
+- Vala: Devnet with `channel="beta"` on `PartyLayerKit`.
+- Send: Mainnet-only in the catalog.
+- WalletConnect: your project ID through a stable `walletConnect` configuration.
+- Bron: your OAuth/API configuration through `bron`.
+- `additionalAdapters` extends the defaults; `adapters` replaces them.
 
-Switch networks by changing `network` in `app/providers.tsx` and `appName` accordingly.
+User login/approval and test funding are separate prerequisites. A connection or
+signature does not verify a send/swap outcome.
 
 ## Build
 
 ```bash
-npm run build && npm start
+npm run build
+npm start
 ```
 
-## Docs
+## Documentation
 
-- [PartyLayer docs](https://partylayer.xyz/docs/introduction)
-- [@partylayer/session: createCookieStorage](https://www.npmjs.com/package/@partylayer/session)
+- [Quick start](https://partylayer.xyz/docs/quick-start)
+- [Kit configuration](https://partylayer.xyz/docs/partylayer-kit)
+- [Authentication](https://partylayer.xyz/docs/authentication)
+- [Transaction lifecycle](https://partylayer.xyz/docs/transaction-lifecycle)

package/templates/next-ssr/_package.json

@@ -10,9 +10,9 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "@partylayer/react": "^2.1.0",
-    "@partylayer/sdk": "^0.18.0",
-    "@partylayer/session": "^1.1.4",
+    "@partylayer/react": "^3.1.0",
+    "@partylayer/sdk": "^0.20.0",
+    "@partylayer/session": "^1.1.9",
     "@tanstack/react-query": "^5.0.0",
     "next": "^14.2.5",
     "react": "^18.3.1",

package/templates/react-dvp/README.md

@@ -18,9 +18,8 @@ the request and wrap the query or mutation.
 ## Run it
 
 ```bash
-npm create partylayer-app@latest my-app -- --template react-dvp
+npm create partylayer-app@latest my-app -- --template react-dvp --pm npm
 cd my-app
-npm install
 npm run dev
 ```
 
@@ -132,3 +131,10 @@ disclosed contract and choice context types (`TokenDisclosedContract`,
 `TokenChoiceContext`, `TokenTransferFactory`, `TokenAllocationFactory`) plus
 `mergeDisclosedContracts` for combining the disclosures of several registry contexts
 into one submission.
+
+Wallet SDKs are included. Vala requires Devnet with `channel="beta"`. WalletConnect requires your project id through `walletConnect`; Bron requires OAuth/API configuration through `bron`. No separate wallet SDK installation or registration is needed.
+
+The CLI installs dependencies unless `--no-install` was selected. These demo
+backend outcomes do not prove connected-wallet signing or ledger settlement.
+The default connection UI shows **Powered by PartyLayer**; backend authentication
+and live command/settlement verification remain application responsibilities.

package/templates/react-dvp/_package.json

@@ -9,9 +9,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@partylayer/react": "^2.2.1",
-    "@partylayer/sdk": "^0.18.0",
-    "@partylayer/adapter-console": "^0.3.15",
+    "@partylayer/react": "^3.1.0",
+    "@partylayer/sdk": "^0.20.0",
     "@tanstack/react-query": "^5.0.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"

package/templates/react-dvp/src/App.tsx

@@ -15,7 +15,6 @@ import {
   themes,
   type SynchronizerOption,
 } from '@partylayer/react';
-import { ConsoleAdapter } from '@partylayer/adapter-console';
 import { DemoProvider } from './context/DemoContext';
 import { demoBackend } from './lib/backend';
 import { PARTIES, PARTY_ORDER } from './lib/fixtures';
@@ -25,10 +24,7 @@ import { MyAllocations } from './sections/MyAllocations';
 import { Holdings } from './sections/Holdings';
 import './App.css';
 
-// The dev wallet adapter apps/demo uses, so the connect surface works in a demo
-// context. The demo-party switcher, not this connection, drives the section data.
-const ADAPTERS = [new ConsoleAdapter()];
-
+// PartyLayerKit uses the public SDK default wallet catalog.
 const SYNCHRONIZERS: SynchronizerOption[] = [
   { networkId: 'canton:da-devnet', label: 'DevNet' },
   { networkId: 'canton:da-testnet', label: 'TestNet' },
@@ -42,7 +38,7 @@ export default function App() {
   const theme = mode === 'dark' ? themes.gold.dark : themes.gold.light;
 
   return (
-    <PartyLayerKit network="devnet" appName="PartyLayer DvP" theme={theme} adapters={ADAPTERS}>
+    <PartyLayerKit network="devnet" appName="PartyLayer DvP" theme={theme}>
       <DemoProvider value={{ party, setParty, backend: demoBackend, mode }}>
         <div className={'app app-' + mode}>
           <header className="topbar">

package/templates/react-tokenization/README.md

@@ -17,9 +17,8 @@ hooks type the request and wrap the query or mutation.
 ## Run it
 
 ```bash
-npm create partylayer-app@latest my-app -- --template react-tokenization
+npm create partylayer-app@latest my-app -- --template react-tokenization --pm npm
 cd my-app
-npm install
 npm run dev
 ```
 
@@ -42,8 +41,8 @@ writes the typed hooks do not cover.
 
 ## Demo flows
 
-1. Connect. Click Connect Wallet in the header. The console adapter is registered, so
-   the wallet modal renders themed by the teal family. The sections below are driven
+1. Connect. Click Connect Wallet in the header. The default wallet catalog is included, and
+   the wallet modal uses the teal theme. The sections below are driven
    by the demo-party switcher, not the connection.
 2. View holdings with a frozen lock. As Alice, the Holdings card shows two holdings;
    one carries a lock and renders a "Locked: frozen by issuer" badge.
@@ -137,3 +136,10 @@ registry-defined.
 
 The official Splice token-standard CLI is the canonical reference for these registry
 flows.
+
+Wallet SDKs are included. Vala requires Devnet with `channel="beta"`. WalletConnect requires your project id through `walletConnect`; Bron requires OAuth/API configuration through `bron`. No separate wallet SDK installation or registration is needed.
+
+The CLI installs dependencies unless `--no-install` was selected. These demo
+backend outcomes do not prove connected-wallet signing or ledger settlement.
+The default connection UI shows **Powered by PartyLayer**; backend authentication
+and live command/settlement verification remain application responsibilities.

package/templates/react-tokenization/_package.json

@@ -9,9 +9,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@partylayer/react": "^2.2.1",
-    "@partylayer/sdk": "^0.18.0",
-    "@partylayer/adapter-console": "^0.3.15",
+    "@partylayer/react": "^3.1.0",
+    "@partylayer/sdk": "^0.20.0",
     "@tanstack/react-query": "^5.0.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"

package/templates/react-tokenization/src/App.tsx

@@ -15,7 +15,6 @@ import {
   themes,
   type SynchronizerOption,
 } from '@partylayer/react';
-import { ConsoleAdapter } from '@partylayer/adapter-console';
 import { DemoProvider } from './context/DemoContext';
 import { demoBackend } from './lib/backend';
 import { PARTIES, PARTY_ORDER } from './lib/fixtures';
@@ -27,10 +26,7 @@ import { Issuer } from './sections/Issuer';
 import { Allocations } from './sections/Allocations';
 import './App.css';
 
-// The dev wallet adapter apps/demo uses, so the connect surface works in a demo
-// context. The demo-party switcher, not this connection, drives the section data.
-const ADAPTERS = [new ConsoleAdapter()];
-
+// PartyLayerKit uses the public SDK default wallet catalog.
 const SYNCHRONIZERS: SynchronizerOption[] = [
   { networkId: 'canton:da-devnet', label: 'DevNet' },
   { networkId: 'canton:da-testnet', label: 'TestNet' },
@@ -44,7 +40,7 @@ export default function App() {
   const theme = mode === 'dark' ? themes.teal.dark : themes.teal.light;
 
   return (
-    <PartyLayerKit network="devnet" appName="PartyLayer Tokenization" theme={theme} adapters={ADAPTERS}>
+    <PartyLayerKit network="devnet" appName="PartyLayer Tokenization" theme={theme}>
       <DemoProvider value={{ party, setParty, backend: demoBackend, mode }}>
         <div className={'app app-' + mode}>
           <header className="topbar">

package/templates/react-vite/README.md

@@ -4,11 +4,15 @@ A [PartyLayer](https://partylayer.xyz) dApp: React + Vite, with Canton wallet in
 
 ## Develop
 
+The CLI installs dependencies unless `--no-install` was selected. If installation
+was skipped, run `npm install` first. The connection modal shows **Powered by PartyLayer**
+by default.
+
 ```bash
 npm run dev
 ```
 
-Open the app and click **Connect Wallet**. The modal lists every verified Canton wallet from the registry.
+Open the app and click **Connect Wallet**. The modal lists supported wallets for the configured network and channel.
 
 ## How it's wired
 
@@ -20,10 +24,12 @@ import { PartyLayerKit, ConnectButton } from '@partylayer/react';
 </PartyLayerKit>
 ```
 
-`<PartyLayerKit>` creates the client, registers all built-in wallet adapters, and provides session context. `<ConnectButton>` handles the full connect flow. Read the connected session with `useAccount()`.
+`<PartyLayerKit>` creates the client, loads the supported default wallet catalog, and provides session context. `<ConnectButton>` handles the full connect flow. Read the connected session with `useAccount()`.
 
 Switch networks by changing `network` to `"testnet"` or `"mainnet"` in `src/App.tsx`.
 
+A wallet session is not backend authentication. Use the [authentication guide](https://partylayer.xyz/docs/authentication) for sign-in and independently verify ledger outcomes for transfers/swaps. Send is Mainnet-only in the catalog.
+
 ## Build
 
 ```bash
@@ -32,5 +38,7 @@ npm run build && npm run preview
 
 ## Docs
 
-- [PartyLayer docs](https://partylayer.xyz/docs/introduction)
+- [PartyLayer docs](https://partylayer.xyz/docs)
 - [@partylayer/react](https://www.npmjs.com/package/@partylayer/react)
+
+Wallet SDKs are included. Vala requires Devnet with `channel="beta"`. WalletConnect requires your project id through `walletConnect`; Bron requires OAuth/API configuration through `bron`. No separate wallet SDK installation or registration is needed.

package/templates/react-vite/_package.json

@@ -9,8 +9,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@partylayer/react": "^2.1.0",
-    "@partylayer/sdk": "^0.18.0",
+    "@partylayer/react": "^3.1.0",
+    "@partylayer/sdk": "^0.20.0",
     "@tanstack/react-query": "^5.0.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"

package/templates/vanilla/README.md

@@ -1,36 +1,67 @@
 # {{PROJECT_NAME}}
 
-A [PartyLayer](https://partylayer.xyz) dApp: vanilla TypeScript + Vite, no framework.
+A Canton dApp using TypeScript, Vite and `@partylayer/sdk`. This template provides
+its own connection UI with **Powered by PartyLayer** attribution. React apps can
+use the ready-made kit and `ConnectButton` instead.
 
 ## Develop
 
+The CLI installs dependencies unless `--no-install` was selected. If needed, run
+`npm install`, then:
+
 ```bash
 npm run dev
 ```
 
-## How it's wired
+## How it works
+
+`src/main.ts` creates the client, renders its wallet list and handles connection
+from a user click. The SDK includes supported runtimes; no separate wallet package
+installation is required.
 
 ```ts
 import { createPartyLayer } from '@partylayer/sdk';
 
-const client = createPartyLayer({ network: 'devnet', app: { name: '{{PROJECT_NAME}}' } });
+const client = createPartyLayer({
+  network: 'devnet',
+  app: { name: '{{PROJECT_NAME}}' },
+});
 
-const wallets = await client.listWallets();        // verified wallets from the registry
-const session = await client.connect({ walletId }); // connect to one
-client.on('session:connected', () => { /* … */ });  // react to session changes
-client.on('session:disconnected', () => { /* … */ });
-const active = await client.getActiveSession();      // restore on load
+const wallets = await client.listWallets();
+// Connect the selected entry from a user click handler:
+// await client.connect({ walletId: selectedWallet.walletId });
+
+const active = await client.getActiveSession();
+// A saved cache alone never establishes a live connection.
 ```
 
-`createPartyLayer` is the dApp connect API, no framework bindings needed. See `src/main.ts` for the full hand-rolled connect UI. Switch networks by changing `network` to `"testnet"` or `"mainnet"`.
+Dispose the application-owned client with `client.destroy()` when its owner is
+removed. Use `client.disconnect()` for an explicit wallet disconnect.
+
+## Wallet configuration
+
+Change the `createPartyLayer` options in `src/main.ts`:
+
+- `network: 'devnet'`, `'testnet'` or `'mainnet'` filters the catalog.
+- Vala requires `network: 'devnet', channel: 'beta'`.
+- Send is Mainnet-only in the catalog.
+- WalletConnect needs `walletConnect: { projectId: 'YOUR_PROJECT_ID' }`.
+- Bron needs application-owned OAuth/API configuration through `bron`.
+- `additionalAdapters` extends defaults; `adapters` replaces them.
+
+Wallet accounts, login/approval and test funding remain prerequisites. A returned
+message signature is not proof of a transfer, swap or authenticated backend login.
 
 ## Build
 
 ```bash
-npm run build && npm run preview
+npm run build
+npm run preview
 ```
 
-## Docs
+## Documentation
 
-- [PartyLayer docs](https://partylayer.xyz/docs/introduction)
-- [@partylayer/sdk](https://www.npmjs.com/package/@partylayer/sdk)
+- [Framework-independent SDK](https://partylayer.xyz/docs/vanilla-js)
+- [Wallet configuration](https://partylayer.xyz/docs/wallets)
+- [Authentication](https://partylayer.xyz/docs/authentication)
+- [Transaction lifecycle](https://partylayer.xyz/docs/transaction-lifecycle)

package/templates/vanilla/_package.json

@@ -9,7 +9,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@partylayer/sdk": "^0.18.0"
+    "@partylayer/sdk": "^0.20.0"
   },
   "devDependencies": {
     "typescript": "^5.6.2",

package/templates/vanilla/src/main.ts

@@ -2,7 +2,7 @@ import { createPartyLayer, type Session } from '@partylayer/sdk';
 import './style.css';
 
 // The PartyLayer client — the dApp connect API (listWallets / connect / session).
-// All built-in wallet adapters are auto-registered.
+// The public SDK supplies the supported default wallet catalog.
 const client = createPartyLayer({ network: 'devnet', app: { name: '{{PROJECT_NAME}}' } });
 
 const app = document.querySelector<HTMLDivElement>('#app')!;
@@ -13,6 +13,7 @@ app.innerHTML = `
     <div id="status" class="status"></div>
     <button id="connect" class="btn">Connect Wallet</button>
     <ul id="wallets" class="wallets" hidden></ul>
+    <p><a href="https://partylayer.xyz" target="_blank" rel="noopener noreferrer">Powered by PartyLayer</a></p>
   </main>
 `;
 

package/templates/vue-nuxt-pinia/README.md

@@ -1,6 +1,6 @@
 # {{PROJECT_NAME}}
 
-A [PartyLayer](https://partylayer.xyz) dApp: Nuxt 3 + Vue 3 + Pinia, with **SSR session**.
+A [PartyLayer](https://partylayer.xyz) dApp: Nuxt 3 + Vue 3 + Pinia, with a custom connection UI, default PartyLayer attribution and explicit SSR UI session hints.
 
 ## Develop
 
@@ -23,5 +23,14 @@ npm run build && npm run preview
 
 ## Docs
 
-- [PartyLayer docs](https://partylayer.xyz/docs/introduction)
+- [PartyLayer docs](https://partylayer.xyz/docs)
 - [@partylayer/vue composables](https://www.npmjs.com/package/@partylayer/vue)
+
+Wallet SDKs are included. Configure the client in `plugins/partylayer.client.ts`:
+Vala needs `network: 'devnet', channel: 'beta'`; Send is Mainnet-only in the catalog.
+WalletConnect needs your project ID through `walletConnect`; Bron needs OAuth/API
+configuration through `bron`. No per-wallet installation is required.
+
+The cookie/server session is a UI hint, not application authentication. Never use
+its party ID alone to authorize backend access. See [authentication](https://partylayer.xyz/docs/authentication)
+for backend verification. Wallet login/approval and ledger settlement require their own checks.

package/templates/vue-nuxt-pinia/_package.json

@@ -10,9 +10,9 @@
     "postinstall": "nuxt prepare"
   },
   "dependencies": {
-    "@partylayer/sdk": "^0.18.0",
-    "@partylayer/session": "^1.1.4",
-    "@partylayer/vue": "^1.0.1",
+    "@partylayer/sdk": "^0.20.0",
+    "@partylayer/session": "^1.1.9",
+    "@partylayer/vue": "^2.0.1",
     "@pinia/nuxt": "^0.5.5",
     "@tanstack/vue-query": "^5.0.0",
     "pinia": "^2.2.0",

package/templates/vue-nuxt-pinia/app.vue

@@ -33,6 +33,7 @@ const sessionStore = useSessionStore();
       <code>{{ truncateParty(sessionStore.party ?? '') }}</code>
       <button class="btn" @click="sessionStore.disconnect()">Disconnect</button>
     </div>
+    <p><a href="https://partylayer.xyz" target="_blank" rel="noopener noreferrer">Powered by PartyLayer</a></p>
   </main>
 </template>