TypeScript package
dApp SDK
TypeScript client library reference for dApp integrations.
@canton-network/dapp-sdk TypeDoc snapshots.
Table of Contents
Reference
Namespaces
dappAPI
- Kind:
Namespace - Source:
node_modules/@canton-network/core-wallet-dapp-rpc-client/dist/index.d.ts:1
Enumerations
ErrorCode
- Kind:
Enumeration - Source:
dist/error.d.ts:1
Classes
DappClient
- Kind:
Class - Source:
dist/client.d.ts:20
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 - Source:
dist/sdk.d.ts:17
DiscoveryClient
- Kind:
Class - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:31
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 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:2
EventEmitter
- Kind:
Class - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:20
ExtensionAdapter
- Kind:
Class - Source:
dist/adapter/extension-adapter.d.ts:19
NotConnectedError
- Kind:
Class - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:22
RemoteAdapter
- Kind:
Class - Source:
dist/adapter/remote-adapter.d.ts:19
SessionExpiredError
- Kind:
Class - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:16
TimeoutError
- Kind:
Class - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:19
UserRejectedError
- Kind:
Class - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:13
WalletConnectAdapter
- Kind:
Class - 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 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:7
WalletNotInstalledError
- Kind:
Class - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:10
Interfaces
ActiveSession
- Kind:
Interface - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:14
DappClientOptions
- Kind:
Interface - Source:
dist/client.d.ts:3
DiscoveryClientConfig
- Kind:
Interface - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:5
DiscoveryConnectedEvent
- Kind:
Interface - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:2
DiscoveryDisconnectedEvent
- Kind:
Interface - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:5
DiscoveryErrorEvent
- Kind:
Interface - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:8
ProviderAdapter
- Kind:
Interface - Source:
node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:27
RemoteAdapterConfig
- Kind:
Interface - Source:
dist/adapter/remote-adapter.d.ts:6
WalletConnectAdapterConfig
- Kind:
Interface - Source:
dist/adapter/walletconnect-adapter.d.ts:52
WalletInfo
- Kind:
Interface - Source:
node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:5
WalletPickerEntry
- Kind:
Interface - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:158
WalletPickerResult
- Kind:
Interface - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:174
Type Aliases
DiscoveryClientEventHandler
- Kind:
Type Alias - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:19
DiscoveryClientEventMap
- Kind:
Type Alias - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:13
DiscoveryClientEventName
- Kind:
Type Alias - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:18
DiscoveryErrorCode
- Kind:
Type Alias - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:1
ProviderAdapterConfig
- Kind:
Type Alias - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:150
WalletPickerFn
- Kind:
Type Alias - Source:
node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:64
Variables
CANTON_LOGO_PNG
- Kind:
Variable - Source:
dist/assets.d.ts:10
dappSDK
- Kind:
Variable - Source:
dist/sdk.d.ts:91
ProviderAdapterConfig
- Kind:
Variable - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:150
WALLET_GATEWAY_ICON
- Kind:
Variable - Source:
dist/assets.d.ts:14
Functions
connect
- Kind:
Function - Source:
dist/sdk.d.ts:96
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:
Promise<ConnectResult>
disconnect
- Kind:
Function - Source:
dist/sdk.d.ts:100
Promise<null>
getConnectedProvider
- Kind:
Function - Source:
dist/sdk.d.ts:108
Provider<RpcTypes>
init
- Kind:
Function - Source:
dist/sdk.d.ts:99
Promise<void>
isConnected
- Kind:
Function - Source:
dist/sdk.d.ts:101
Promise<ConnectResult>
ledgerApi
- Kind:
Function - Source:
dist/sdk.d.ts:106
Promise<LedgerApiResult>
listAccounts
- Kind:
Function - Source:
dist/sdk.d.ts:103
Promise<ListAccountsResult>
onAccountsChanged
- Kind:
Function - Source:
dist/sdk.d.ts:110
Promise<void>
onConnected
- Kind:
Function - Source:
dist/sdk.d.ts:111
Promise<void>
onStatusChanged
- Kind:
Function - Source:
dist/sdk.d.ts:109
Promise<void>
onTxChanged
- Kind:
Function - Source:
dist/sdk.d.ts:112
Promise<void>
open
- Kind:
Function - Source:
dist/sdk.d.ts:107
Promise<void>
prepareExecute
- Kind:
Function - Source:
dist/sdk.d.ts:104
Promise<null>
prepareExecuteAndWait
- Kind:
Function - Source:
dist/sdk.d.ts:105
Promise<PrepareExecuteAndWaitResult>
removeOnAccountsChanged
- Kind:
Function - Source:
dist/sdk.d.ts:115
Promise<void>
removeOnConnected
- Kind:
Function - Source:
dist/sdk.d.ts:116
Promise<void>
removeOnStatusChanged
- Kind:
Function - Source:
dist/sdk.d.ts:114
Promise<void>
removeOnTxChanged
- Kind:
Function - Source:
dist/sdk.d.ts:117
Promise<void>
status
- Kind:
Function - Source:
dist/sdk.d.ts:102
Promise<StatusEvent>
References
AccountsChangedEvent
- Kind:
Reference - Source:
dist/index.d.ts:10
ConnectResult
- Kind:
Reference - Source:
dist/index.d.ts:10
LedgerApiParams
- Kind:
Reference - Source:
dist/index.d.ts:10
LedgerApiResult
- Kind:
Reference - Source:
dist/index.d.ts:10
ListAccountsResult
- Kind:
Reference - Source:
dist/index.d.ts:10
Network
- Kind:
Reference - Source:
dist/index.d.ts:10
PrepareExecuteAndWaitResult
- Kind:
Reference - Source:
dist/index.d.ts:10
PrepareExecuteParams
- Kind:
Reference - Source:
dist/index.d.ts:10
ProviderId
- Kind:
Reference - Source:
dist/adapter/types.d.ts:2
ProviderType
- Kind:
Reference - Source:
dist/adapter/types.d.ts:2
Session
- Kind:
Reference - Source:
dist/index.d.ts:10
SignMessageParams
- Kind:
Reference - Source:
dist/index.d.ts:10
SignMessageResult
- Kind:
Reference - Source:
dist/index.d.ts:10
StatusEvent
- Kind:
Reference - Source:
dist/index.d.ts:10
TxChangedEvent
- Kind:
Reference - Source:
dist/index.d.ts:10
Wallet
- Kind:
Reference - Source:
dist/index.d.ts:10
History
1.2.0dappAPI: members added: Command, Commands, CreateAndExerciseCommand, CreateAndExerciseCommandPayload, CreateCommand, CreateCommandPayload, ExerciseByKeyCommand, ExerciseByKeyCommandPayload, ExerciseCommand, ExerciseCommandPayload; members removed: JsCommands
DappClient: summary updated; members added: onMessageSignature, removeOnMessageSignature, signMessage
DappSDK: members added: onMessageSignature, removeOnMessageSignature, signMessage
DiscoveryClient: details updated
DappClientOptions: members removed: injectGlobal
ProviderAdapter: details updated
WalletConnectAdapterConfig: members added: onSignInWithCanton, signInWithCanton
WalletPickerEntry: summary updated
connect: details updated
AccountsChangedEvent: details updated
ConnectResult: details updated
LedgerApiParams: details updated
LedgerApiResult: details updated
ListAccountsResult: details updated
Network: details updated
PrepareExecuteAndWaitResult: details updated
PrepareExecuteParams: details updated
ProviderId: details updated
ProviderType: details updated
Session: details updated
SignMessageParams: details updated
SignMessageResult: details updated
StatusEvent: details updated
TxChangedEvent: details updated
Wallet: details updated
1.1.073 exported symbols added.