@canton-network/dapp-sdk 0.26.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/sdk.d.ts CHANGED
@@ -20,6 +20,7 @@ export declare class DappSDK {
20
20
  private client;
21
21
  private initPromise;
22
22
  private dynamicAdapterIds;
23
+ private configuredAdapters;
23
24
  constructor(options?: {
24
25
  walletPicker?: WalletPickerFn | undefined;
25
26
  });
@@ -27,8 +28,8 @@ export declare class DappSDK {
27
28
  private registerInjectedNamespaceAdapters;
28
29
  private registerAnnouncedAdapters;
29
30
  private ensureDiscovery;
31
+ private getInitAdapters;
30
32
  private collectDetectedAdapters;
31
- private ensureInit;
32
33
  private saveRecentGateway;
33
34
  private getHttpStatusCode;
34
35
  private formatConnectionErrorMessage;
@@ -40,7 +41,33 @@ export declare class DappSDK {
40
41
  * are not wrapped by the higher-level SDK helpers.
41
42
  */
42
43
  getConnectedProvider(): Provider<DappRpcTypes> | null;
43
- connect(options?: DappSDKConnectOptions): Promise<ConnectResult>;
44
+ /**
45
+ * Cold-start the SDK: create (or update) the discovery client, register adapters,
46
+ * and attempt to restore a persisted wallet session without opening the picker.
47
+ *
48
+ * Call early on app mount with your adapter configuration. For the exported
49
+ * {@link sdk} singleton, the **first** `init()` call (with or without options)
50
+ * determines how {@link ensureDiscovery} builds the initial adapter list; pass
51
+ * `options` on that first call when you need custom gateways or extra adapters.
52
+ *
53
+ * Adapter selection when discovery is first created (see {@link getInitAdapters}):
54
+ * - If `options` is passed on this call, use those adapters (default gateways apply when
55
+ * `defaultAdapters` is omitted).
56
+ * - Else if {@link configuredAdapters} was set by an earlier `init(options)`, use it.
57
+ * - Else use the last remote gateway URL from app-local hints (if any), otherwise
58
+ * fall back to default gateways (`gateways.json`).
59
+ *
60
+ * Session restore itself is always performed by {@link DiscoveryClient} via
61
+ * `restorePersistedSessionIfNeeded()`; the SDK only ensures a compatible adapter set
62
+ * is registered first.
63
+ *
64
+ * Safe to call from multiple places: concurrent callers share the same in-flight
65
+ * promise; discovery creation itself still happens at most once per SDK instance.
66
+ */
67
+ init(options?: DappSDKConnectOptions): Promise<void>;
68
+ connect(): Promise<ConnectResult>;
69
+ /** @deprecated Pass options to `init()` instead. */
70
+ connect(options: DappSDKConnectOptions): Promise<ConnectResult>;
44
71
  disconnect(): Promise<null>;
45
72
  isConnected(): Promise<ConnectResult>;
46
73
  status(): Promise<StatusEvent>;
@@ -59,7 +86,14 @@ export declare class DappSDK {
59
86
  removeOnTxChanged(listener: EventListener<TxChangedEvent>): Promise<void>;
60
87
  }
61
88
  export declare const sdk: DappSDK;
62
- export declare const connect: (options?: DappSDKConnectOptions) => Promise<ConnectResult>;
89
+ /**
90
+ * Opens the wallet picker and connects. Prefer {@link init} with adapters at startup;
91
+ * `options` here is a legacy convenience that forwards to {@link DappSDK.init}.
92
+ */
93
+ export declare function connect(): Promise<ConnectResult>;
94
+ /** @deprecated Pass options to `init()` instead. */
95
+ export declare function connect(options: DappSDKConnectOptions): Promise<ConnectResult>;
96
+ export declare const init: (options?: DappSDKConnectOptions) => Promise<void>;
63
97
  export declare const disconnect: () => Promise<null>;
64
98
  export declare const isConnected: () => Promise<ConnectResult>;
65
99
  export declare const status: () => Promise<StatusEvent>;
package/dist/sdk.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,OAAO,EAEH,KAAK,eAAe,EAEpB,KAAK,cAAc,EACtB,MAAM,uCAAuC,CAAA;AAO9C,OAAO,KAAK,EACR,aAAa,EACb,QAAQ,EACX,MAAM,sCAAsC,CAAA;AAC7C,OAAO,KAAK,EACR,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,QAAQ,IAAI,YAAY,EAC3B,MAAM,6CAA6C,CAAA;AAepD,MAAM,WAAW,qBAAqB,CAClC,eAAe,SAAS,eAAe,GAAG,eAAe;IAEzD,eAAe,CAAC,EAAE,eAAe,EAAE,CAAA;IACnC,kBAAkB,CAAC,EAAE,eAAe,EAAE,GAAG,SAAS,CAAA;CACrD;AAED,qBAAa,OAAO;IAChB,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAgC;IACpE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAC7C,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,MAAM,CAA0B;IACxC,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,iBAAiB,CAAoB;gBAEjC,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;KAAE;YAKrD,gBAAgB;YAmBhB,iCAAiC;YAwBjC,yBAAyB;YA0BzB,eAAe;YAgEf,uBAAuB;YAYvB,UAAU;IASxB,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,4BAA4B;IAqBpC,OAAO,CAAC,aAAa;IAMrB;;;;;OAKG;IACH,oBAAoB,IAAI,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAM/C,OAAO,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC;IA8HhE,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB3B,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC;IAYrC,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;IAK9B,YAAY,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAI3C,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D,qBAAqB,CACvB,MAAM,EAAE,oBAAoB,GAC7B,OAAO,CAAC,2BAA2B,CAAC;IAIjC,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAI5D,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,eAAe,CAAC,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE,iBAAiB,CACnB,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;IAIV,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAInE,qBAAqB,CACvB,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC;IAKV,uBAAuB,CACzB,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;IAKV,iBAAiB,CACnB,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC;IAKV,iBAAiB,CACnB,QAAQ,EAAE,aAAa,CAAC,cAAc,CAAC,GACxC,OAAO,CAAC,IAAI,CAAC;CAInB;AAED,eAAO,MAAM,GAAG,SAAgB,CAAA;AAEhC,eAAO,MAAM,OAAO,GAChB,UAAU,qBAAqB,KAChC,OAAO,CAAC,aAAa,CAOvB,CAAA;AAED,eAAO,MAAM,UAAU,QAAO,OAAO,CAAC,IAAI,CAAqB,CAAA;AAE/D,eAAO,MAAM,WAAW,QAAO,OAAO,CAAC,aAAa,CAAsB,CAAA;AAE1E,eAAO,MAAM,MAAM,QAAO,OAAO,CAAC,WAAW,CAAiB,CAAA;AAE9D,eAAO,MAAM,YAAY,QAAO,OAAO,CAAC,kBAAkB,CACpC,CAAA;AAEtB,eAAO,MAAM,cAAc,GAAI,QAAQ,oBAAoB,KAAG,OAAO,CAAC,IAAI,CAC5C,CAAA;AAE9B,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,oBAAoB,KAC7B,OAAO,CAAC,2BAA2B,CAAsC,CAAA;AAE5E,eAAO,MAAM,SAAS,GAAI,QAAQ,eAAe,KAAG,OAAO,CAAC,eAAe,CAClD,CAAA;AAEzB,eAAO,MAAM,IAAI,QAAO,OAAO,CAAC,IAAI,CAAe,CAAA;AAEnD,eAAO,MAAM,oBAAoB,QAAO,UAAU,CAC9C,OAAO,CAAC,sBAAsB,CAAC,CACJ,CAAA;AAE/B,eAAO,MAAM,eAAe,GACxB,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAAkC,CAAA;AAEjD,eAAO,MAAM,iBAAiB,GAC1B,UAAU,aAAa,CAAC,oBAAoB,CAAC,KAC9C,OAAO,CAAC,IAAI,CAAoC,CAAA;AAEnD,eAAO,MAAM,WAAW,GACpB,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAA8B,CAAA;AAE7C,eAAO,MAAM,WAAW,GACpB,UAAU,aAAa,CAAC,cAAc,CAAC,KACxC,OAAO,CAAC,IAAI,CAA8B,CAAA;AAE7C,eAAO,MAAM,qBAAqB,GAC9B,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAAwC,CAAA;AAEvD,eAAO,MAAM,uBAAuB,GAChC,UAAU,aAAa,CAAC,oBAAoB,CAAC,KAC9C,OAAO,CAAC,IAAI,CAA0C,CAAA;AAEzD,eAAO,MAAM,iBAAiB,GAC1B,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAAoC,CAAA;AAEnD,eAAO,MAAM,iBAAiB,GAC1B,UAAU,aAAa,CAAC,cAAc,CAAC,KACxC,OAAO,CAAC,IAAI,CAAoC,CAAA"}
1
+ {"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,OAAO,EAEH,KAAK,eAAe,EAEpB,KAAK,cAAc,EACtB,MAAM,uCAAuC,CAAA;AAO9C,OAAO,KAAK,EACR,aAAa,EACb,QAAQ,EACX,MAAM,sCAAsC,CAAA;AAC7C,OAAO,KAAK,EACR,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,QAAQ,IAAI,YAAY,EAC3B,MAAM,6CAA6C,CAAA;AAepD,MAAM,WAAW,qBAAqB,CAClC,eAAe,SAAS,eAAe,GAAG,eAAe;IAEzD,eAAe,CAAC,EAAE,eAAe,EAAE,CAAA;IACnC,kBAAkB,CAAC,EAAE,eAAe,EAAE,GAAG,SAAS,CAAA;CACrD;AAcD,qBAAa,OAAO;IAChB,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAgC;IACpE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAC7C,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,MAAM,CAA0B;IACxC,OAAO,CAAC,WAAW,CAAgC;IACnD,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,kBAAkB,CAAmC;gBAEjD,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;KAAE;YAKrD,gBAAgB;YAmBhB,iCAAiC;YAwBjC,yBAAyB;YA0BzB,eAAe;IAwC7B,OAAO,CAAC,eAAe;YAuBT,uBAAuB;IAYrC,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,4BAA4B;IAqBpC,OAAO,CAAC,aAAa;IAMrB;;;;;OAKG;IACH,oBAAoB,IAAI,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAMrD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBpD,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC;IACvC,oDAAoD;IAC9C,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC;IAoI/D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB3B,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC;IAYrC,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;IAM9B,YAAY,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAI3C,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D,qBAAqB,CACvB,MAAM,EAAE,oBAAoB,GAC7B,OAAO,CAAC,2BAA2B,CAAC;IAIjC,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAI5D,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,eAAe,CAAC,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE,iBAAiB,CACnB,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;IAIV,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAInE,qBAAqB,CACvB,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC;IAKV,uBAAuB,CACzB,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;IAKV,iBAAiB,CACnB,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC;IAKV,iBAAiB,CACnB,QAAQ,EAAE,aAAa,CAAC,cAAc,CAAC,GACxC,OAAO,CAAC,IAAI,CAAC;CAInB;AAED,eAAO,MAAM,GAAG,SAAgB,CAAA;AAEhC;;;GAGG;AACH,wBAAgB,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,CAAA;AACjD,oDAAoD;AACpD,wBAAgB,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;AAU/E,eAAO,MAAM,IAAI,GAAI,UAAU,qBAAqB,KAAG,OAAO,CAAC,IAAI,CAC9C,CAAA;AAErB,eAAO,MAAM,UAAU,QAAO,OAAO,CAAC,IAAI,CAAqB,CAAA;AAE/D,eAAO,MAAM,WAAW,QAAO,OAAO,CAAC,aAAa,CAAsB,CAAA;AAE1E,eAAO,MAAM,MAAM,QAAO,OAAO,CAAC,WAAW,CAAiB,CAAA;AAE9D,eAAO,MAAM,YAAY,QAAO,OAAO,CAAC,kBAAkB,CACpC,CAAA;AAEtB,eAAO,MAAM,cAAc,GAAI,QAAQ,oBAAoB,KAAG,OAAO,CAAC,IAAI,CAC5C,CAAA;AAE9B,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,oBAAoB,KAC7B,OAAO,CAAC,2BAA2B,CAAsC,CAAA;AAE5E,eAAO,MAAM,SAAS,GAAI,QAAQ,eAAe,KAAG,OAAO,CAAC,eAAe,CAClD,CAAA;AAEzB,eAAO,MAAM,IAAI,QAAO,OAAO,CAAC,IAAI,CAAe,CAAA;AAEnD,eAAO,MAAM,oBAAoB,QAAO,UAAU,CAC9C,OAAO,CAAC,sBAAsB,CAAC,CACJ,CAAA;AAE/B,eAAO,MAAM,eAAe,GACxB,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAAkC,CAAA;AAEjD,eAAO,MAAM,iBAAiB,GAC1B,UAAU,aAAa,CAAC,oBAAoB,CAAC,KAC9C,OAAO,CAAC,IAAI,CAAoC,CAAA;AAEnD,eAAO,MAAM,WAAW,GACpB,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAA8B,CAAA;AAE7C,eAAO,MAAM,WAAW,GACpB,UAAU,aAAa,CAAC,cAAc,CAAC,KACxC,OAAO,CAAC,IAAI,CAA8B,CAAA;AAE7C,eAAO,MAAM,qBAAqB,GAC9B,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAAwC,CAAA;AAEvD,eAAO,MAAM,uBAAuB,GAChC,UAAU,aAAa,CAAC,oBAAoB,CAAC,KAC9C,OAAO,CAAC,IAAI,CAA0C,CAAA;AAEzD,eAAO,MAAM,iBAAiB,GAC1B,UAAU,aAAa,CAAC,WAAW,CAAC,KACrC,OAAO,CAAC,IAAI,CAAoC,CAAA;AAEnD,eAAO,MAAM,iBAAiB,GAC1B,UAAU,aAAa,CAAC,cAAc,CAAC,KACxC,OAAO,CAAC,IAAI,CAAoC,CAAA"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@canton-network/dapp-sdk",
3
3
  "type": "module",
4
- "version": "0.26.0",
4
+ "version": "1.1.0",
5
5
  "description": "Browser SDK for dApp development on the Canton Network",
6
6
  "license": "Apache-2.0",
7
7
  "author": "Marc Juchli <marc.juchli@digitalasset.com>",
@@ -25,19 +25,36 @@
25
25
  "test:coverage": "vitest run --project browser --coverage --passWithNoTests"
26
26
  },
27
27
  "dependencies": {
28
- "@canton-network/core-provider-dapp": "^0.10.0",
29
- "@canton-network/core-rpc-transport": "^0.12.0",
30
- "@canton-network/core-splice-provider": "^0.34.0",
31
- "@canton-network/core-types": "^0.26.0",
32
- "@canton-network/core-wallet-dapp-remote-rpc-client": "^0.27.0",
33
- "@canton-network/core-wallet-dapp-rpc-client": "^0.33.0",
34
- "@canton-network/core-wallet-discovery": "^0.10.0",
35
- "@canton-network/core-wallet-ui-components": "^0.33.0"
28
+ "@canton-network/core-provider-dapp": "^1.1.0",
29
+ "@canton-network/core-rpc-transport": "^1.1.0",
30
+ "@canton-network/core-splice-provider": "^1.1.0",
31
+ "@canton-network/core-types": "^1.1.0",
32
+ "@canton-network/core-wallet-dapp-remote-rpc-client": "^1.1.0",
33
+ "@canton-network/core-wallet-dapp-rpc-client": "^1.1.0",
34
+ "@canton-network/core-wallet-discovery": "^1.1.0",
35
+ "@canton-network/core-wallet-ui-components": "^1.1.0",
36
+ "qrcode": "^1.5.4"
37
+ },
38
+ "peerDependencies": {
39
+ "@walletconnect/sign-client": "^2.23.8",
40
+ "@walletconnect/types": "^2.23.8"
41
+ },
42
+ "peerDependenciesMeta": {
43
+ "@walletconnect/sign-client": {
44
+ "optional": true
45
+ },
46
+ "@walletconnect/types": {
47
+ "optional": true
48
+ }
36
49
  },
37
50
  "devDependencies": {
51
+ "@types/qrcode": "^1.5.6",
38
52
  "@vitest/browser-playwright": "^4.1.2",
39
53
  "@vitest/coverage-v8": "^4.1.2",
54
+ "@walletconnect/sign-client": "^2.23.8",
55
+ "@walletconnect/types": "^2.23.8",
40
56
  "playwright": "^1.58.2",
57
+ "qrcode": "^1.5.4",
41
58
  "tsup": "^8.5.1",
42
59
  "typescript": "^5.9.3",
43
60
  "vitest": "^4.1.2"