@bootnodedev/canton-connect 0.3.0 → 0.3.1

package/README.md

@@ -116,6 +116,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
@@ -172,7 +172,11 @@ 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
  */

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

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.3.1",
   "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",