diff --git a/config/x2mdx/typescript-bindings/source-artifacts.json b/config/x2mdx/typescript-bindings/source-artifacts.json index 4192ae872..82d5f10b7 100644 --- a/config/x2mdx/typescript-bindings/source-artifacts.json +++ b/config/x2mdx/typescript-bindings/source-artifacts.json @@ -9,12 +9,13 @@ "page_description": "TypeScript and JavaScript language bindings for Canton.", "output_file": "docs-main/reference/typescript.mdx", "entry_point": "index.d.ts", - "publish_version": "3.4.11", + "publish_version": "3.5.2", "versions": [ "3.4.8", "3.4.9", "3.4.10", - "3.4.11" + "3.4.11", + "3.5.2" ] }, { @@ -44,9 +45,10 @@ "typedoc_args": [ "--skipErrorChecking" ], - "publish_version": "1.1.0", + "publish_version": "1.3.0", "versions": [ - "1.1.0" + "1.1.0", + "1.3.0" ] } ] diff --git a/docs-main/reference/typescript.mdx b/docs-main/reference/typescript.mdx index 9baad2aaf..128570175 100644 --- a/docs-main/reference/typescript.mdx +++ b/docs-main/reference/typescript.mdx @@ -58,6 +58,7 @@ Generated from published `@daml/types` TypeDoc snapshots. | `3.4.9` | - | `3` | - | | `3.4.10` | - | - | - | | `3.4.11` | - | - | - | +| `3.5.2` | - | - | - | ## Reference diff --git a/docs-main/reference/typescript/dapp-sdk.mdx b/docs-main/reference/typescript/dapp-sdk.mdx index a5b2912df..cfc955c63 100644 --- a/docs-main/reference/typescript/dapp-sdk.mdx +++ b/docs-main/reference/typescript/dapp-sdk.mdx @@ -9,15 +9,14 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. | Name | Kind | Summary | Introduced | Changed | Deprecated | Removed | | --- | --- | --- | --- | --- | --- | --- | -| [`dappAPI`](#namespace-dappapi) | Namespace | - | `1.1.0` | - | - | - | +| [`dappAPI`](#namespace-dappapi) | Namespace | - | `1.1.0` | `1.3.0`: details updated | - | - | | [`ErrorCode`](#enumeration-errorcode) | Enumeration | - | `1.1.0` | - | - | - | -| [`DappClient`](#class-dappclient) | Class | DappClient is a thin convenience wrapper around a connected
``Provider<DappRpcTypes>``.

It exposes typed RPC helpers, event subscription shortcuts,
``window.canton`` injection, and session-persistence listeners.

