@bootnodedev/canton-connect 0.3.0 → 0.4.0

package/README.md

@@ -44,15 +44,16 @@ switching only once those gaps close. Until then, the machine earns its cost.
 
 ## Status
 
-Consumed by `dapp/frontend` in this repo as a workspace package. Not published (`private: true`).
+Published to npm as `@bootnodedev/canton-connect`. Also consumed by `dapp/frontend` in this repo,
+which links the local folder while its version satisfies the declared range.
 
 ## Install
 
 Peers a consumer installs beside it: `@canton-network/dapp-sdk`, `@canton-network/core-types`,
-`react` 19 and `@walletconnect/sign-client`. The last is declared optional, but `dapp-sdk` imports
-it statically at the top of its bundle (checked on 1.5.1), so it has to be present whether or not
-you set `walletConnectProjectId`. Only the session is lazy: `SignClient.init()` runs when a pairing
-starts, not at import.
+`react` 19 and `@walletconnect/sign-client`. The last is required here, though `dapp-sdk` marks it
+optional: `dapp-sdk` imports it statically at the top of its bundle (checked on 1.5.1), so it has to
+be present whether or not you set `walletConnectProjectId`. Only the session is lazy:
+`SignClient.init()` runs when a pairing starts, not at import.
 
 ## Usage
 
@@ -116,6 +117,39 @@ and a wallet-side disconnect look the same
 here. `useLedger().isReady` covers both, and `useParty().party` is `undefined` for the duration:
 gate session content on the party, and use `isLocked` only to explain why it went away.
 
