@canton-network/dapp-sdk TypeDoc snapshots.
Table of Contents
Version Change Summary
Reference
Namespaces
dappAPI
- 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
Members
Enumerations
ErrorCode
- Kind:
Enumeration - Introduced:
1.1.0 - Source:
dist/error.d.ts:1
Classes
DappClient
- Kind:
Class - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/client.d.ts:20
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.
Members
DappSDK
- Kind:
Class - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/sdk.d.ts:17
Members
DiscoveryClient
- Kind:
Class - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:31
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(...).
Members
DiscoveryError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:2
EventEmitter
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:20
ExtensionAdapter
- Kind:
Class - Introduced:
1.1.0 - Source:
dist/adapter/extension-adapter.d.ts:19
NotConnectedError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:22
RemoteAdapter
- Kind:
Class - Introduced:
1.1.0 - Source:
dist/adapter/remote-adapter.d.ts:19
SessionExpiredError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:16
TimeoutError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:19
UserRejectedError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:13
WalletConnectAdapter
- Kind:
Class - Introduced:
1.1.0 - Source:
dist/adapter/walletconnect-adapter.d.ts:74
canton_ prefixed methods.
Events arriving via session_event are buffered until a listener attaches.
Members
WalletNotFoundError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:7
WalletNotInstalledError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:10
InjectedAdapter
- Kind:
Class - Introduced:
1.1.0 - Removed in:
1.3.0 - Shown for historical reference.
- Source:
dist/adapter/injected-adapter.d.ts:12
Interfaces
ActiveSession
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:14
DappClientOptions
- Kind:
Interface - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/client.d.ts:3
Signature
DiscoveryClientConfig
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:5
DiscoveryConnectedEvent
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:2
DiscoveryDisconnectedEvent
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:5
DiscoveryErrorEvent
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:8
ProviderAdapter
- Kind:
Interface - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:27
Signature
RemoteAdapterConfig
- Kind:
Interface - Introduced:
1.1.0 - Source:
dist/adapter/remote-adapter.d.ts:6
WalletConnectAdapterConfig
- Kind:
Interface - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/adapter/walletconnect-adapter.d.ts:52
Signature
WalletInfo
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:5
WalletPickerEntry
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:150
WalletPickerResult
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:166
Type Aliases
DiscoveryClientEventHandler
- Kind:
Type Alias - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:19
DiscoveryClientEventMap
- Kind:
Type Alias - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:13
DiscoveryClientEventName
- Kind:
Type Alias - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:18
DiscoveryErrorCode
- Kind:
Type Alias - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:1
ProviderAdapterConfig
- Kind:
Type Alias - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:142
WalletPickerFn
- Kind:
Type Alias - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:64
Variables
CANTON_LOGO_PNG
- Kind:
Variable - Introduced:
1.1.0 - Source:
dist/assets.d.ts:10
dappSDK
- Kind:
Variable - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:91
ProviderAdapterConfig
- Kind:
Variable - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:142
WALLET_GATEWAY_ICON
- Kind:
Variable - Introduced:
1.1.0 - Source:
dist/assets.d.ts:14
Functions
connect
- Kind:
Function - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/sdk.d.ts:96
Signature
options here is a legacy convenience that forwards to DappSDK.init.
Call Signatures
Overload 1:
options here is a legacy convenience that forwards to DappSDK.init.
Returns: Promise<ConnectResult>
Overload 2:
Returns:
Promise<ConnectResult>
disconnect
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:100
Promise<null>
getConnectedProvider
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:108
Provider<RpcTypes>
init
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:99
Returns:
Promise<void>
isConnected
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:101
Promise<ConnectResult>
ledgerApi
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:106
Returns:
Promise<LedgerApiResult>
listAccounts
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:103
Promise<ListAccountsResult>
onAccountsChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:110
Returns:
Promise<void>
onConnected
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:111
Returns:
Promise<void>
onStatusChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:109
Returns:
Promise<void>
onTxChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:112
Returns:
Promise<void>
open
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:107
Promise<void>
prepareExecute
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:104
Returns:
Promise<null>
prepareExecuteAndWait
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:105
Returns:
Promise<PrepareExecuteAndWaitResult>
removeOnAccountsChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:115
Returns:
Promise<void>
removeOnConnected
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:116
Returns:
Promise<void>
removeOnStatusChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:114
Returns:
Promise<void>
removeOnTxChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:117
Returns:
Promise<void>
status
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:102
Promise<StatusEvent>
References
AccountsChangedEvent
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
ConnectResult
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
LedgerApiParams
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
LedgerApiResult
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
ListAccountsResult
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
Network
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
PrepareExecuteAndWaitResult
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
PrepareExecuteParams
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
ProviderId
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/adapter/types.d.ts:2
ProviderType
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/adapter/types.d.ts:2
Session
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
SignMessageParams
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
SignMessageResult
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
StatusEvent
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
TxChangedEvent
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10
Wallet
- Kind:
Reference - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/index.d.ts:10