How to obtain a provider is **not** this class's concern.
Use ``DiscoveryClient`` + the wallet picker, or construct any
``Provider<DappRpcTypes>`` directly — then pass it here. | `1.1.0` | - | - | - | -| [`DappSDK`](#class-dappsdk) | Class | - | `1.1.0` | - | - | - | -| [`DiscoveryClient`](#class-discoveryclient) | Class | DiscoveryClient manages provider adapters and exposes a unified
Provider<DappRpcTypes> regardless of the underlying wallet type.

It is UI-framework agnostic — the wallet picker UI is injected
via the ``walletPicker`` config option.

Client-level events (``discovery:connected``, ``discovery:disconnected``,
``discovery:error``) track the adapter session lifecycle. Provider-level
CIP-103 events (statusChanged, accountsChanged, txChanged) live on
the Provider — subscribe via ``client.getProvider().on(...)``. | `1.1.0` | - | - | - | +| [`DappClient`](#class-dappclient) | Class | DappClient is a thin convenience wrapper around a connected
``Provider<DappRpcTypes>``.

It exposes typed RPC helpers, event subscription shortcuts,
and session-persistence listeners.

How to obtain a provider is **not** this class's concern.
Use ``DiscoveryClient`` + the wallet picker, or construct any
``Provider<DappRpcTypes>`` directly — then pass it here. | `1.1.0` | `1.3.0`: summary updated; members added: `onMessageSignature`, `removeOnMessageSignature`, `signMessage` | - | - | +| [`DappSDK`](#class-dappsdk) | Class | - | `1.1.0` | `1.3.0`: members added: `onMessageSignature`, `removeOnMessageSignature`, `signMessage` | - | - | +| [`DiscoveryClient`](#class-discoveryclient) | Class | DiscoveryClient manages provider adapters and exposes a unified
Provider<DappRpcTypes> regardless of the underlying wallet type.

It is UI-framework agnostic — the wallet picker UI is injected
via the ``walletPicker`` config option.

Client-level events (``discovery:connected``, ``discovery:disconnected``,
``discovery:error``) track the adapter session lifecycle. Provider-level
CIP-103 events (statusChanged, accountsChanged, txChanged) live on
the Provider — subscribe via ``client.getProvider().on(...)``. | `1.1.0` | `1.3.0`: details updated | - | - | | [`DiscoveryError`](#class-discoveryerror) | Class | - | `1.1.0` | - | - | - | | [`EventEmitter`](#class-eventemitter) | Class | - | `1.1.0` | - | - | - | | [`ExtensionAdapter`](#class-extensionadapter) | Class | ProviderAdapter for any CIP-103 compliant wallet exposed as a browser extension.

provider() returns a DappProvider which communicates via postMessage
and implements the full openrpc-dapp-api.json surface directly. | `1.1.0` | - | - | - | -| [`InjectedAdapter`](#class-injectedadapter) | Class | A ProviderAdapter is a thin factory that knows how to create a
Provider<DappRpcTypes> for a particular wallet type, detect its
availability, and clean up resources.

All RPC methods (connect, disconnect, status, prepareExecute, etc.)
are called directly on the provider — the adapter does not duplicate them. | `1.1.0` | - | - | - | | [`NotConnectedError`](#class-notconnectederror) | Class | - | `1.1.0` | - | - | - | | [`RemoteAdapter`](#class-remoteadapter) | Class | ProviderAdapter for any CIP-103 compliant wallet reachable over HTTP/SSE.

provider() returns a provider that maps the remote API
(openrpc-dapp-remote-api.json) to the dApp API
(openrpc-dapp-api.json) via dappSDKController. | `1.1.0` | - | - | - | | [`SessionExpiredError`](#class-sessionexpirederror) | Class | - | `1.1.0` | - | - | - | @@ -26,17 +25,18 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. | [`WalletConnectAdapter`](#class-walletconnectadapter) | Class | Single-class WalletConnect adapter that implements both ProviderAdapter
(for discovery/wallet-picker) and Provider<DappRpcTypes> (for RPC calls).

Calls signClient.request() directly with ``canton_`` prefixed methods.
Events arriving via session_event are buffered until a listener attaches. | `1.1.0` | - | - | - | | [`WalletNotFoundError`](#class-walletnotfounderror) | Class | - | `1.1.0` | - | - | - | | [`WalletNotInstalledError`](#class-walletnotinstallederror) | Class | - | `1.1.0` | - | - | - | +| [`InjectedAdapter`](#class-injectedadapter) | Class | A ProviderAdapter is a thin factory that knows how to create a
Provider<DappRpcTypes> for a particular wallet type, detect its
availability, and clean up resources.

All RPC methods (connect, disconnect, status, prepareExecute, etc.)
are called directly on the provider — the adapter does not duplicate them. | `1.1.0` | - | - | `1.3.0` | | [`ActiveSession`](#interface-activesession) | Interface | - | `1.1.0` | - | - | - | -| [`DappClientOptions`](#interface-dappclientoptions) | Interface | - | `1.1.0` | - | - | - | +| [`DappClientOptions`](#interface-dappclientoptions) | Interface | - | `1.1.0` | `1.3.0`: members removed: `injectGlobal` | - | - | | [`DiscoveryClientConfig`](#interface-discoveryclientconfig) | Interface | - | `1.1.0` | - | - | - | | [`DiscoveryConnectedEvent`](#interface-discoveryconnectedevent) | Interface | - | `1.1.0` | - | - | - | | [`DiscoveryDisconnectedEvent`](#interface-discoverydisconnectedevent) | Interface | - | `1.1.0` | - | - | - | | [`DiscoveryErrorEvent`](#interface-discoveryerrorevent) | Interface | - | `1.1.0` | - | - | - | -| [`ProviderAdapter`](#interface-provideradapter) | Interface | A ProviderAdapter is a thin factory that knows how to create a
Provider<DappRpcTypes> for a particular wallet type, detect its
availability, and clean up resources.

All RPC methods (connect, disconnect, status, prepareExecute, etc.)
are called directly on the provider — the adapter does not duplicate them. | `1.1.0` | - | - | - | +| [`ProviderAdapter`](#interface-provideradapter) | Interface | A ProviderAdapter is a thin factory that knows how to create a
Provider<DappRpcTypes> for a particular wallet type, detect its
availability, and clean up resources.

All RPC methods (connect, disconnect, status, prepareExecute, etc.)
are called directly on the provider — the adapter does not duplicate them. | `1.1.0` | `1.3.0`: details updated | - | - | | [`RemoteAdapterConfig`](#interface-remoteadapterconfig) | Interface | - | `1.1.0` | - | - | - | -| [`WalletConnectAdapterConfig`](#interface-walletconnectadapterconfig) | Interface | - | `1.1.0` | - | - | - | +| [`WalletConnectAdapterConfig`](#interface-walletconnectadapterconfig) | Interface | - | `1.1.0` | `1.3.0`: members added: `onSignInWithCanton`, `signInWithCanton` | - | - | | [`WalletInfo`](#interface-walletinfo) | Interface | - | `1.1.0` | - | - | - | -| [`WalletPickerEntry`](#interface-walletpickerentry) | Interface | Wallet picker entry and result | `1.1.0` | - | - | - | +| [`WalletPickerEntry`](#interface-walletpickerentry) | Interface | - | `1.1.0` | - | - | - | | [`WalletPickerResult`](#interface-walletpickerresult) | Interface | - | `1.1.0` | - | - | - | | [`DiscoveryClientEventHandler`](#type-alias-discoveryclienteventhandler) | Type Alias | - | `1.1.0` | - | - | - | | [`DiscoveryClientEventMap`](#type-alias-discoveryclienteventmap) | Type Alias | - | `1.1.0` | - | - | - | @@ -48,7 +48,7 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. | [`dappSDK`](#variable-dappsdk) | Variable | - | `1.1.0` | - | - | - | | [`ProviderAdapterConfig`](#variable-provideradapterconfig) | Variable | Provider adapter configuration | `1.1.0` | - | - | - | | [`WALLET_GATEWAY_ICON`](#variable-wallet-gateway-icon) | Variable | Alias for Wallet Gateway - same as Canton logo | `1.1.0` | - | - | - | -| [`connect`](#function-connect) | Function | Opens the wallet picker and connects. Prefer init with adapters at startup;
``options`` here is a legacy convenience that forwards to DappSDK.init. | `1.1.0` | - | - | - | +| [`connect`](#function-connect) | Function | Opens the wallet picker and connects. Prefer init with adapters at startup;
``options`` here is a legacy convenience that forwards to DappSDK.init. | `1.1.0` | `1.3.0`: details updated | - | - | | [`disconnect`](#function-disconnect) | Function | - | `1.1.0` | - | - | - | | [`getConnectedProvider`](#function-getconnectedprovider) | Function | - | `1.1.0` | - | - | - | | [`init`](#function-init) | Function | - | `1.1.0` | - | - | - | @@ -67,28 +67,29 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. | [`removeOnStatusChanged`](#function-removeonstatuschanged) | Function | - | `1.1.0` | - | - | - | | [`removeOnTxChanged`](#function-removeontxchanged) | Function | - | `1.1.0` | - | - | - | | [`status`](#function-status) | Function | - | `1.1.0` | - | - | - | -| [`AccountsChangedEvent`](#reference-accountschangedevent) | Reference | - | `1.1.0` | - | - | - | -| [`ConnectResult`](#reference-connectresult) | Reference | - | `1.1.0` | - | - | - | -| [`LedgerApiParams`](#reference-ledgerapiparams) | Reference | - | `1.1.0` | - | - | - | -| [`LedgerApiResult`](#reference-ledgerapiresult) | Reference | - | `1.1.0` | - | - | - | -| [`ListAccountsResult`](#reference-listaccountsresult) | Reference | - | `1.1.0` | - | - | - | -| [`Network`](#reference-network) | Reference | - | `1.1.0` | - | - | - | -| [`PrepareExecuteAndWaitResult`](#reference-prepareexecuteandwaitresult) | Reference | - | `1.1.0` | - | - | - | -| [`PrepareExecuteParams`](#reference-prepareexecuteparams) | Reference | - | `1.1.0` | - | - | - | -| [`ProviderId`](#reference-providerid) | Reference | - | `1.1.0` | - | - | - | -| [`ProviderType`](#reference-providertype) | Reference | - | `1.1.0` | - | - | - | -| [`Session`](#reference-session) | Reference | - | `1.1.0` | - | - | - | -| [`SignMessageParams`](#reference-signmessageparams) | Reference | - | `1.1.0` | - | - | - | -| [`SignMessageResult`](#reference-signmessageresult) | Reference | - | `1.1.0` | - | - | - | -| [`StatusEvent`](#reference-statusevent) | Reference | - | `1.1.0` | - | - | - | -| [`TxChangedEvent`](#reference-txchangedevent) | Reference | - | `1.1.0` | - | - | - | -| [`Wallet`](#reference-wallet) | Reference | - | `1.1.0` | - | - | - | +| [`AccountsChangedEvent`](#reference-accountschangedevent) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`ConnectResult`](#reference-connectresult) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`LedgerApiParams`](#reference-ledgerapiparams) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`LedgerApiResult`](#reference-ledgerapiresult) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`ListAccountsResult`](#reference-listaccountsresult) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`Network`](#reference-network) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`PrepareExecuteAndWaitResult`](#reference-prepareexecuteandwaitresult) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`PrepareExecuteParams`](#reference-prepareexecuteparams) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`ProviderId`](#reference-providerid) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`ProviderType`](#reference-providertype) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`Session`](#reference-session) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`SignMessageParams`](#reference-signmessageparams) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`SignMessageResult`](#reference-signmessageresult) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`StatusEvent`](#reference-statusevent) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`TxChangedEvent`](#reference-txchangedevent) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | +| [`Wallet`](#reference-wallet) | Reference | - | `1.1.0` | `1.3.0`: details updated | - | - | ## Version Change Summary | Version | Added | Changed | Removed | | --- | --- | --- | --- | | `1.1.0` | `74` | - | - | +| `1.3.0` | - | `24` | `1` | ## Reference @@ -100,8 +101,15 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. - Kind: `Namespace` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `node_modules/@canton-network/core-wallet-dapp-rpc-client/dist/index.d.ts:1` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + **Members** | Member | Type | Description | @@ -109,8 +117,15 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. | `WalletJSONRPCDAppAPI` | `void` | - | | `Body` | `void` | - | | `ConnectResult` | `void` | - | +| `CreateAndExerciseCommand` | `void` | - | +| `CreateAndExerciseCommandPayload` | `void` | Inner shape is defined by the Canton Ledger API CreateAndExerciseCommand schema; do not re-specify here. | +| `CreateCommand` | `void` | - | +| `CreateCommandPayload` | `void` | Inner shape is defined by the Canton Ledger API CreateCommand schema; do not re-specify here. | | `DisclosedContract` | `void` | Structure representing a disclosed contract for transaction execution | -| `JsCommands` | `void` | Structure representing JS commands for transaction execution | +| `ExerciseByKeyCommand` | `void` | - | +| `ExerciseByKeyCommandPayload` | `void` | Inner shape is defined by the Canton Ledger API ExerciseByKeyCommand schema; do not re-specify here. | +| `ExerciseCommand` | `void` | - | +| `ExerciseCommandPayload` | `void` | Inner shape is defined by the Canton Ledger API ExerciseCommand schema; do not re-specify here. | | `LedgerApiParams` | `void` | Ledger API request structure | | `LedgerApiResult` | `void` | Ledger Api response | | `MessageSignatureFailedEvent` | `void` | Event emitted when a message signature has failed. | @@ -137,7 +152,9 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. | `AccountsChanged` | `() => Promise` | - | | `AccountsChangedEvent` | `Wallet[]` | Event emitted when the user's accounts change. | | `ActAs` | `Party[]` | Set of parties on whose behalf the command should be executed, if submitted. If not set, the primary wallet's party is used. | +| `Command` | `CreateCommand \| ExerciseCommand \| CreateAndExerciseCommand \| ExerciseByKeyCommand` | A Daml command atom. Mirror of the Canton Ledger API Command union; inner shapes are intentionally opaque so the dApp layer never drifts from the Ledger API contract. | | `CommandId` | `string` | The unique identifier of the command associated with the transaction. | +| `Commands` | `Command[]` | Non-empty array of Daml command atoms to submit atomically as a single transaction. | | `CompletionOffset` | `number` | - | | `Connect` | `() => Promise` | - | | `ContractId` | `string` | The unique identifier of the disclosed contract. | @@ -229,13 +246,20 @@ Generated from published `@canton-network/dapp-sdk` TypeDoc snapshots. - Kind: `Class` - Introduced: `1.1.0` -- Source: `dist/client.d.ts:22` +- Changed in: `1.3.0` +- Source: `dist/client.d.ts:20` + +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | summary updated; members added: `onMessageSignature`, `removeOnMessageSignature`, `signMessage` | DappClient is a thin convenience wrapper around a connected ``Provider<DappRpcTypes>``. It exposes typed RPC helpers, event subscription shortcuts, -``window.canton`` injection, and session-persistence listeners. +and session-persistence listeners. How to obtain a provider is **not** this class's concern. Use ``DiscoveryClient`` + the wallet picker, or construct any @@ -254,6 +278,7 @@ Use ``DiscoveryClient`` + the wallet picker, or construct any | `listAccounts` | `void` | - | | `onAccountsChanged` | `void` | - | | `onConnected` | `void` | - | +| `onMessageSignature` | `void` | - | | `onStatusChanged` | `void` | - | | `onTxChanged` | `void` | - | | `open` | `void` | - | @@ -261,8 +286,10 @@ Use ``DiscoveryClient`` + the wallet picker, or construct any | `prepareExecuteAndWait` | `void` | - | | `removeOnAccountsChanged` | `void` | - | | `removeOnConnected` | `void` | - | +| `removeOnMessageSignature` | `void` | - | | `removeOnStatusChanged` | `void` | - | | `removeOnTxChanged` | `void` | - | +| `signMessage` | `void` | - | | `status` | `void` | - | @@ -271,7 +298,14 @@ Use ``DiscoveryClient`` + the wallet picker, or construct any - Kind: `Class` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:16` +- Changed in: `1.3.0` +- Source: `dist/sdk.d.ts:17` + +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | members added: `onMessageSignature`, `removeOnMessageSignature`, `signMessage` | **Members** @@ -287,6 +321,7 @@ Use ``DiscoveryClient`` + the wallet picker, or construct any | `listAccounts` | `void` | - | | `onAccountsChanged` | `void` | - | | `onConnected` | `void` | - | +| `onMessageSignature` | `void` | - | | `onStatusChanged` | `void` | - | | `onTxChanged` | `void` | - | | `open` | `void` | - | @@ -294,8 +329,10 @@ Use ``DiscoveryClient`` + the wallet picker, or construct any | `prepareExecuteAndWait` | `void` | - | | `removeOnAccountsChanged` | `void` | - | | `removeOnConnected` | `void` | - | +| `removeOnMessageSignature` | `void` | - | | `removeOnStatusChanged` | `void` | - | | `removeOnTxChanged` | `void` | - | +| `signMessage` | `void` | - | | `status` | `void` | - | @@ -304,8 +341,15 @@ Use ``DiscoveryClient`` + the wallet picker, or construct any - Kind: `Class` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:31` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + DiscoveryClient manages provider adapters and exposes a unified Provider<DappRpcTypes> regardless of the underlying wallet type. @@ -403,36 +447,6 @@ and implements the full openrpc-dapp-api.json surface directly. | `restore` | `void` | - | | `teardown` | `void` | - | - - -#### InjectedAdapter - -- Kind: `Class` -- Introduced: `1.1.0` -- Source: `dist/adapter/injected-adapter.d.ts:12` - -A ProviderAdapter is a thin factory that knows how to create a -Provider<DappRpcTypes> for a particular wallet type, detect its -availability, and clean up resources. - -All RPC methods (connect, disconnect, status, prepareExecute, etc.) -are called directly on the provider — the adapter does not duplicate them. - -**Members** - -| Member | Type | Description | -| --- | --- | --- | -| `constructor` | `void` | - | -| `icon` | `string` | - | -| `name` | `string` | - | -| `providerId` | `string` | - | -| `type` | `ProviderType` | - | -| `detect` | `void` | - | -| `getInfo` | `void` | - | -| `provider` | `void` | - | -| `restore` | `void` | - | -| `teardown` | `void` | - | - #### NotConnectedError @@ -557,7 +571,7 @@ provider() returns a provider that maps the remote API - Kind: `Class` - Introduced: `1.1.0` -- Source: `dist/adapter/walletconnect-adapter.d.ts:25` +- Source: `dist/adapter/walletconnect-adapter.d.ts:74` Single-class WalletConnect adapter that implements both ProviderAdapter (for discovery/wallet-picker) and Provider<DappRpcTypes> (for RPC calls). @@ -629,6 +643,38 @@ Events arriving via session_event are buffered until a listener attaches. | `captureStackTrace` | `void` | - | | `prepareStackTrace` | `void` | - | + + +#### InjectedAdapter + +- Kind: `Class` +- Introduced: `1.1.0` +- Removed in: `1.3.0` +- Shown for historical reference. +- Source: `dist/adapter/injected-adapter.d.ts:12` + +A ProviderAdapter is a thin factory that knows how to create a +Provider<DappRpcTypes> for a particular wallet type, detect its +availability, and clean up resources. + +All RPC methods (connect, disconnect, status, prepareExecute, etc.) +are called directly on the provider — the adapter does not duplicate them. + +**Members** + +| Member | Type | Description | +| --- | --- | --- | +| `constructor` | `void` | - | +| `icon` | `string` | - | +| `name` | `string` | - | +| `providerId` | `string` | - | +| `type` | `ProviderType` | - | +| `detect` | `void` | - | +| `getInfo` | `void` | - | +| `provider` | `void` | - | +| `restore` | `void` | - | +| `teardown` | `void` | - | + ### Interfaces @@ -659,8 +705,15 @@ interface ActiveSession - Kind: `Interface` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/client.d.ts:3` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | members removed: `injectGlobal` | + **Signature** ```ts @@ -671,7 +724,6 @@ interface DappClientOptions | Member | Type | Description | | --- | --- | --- | -| `injectGlobal` | `boolean` | Inject provider into ``window.canton``. Defaults to true. | | `providerType` | `ProviderType` | Provider type hint — affects ``open()`` routing. Defaults to ``'remote'``. | | `target` | `string` | Optional routing key for extension open messages. | @@ -764,8 +816,15 @@ interface DiscoveryErrorEvent - Kind: `Interface` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:27` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + **Signature** ```ts @@ -823,7 +882,14 @@ interface RemoteAdapterConfig extends ProviderAdapterConfig - Kind: `Interface` - Introduced: `1.1.0` -- Source: `dist/adapter/walletconnect-adapter.d.ts:6` +- Changed in: `1.3.0` +- Source: `dist/adapter/walletconnect-adapter.d.ts:52` + +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | members added: `onSignInWithCanton`, `signInWithCanton` | **Signature** @@ -837,8 +903,10 @@ interface WalletConnectAdapterConfig | --- | --- | --- | | `chainId` | `string` | - | | `metadata` | `{ description: string; icons: string[]; name: string; url: string }` | - | +| `onSignInWithCanton` | `(result: SignInWithCantonResult) => void` | - | | `onUri` | `(uri: string) => void` | Called with the pairing URI so the dApp can display or forward it. | | `projectId` | `string` | - | +| `signInWithCanton` | `SIWXMessageParams` | Whether to trigger a canton_signMessage request after the session is established. | @@ -872,7 +940,7 @@ interface WalletInfo - Kind: `Interface` - Introduced: `1.1.0` -- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:144` +- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:150` **Signature** @@ -880,8 +948,6 @@ interface WalletInfo interface WalletPickerEntry ``` -Wallet picker entry and result - **Members** | Member | Type | Description | @@ -900,7 +966,7 @@ Wallet picker entry and result - Kind: `Interface` - Introduced: `1.1.0` -- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:154` +- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:166` **Signature** @@ -988,7 +1054,7 @@ type DiscoveryErrorCode = "WALLET_NOT_FOUND" | "WALLET_NOT_INSTALLED" | "USER_RE - Kind: `Type Alias` - Introduced: `1.1.0` -- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:137` +- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:142` **Signature** @@ -1037,7 +1103,7 @@ Canton logo (PNG) - used as the default icon for Wallet Gateway - Kind: `Variable` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:88` +- Source: `dist/sdk.d.ts:91` **Signature** @@ -1051,7 +1117,7 @@ const dappSDK: DappSDK - Kind: `Variable` - Introduced: `1.1.0` -- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:137` +- Source: `node_modules/@canton-network/core-types/dist/index.d.ts:142` **Signature** @@ -1085,7 +1151,14 @@ Alias for Wallet Gateway - same as Canton logo - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:93` +- Changed in: `1.3.0` +- Source: `dist/sdk.d.ts:96` + +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | **Signature** @@ -1127,7 +1200,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:97` +- Source: `dist/sdk.d.ts:100` **Signature** @@ -1149,7 +1222,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:105` +- Source: `dist/sdk.d.ts:108` **Signature** @@ -1171,7 +1244,7 @@ Returns: `Provider` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:96` +- Source: `dist/sdk.d.ts:99` **Signature** @@ -1197,7 +1270,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:98` +- Source: `dist/sdk.d.ts:101` **Signature** @@ -1219,7 +1292,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:103` +- Source: `dist/sdk.d.ts:106` **Signature** @@ -1245,7 +1318,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:100` +- Source: `dist/sdk.d.ts:103` **Signature** @@ -1267,7 +1340,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:107` +- Source: `dist/sdk.d.ts:110` **Signature** @@ -1293,7 +1366,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:108` +- Source: `dist/sdk.d.ts:111` **Signature** @@ -1319,7 +1392,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:106` +- Source: `dist/sdk.d.ts:109` **Signature** @@ -1345,7 +1418,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:109` +- Source: `dist/sdk.d.ts:112` **Signature** @@ -1371,7 +1444,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:104` +- Source: `dist/sdk.d.ts:107` **Signature** @@ -1393,7 +1466,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:101` +- Source: `dist/sdk.d.ts:104` **Signature** @@ -1419,7 +1492,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:102` +- Source: `dist/sdk.d.ts:105` **Signature** @@ -1445,7 +1518,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:111` +- Source: `dist/sdk.d.ts:115` **Signature** @@ -1471,7 +1544,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:112` +- Source: `dist/sdk.d.ts:116` **Signature** @@ -1497,7 +1570,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:110` +- Source: `dist/sdk.d.ts:114` **Signature** @@ -1523,7 +1596,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:113` +- Source: `dist/sdk.d.ts:117` **Signature** @@ -1549,7 +1622,7 @@ Returns: `Promise` - Kind: `Function` - Introduced: `1.1.0` -- Source: `dist/sdk.d.ts:99` +- Source: `dist/sdk.d.ts:102` **Signature** @@ -1573,124 +1646,236 @@ Returns: `Promise` - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### ConnectResult - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### LedgerApiParams - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### LedgerApiResult - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### ListAccountsResult - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### Network - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### PrepareExecuteAndWaitResult - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### PrepareExecuteParams - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### ProviderId - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/adapter/types.d.ts:2` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### ProviderType - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/adapter/types.d.ts:2` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### Session - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### SignMessageParams - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### SignMessageResult - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### StatusEvent - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### TxChangedEvent - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated | + #### Wallet - Kind: `Reference` - Introduced: `1.1.0` +- Changed in: `1.3.0` - Source: `dist/index.d.ts:10` + +**Version Changes** + +| Version | Changes | +| --- | --- | +| `1.3.0` | details updated |