+### Connecting through a Wallet Gateway
+
+```tsx
+import { RemoteAdapter } from '@canton-network/dapp-sdk'
+
+const config = {
+  appName: 'My dApp',
+  additionalAdapters: [
+    new RemoteAdapter({ name: 'Gateway', rpcUrl: 'http://localhost:3030/api/v0/dapp' }),
+  ],
+}
+```
+
+> [!NOTE]
+> The dapp-sdk wallet picker also lets a user paste any gateway URL and connect to it without the
+> dApp listing it. That session does not survive a reload; one with a gateway listed here does.
+
+Details in [architecture.md](https://github.com/BootNodeDev/canton-dappbooster/blob/main/canton-connect/architecture.md#remote-gateway).
+
+### Connecting through WalletConnect
+
+```tsx
+const config = {
+  appName: 'My dApp',
+  networkId: 'canton:devnet',
+  walletConnectProjectId: 'YOUR_REOWN_PROJECT_ID',
+}
+```
+
+`networkId` is the Canton network the dApp targets, as a CAIP-2 chain id.
+
+Details in [architecture.md](https://github.com/BootNodeDev/canton-dappbooster/blob/main/canton-connect/architecture.md#walletconnect).
+
 ## Reference
 
 Every hook and every config field is documented in JSDoc, which your editor surfaces at the call

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { a as Party, c as WalletSdk, i as ConnectionSubscription, l as ConnectionInput, n as CantonConnectContextValue, o as PartyType, r as ConnectionStatus, s as TxStatusSnapshot, t as CantonConnectConfig, u as InitOptions } from "./types-Deu_03jh.js";
+import { a as Party, c as WalletSdk, i as ConnectionSubscription, l as ConnectionInput, n as CantonConnectContextValue, o as PartyType, r as ConnectionStatus, s as TxStatusSnapshot, t as CantonConnectConfig, u as InitOptions } from "./types-CmnMRMoG.js";
 import { LedgerApiParams, PrepareExecuteParams, ProviderAdapter } from "@canton-network/dapp-sdk";
 import { JSX, ReactNode } from "react";
 //#region src/CantonConnectProvider/index.d.ts
@@ -15,7 +15,7 @@ import { JSX, ReactNode } from "react";
  *
  * @category Hooks
  */
-declare const useCantonConnectContext: () => CantonConnectContextValue;
+export declare const useCantonConnectContext: () => CantonConnectContextValue;
 /**
  * Props for {@link CantonConnectProvider}. `config` is read once, when the connection actor is
  * created: a `walletPicker` or `additionalAdapters` swapped later reaches `config` on the context,
@@ -43,7 +43,7 @@ interface CantonConnectProviderProps {
  *
  * @category Components
  */
-declare const CantonConnectProvider: ({ config, children }: CantonConnectProviderProps) => JSX.Element;
+export declare const CantonConnectProvider: ({ config, children }: CantonConnectProviderProps) => JSX.Element;
 //#endregion
 //#region src/connectError.d.ts
 /**
@@ -56,7 +56,7 @@ declare const CantonConnectProvider: ({ config, children }: CantonConnectProvide
  *
  * @category Errors
  */
-declare class ConnectCancelledError extends Error {
+export declare class ConnectCancelledError extends Error {
   constructor(cause?: unknown);
 }
 //#endregion
@@ -92,7 +92,7 @@ interface UseConnectResult {
  *
  * @category Hooks
  */
-declare const useConnect: () => UseConnectResult;
+export declare const useConnect: () => UseConnectResult;
 //#endregion
 //#region src/hooks/useDisconnect.d.ts
 /**
@@ -118,7 +118,7 @@ interface UseDisconnectResult {
  *
  * @category Hooks
  */
-declare const useDisconnect: () => UseDisconnectResult;
+export declare const useDisconnect: () => UseDisconnectResult;
 //#endregion
 //#region src/hooks/useExecute.d.ts
 /**
@@ -150,7 +150,7 @@ interface UseExecuteResult {
  *
  * @category Hooks
  */
-declare const useExecute: () => UseExecuteResult;
+export declare const useExecute: () => UseExecuteResult;
 //#endregion
 //#region src/hooks/useLedger.d.ts
 /**
@@ -172,11 +172,15 @@ interface UseLedgerResult {
  *
  * @example
  * const { ledgerApi } = useLedger()
- * await ledgerApi({ requestMethod: 'get', resource: '/v2/state/ledger-end' })
+ * await ledgerApi({
+ *   requestMethod: 'get',
+ *   resource: '/v2/users/{user-id}/rights',
+ *   path: { 'user-id': 'alice' },
+ * })
  *
  * @category Hooks
  */
-declare const useLedger: () => UseLedgerResult;
+export declare const useLedger: () => UseLedgerResult;
 //#endregion
 //#region src/hooks/useParty.d.ts
 /**
@@ -202,7 +206,7 @@ interface UsePartyResult {
  *
  * @category Hooks
  */
-declare const useParty: () => UsePartyResult;
+export declare const useParty: () => UsePartyResult;
 //#endregion
 //#region src/hooks/usePartyType.d.ts
 /**
@@ -232,7 +236,7 @@ interface UsePartyTypeResult {
  *
  * @category Hooks
  */
-declare const usePartyType: () => UsePartyTypeResult;
+export declare const usePartyType: () => UsePartyTypeResult;
 //#endregion
 //#region src/hooks/useSignMessage.d.ts
 /**
@@ -260,7 +264,7 @@ interface UseSignMessageResult {
  *
  * @category Hooks
  */
-declare const useSignMessage: () => UseSignMessageResult;
+export declare const useSignMessage: () => UseSignMessageResult;
 //#endregion
 //#region src/hooks/useWalletStatus.d.ts
 /**
@@ -288,7 +292,7 @@ interface UseWalletStatusResult {
  *
  * @category Hooks
  */
-declare const useWalletStatus: () => UseWalletStatusResult;
+export declare const useWalletStatus: () => UseWalletStatusResult;
 //#endregion
 //#region src/mock/mockAdapter.d.ts
 /**
@@ -337,6 +341,6 @@ interface MockAdapter extends ProviderAdapter {
  *
  * @category Utilities
  */
-declare const createMockAdapter: (options?: CreateMockAdapterOptions) => MockAdapter;
+export declare const createMockAdapter: (options?: CreateMockAdapterOptions) => MockAdapter;
 //#endregion
-export { type CantonConnectConfig, type CantonConnectContextValue, CantonConnectProvider, type CantonConnectProviderProps, ConnectCancelledError, type ConnectionInput, type ConnectionStatus, type ConnectionSubscription, type CreateMockAdapterOptions, type InitOptions, type LedgerApiParams, type MockAccount, type MockAdapter, type Party, type PartyType, type PrepareExecuteParams, type TxStatusSnapshot, type UseConnectResult, type UseDisconnectResult, type UseExecuteResult, type UseLedgerResult, type UsePartyResult, type UsePartyTypeResult, type UseSignMessageResult, type UseWalletStatusResult, type WalletSdk, createMockAdapter, useCantonConnectContext, useConnect, useDisconnect, useExecute, useLedger, useParty, usePartyType, useSignMessage, useWalletStatus };
+export type { CantonConnectConfig, CantonConnectContextValue, CantonConnectProviderProps, ConnectionInput, ConnectionStatus, ConnectionSubscription, CreateMockAdapterOptions, InitOptions, LedgerApiParams, MockAccount, MockAdapter, Party, PartyType, PrepareExecuteParams, TxStatusSnapshot, UseConnectResult, UseDisconnectResult, UseExecuteResult, UseLedgerResult, UsePartyResult, UsePartyTypeResult, UseSignMessageResult, UseWalletStatusResult, WalletSdk };

package/dist/index.js

@@ -188,7 +188,11 @@ const useExecute = () => {
 *
 * @example
 * const { ledgerApi } = useLedger()
-* await ledgerApi({ requestMethod: 'get', resource: '/v2/state/ledger-end' })
+* await ledgerApi({
+*   requestMethod: 'get',
+*   resource: '/v2/users/{user-id}/rights',
+*   path: { 'user-id': 'alice' },
+* })
 *
 * @category Hooks
 */

package/dist/testing/index.d.ts

@@ -1,4 +1,4 @@
-import { a as Party, c as WalletSdk, r as ConnectionStatus } from "../types-Deu_03jh.js";
+import { a as Party, c as WalletSdk, r as ConnectionStatus } from "../types-CmnMRMoG.js";
 import { WalletPickerFn } from "@canton-network/dapp-sdk";
 import { JSX, ReactNode } from "react";
 //#region src/testing/autoPicker.d.ts
@@ -14,7 +14,7 @@ import { JSX, ReactNode } from "react";
  *
  * @category Utilities
  */
-declare const createAutoPicker: (pick?: string) => WalletPickerFn;
+export declare const createAutoPicker: (pick?: string) => WalletPickerFn;
 //#endregion
 //#region src/testing/fakeSession.d.ts
 /**
@@ -50,7 +50,7 @@ interface FakeSessionProviderProps {
  *
  * @category Components
  */
-declare const FakeSessionProvider: ({ children, connectError, isLocked, party, readingAccounts, sdk, status: initialStatus }: FakeSessionProviderProps) => JSX.Element;
+export declare const FakeSessionProvider: ({ children, connectError, isLocked, party, readingAccounts, sdk, status: initialStatus }: FakeSessionProviderProps) => JSX.Element;
 //#endregion
 //#region src/testing/fakeWallet.d.ts
 /**
@@ -109,7 +109,7 @@ interface FakeWallet {
  *
  * @category Utilities
  */
-declare const createFakeWallet: (options: FakeWalletOptions) => FakeWallet;
+export declare const createFakeWallet: (options: FakeWalletOptions) => FakeWallet;
 //#endregion
 //#region src/testing/pause.d.ts
 /**
@@ -122,6 +122,6 @@ declare const createFakeWallet: (options: FakeWalletOptions) => FakeWallet;
  *
  * @category Utilities
  */
-declare const pause: (ms: number) => Promise<unknown>;
+export declare const pause: (ms: number) => Promise<unknown>;
 //#endregion
-export { FakeSessionProvider, type FakeSessionProviderProps, type FakeWallet, type FakeWalletAccount, type FakeWalletOptions, createAutoPicker, createFakeWallet, pause };
+export type { FakeSessionProviderProps, FakeWallet, FakeWalletAccount, FakeWalletOptions };

package/dist/{types-Deu_03jh.d.ts → types-CmnMRMoG.d.ts}

@@ -329,7 +329,22 @@ interface Party {
  * and that surface is yours. The app fields stay inert until `walletConnectProjectId` (Reown) is set.
  *
  * @example
- * const config: CantonConnectConfig = { appName: 'Vesting', networkId: 'canton:devnet' }
+ * const config: CantonConnectConfig = {
+ *   appName: 'Vesting',
+ *   networkId: 'canton:devnet',
+ *   walletConnectProjectId: 'REOWN_PROJECT_ID',
+ * }
+ *
+ * @example
+ * import type { CantonConnectConfig } from '#src/types'
+ * import { RemoteAdapter } from '@canton-network/dapp-sdk'
+ *
+ * const config: CantonConnectConfig = {
+ *   appName: 'Vesting',
+ *   additionalAdapters: [
+ *     new RemoteAdapter({ name: 'Gateway', rpcUrl: 'https://gateway.example.com/dapp' }),
+ *   ],
+ * }
  *
  * @category Configuration
  */

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@bootnodedev/canton-connect",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "wagmi-style React hooks for connecting Canton dApps to CIP-0103 wallets",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BootNodeDev/canton-dappbooster.git",
+    "directory": "canton-connect"
+  },
   "license": "MIT",
   "type": "module",
   "private": false,
@@ -44,11 +49,6 @@
     "@walletconnect/sign-client": "^2.23.9",
     "react": "^19.0.0"
   },
-  "peerDependenciesMeta": {
-    "@walletconnect/sign-client": {
-      "optional": true
-    }
-  },
   "devDependencies": {
     "@canton-network/core-types": "1.10.0",
     "@canton-network/dapp-sdk": "1.5.1",
@@ -58,16 +58,16 @@
     "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^6.0.4",
-    "@vitest/coverage-v8": "^4.1.11",
+    "@vitest/coverage-v8": "^5.0.0",
     "@walletconnect/sign-client": "^2.23.9",
     "@walletconnect/types": "^2.23.9",
     "jsdom": "^30.0.0",
     "react": "^19.2.8",
     "react-dom": "^19.2.8",
-    "tsdown": "^0.22.14",
+    "tsdown": "^0.23.0",
     "typescript": "^5.9.3",
     "vite": "^8.1.5",
-    "vitest": "^4.1.10"
+    "vitest": "^5.0.0"
   },
   "dependencies": {
     "@xstate/react": "^6.1.0",