@canton-network/dapp-sdk TypeDoc snapshots.
Table of Contents
| Name | Kind | Summary | Introduced | Changed | Deprecated | Removed |
|---|---|---|---|---|---|---|
dappAPI | Namespace | - | 1.1.0 | 1.3.0: details updated | - | - |
ErrorCode | Enumeration | - | 1.1.0 | - | - | - |
DappClient | Class | DappClient is a thin convenience wrapper around a connectedProvider<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 anyProvider<DappRpcTypes> directly — then pass it here. | 1.1.0 | 1.3.0: summary updated; members added: onMessageSignature, removeOnMessageSignature, signMessage | - | - |
DappSDK | Class | - | 1.1.0 | 1.3.0: members added: onMessageSignature, removeOnMessageSignature, signMessage | - | - |
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-levelCIP-103 events (statusChanged, accountsChanged, txChanged) live on the Provider — subscribe via client.getProvider().on(...). | 1.1.0 | 1.3.0: details updated | - | - |
DiscoveryError | Class | - | 1.1.0 | - | - | - |
EventEmitter | Class | - | 1.1.0 | - | - | - |
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 | - | - | - |
NotConnectedError | Class | - | 1.1.0 | - | - | - |
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 | - | 1.1.0 | - | - | - |
TimeoutError | Class | - | 1.1.0 | - | - | - |
UserRejectedError | Class | - | 1.1.0 | - | - | - |
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 | - | 1.1.0 | - | - | - |
WalletNotInstalledError | Class | - | 1.1.0 | - | - | - |
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 | - | 1.1.0 | - | - | - |
DappClientOptions | Interface | - | 1.1.0 | 1.3.0: members removed: injectGlobal | - | - |
DiscoveryClientConfig | Interface | - | 1.1.0 | - | - | - |
DiscoveryConnectedEvent | Interface | - | 1.1.0 | - | - | - |
DiscoveryDisconnectedEvent | Interface | - | 1.1.0 | - | - | - |
DiscoveryErrorEvent | Interface | - | 1.1.0 | - | - | - |
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 | - | 1.1.0 | - | - | - |
WalletConnectAdapterConfig | Interface | - | 1.1.0 | 1.3.0: members added: onSignInWithCanton, signInWithCanton | - | - |
WalletInfo | Interface | - | 1.1.0 | - | - | - |
WalletPickerEntry | Interface | - | 1.1.0 | - | - | - |
WalletPickerResult | Interface | - | 1.1.0 | - | - | - |
DiscoveryClientEventHandler | Type Alias | - | 1.1.0 | - | - | - |
DiscoveryClientEventMap | Type Alias | - | 1.1.0 | - | - | - |
DiscoveryClientEventName | Type Alias | - | 1.1.0 | - | - | - |
DiscoveryErrorCode | Type Alias | - | 1.1.0 | - | - | - |
ProviderAdapterConfig | Type Alias | - | 1.1.0 | - | - | - |
WalletPickerFn | Type Alias | A function that presents wallet choices to the user and returns their selection. This abstraction allows the DiscoveryClient to remain UI-framework agnostic. | 1.1.0 | - | - | - |
CANTON_LOGO_PNG | Variable | Canton logo (PNG) - used as the default icon for Wallet Gateway | 1.1.0 | - | - | - |
dappSDK | Variable | - | 1.1.0 | - | - | - |
ProviderAdapterConfig | Variable | Provider adapter configuration | 1.1.0 | - | - | - |
WALLET_GATEWAY_ICON | Variable | Alias for Wallet Gateway - same as Canton logo | 1.1.0 | - | - | - |
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 | - | 1.1.0 | - | - | - |
getConnectedProvider | Function | - | 1.1.0 | - | - | - |
init | Function | - | 1.1.0 | - | - | - |
isConnected | Function | - | 1.1.0 | - | - | - |
ledgerApi | Function | - | 1.1.0 | - | - | - |
listAccounts | Function | - | 1.1.0 | - | - | - |
onAccountsChanged | Function | - | 1.1.0 | - | - | - |
onConnected | Function | - | 1.1.0 | - | - | - |
onStatusChanged | Function | - | 1.1.0 | - | - | - |
onTxChanged | Function | - | 1.1.0 | - | - | - |
open | Function | - | 1.1.0 | - | - | - |
prepareExecute | Function | - | 1.1.0 | - | - | - |
prepareExecuteAndWait | Function | - | 1.1.0 | - | - | - |
removeOnAccountsChanged | Function | - | 1.1.0 | - | - | - |
removeOnConnected | Function | - | 1.1.0 | - | - | - |
removeOnStatusChanged | Function | - | 1.1.0 | - | - | - |
removeOnTxChanged | Function | - | 1.1.0 | - | - | - |
status | Function | - | 1.1.0 | - | - | - |
AccountsChangedEvent | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
ConnectResult | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
LedgerApiParams | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
LedgerApiResult | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
ListAccountsResult | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
Network | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
PrepareExecuteAndWaitResult | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
PrepareExecuteParams | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
ProviderId | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
ProviderType | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
Session | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
SignMessageParams | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
SignMessageResult | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
StatusEvent | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
TxChangedEvent | Reference | - | 1.1.0 | 1.3.0: details updated | - | - |
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
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
| Version | Changes |
|---|---|
1.3.0 | details updated |
| Member | Type | Description |
|---|---|---|
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 |
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. |
MessageSignaturePendingEvent | void | Event emitted when a message signature is requested. |
MessageSignatureSignedEvent | void | Event emitted when a message signature is completed. |
Network | void | Network information, if connected to a network. |
Path | void | Path parameters as key-value pairs. |
PrepareExecuteAndWaitResult | void | - |
PrepareExecuteParams | void | Structure representing the request for prepare and execute calls |
Provider | void | Represents a Provider. |
Query | void | Query parameters as key-value pairs. |
Session | void | Session information, if authenticated. |
SignMessageParams | void | Request to sign a message. |
SignMessageResult | void | Result of signing a message. |
StatusEvent | void | - |
TxChangedExecutedEvent | void | Event emitted when a transaction is executed against the participant. |
TxChangedExecutedPayload | void | Payload for the TxChangedExecutedEvent. |
TxChangedFailedEvent | void | Event emitted when a transaction has failed. |
TxChangedPendingEvent | void | Event emitted when a transaction is pending. |
TxChangedSignedEvent | void | Event emitted when a transaction has been signed. |
TxChangedSignedPayload | void | Payload for the TxChangedSignedEvent. |
Wallet | void | Structure representing a wallet |
AccessToken | string | JWT authentication token. |
AccountsChanged | () => Promise<AccountsChangedEvent> | - |
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<ConnectResult> | - |
ContractId | string | The unique identifier of the disclosed contract. |
CreatedEventBlob | string | The blob data of the created event for the disclosed contract. |
Disabled | boolean | Whether the wallet is disabled. Wallets are disabled when no signing provider matches the party’s namespace during sync. Disabled wallets use participant as the default signing provider. |
DisclosedContracts | DisclosedContract[] | List of contract IDs to be disclosed with the command. |
Disconnect | () => Promise<Null> | - |
ExternalTxId | string | Unique identifier of the signed transaction given by the Signing Provider. This may not be the same as the internal txId given by the Wallet Gateway. |
GetActiveNetwork | () => Promise<Network> | - |
GetPrimaryAccount | () => Promise<Wallet> | - |
Hint | string | The party hint and name of the wallet. |
IsConnected | () => Promise<ConnectResult> | - |
IsConnectedValue | boolean | Whether or not the user is authenticated with the Wallet. |
IsNetworkConnected | boolean | Whether or not a connection to a network is established. |
LedgerApi | (params: LedgerApiParams) => Promise<LedgerApiResult> | - |
LedgerApiUrl | string | The base URL of the ledger API. |
ListAccounts | () => Promise<ListAccountsResult> | - |
ListAccountsResult | Wallet[] | An array of accounts that the user has authorized the dapp to access.. |
Message | string | The message to sign. |
MessageId | string | The unique identifier of the message associated with the message to be signed. |
MessageSignature | () => Promise<MessageSignatureEvent> | - |
MessageSignatureEvent | MessageSignaturePendingEvent | MessageSignatureSignedEvent | MessageSignatureFailedEvent | Event emitted when a message signature is requested or completed. |
Namespace | string | The namespace of the party. |
NetworkId | string | The network ID the wallet corresponds to. |
NetworkReason | string | If not connected to a network, the reason why. |
Null | null | Represents a null value, used in responses where no data is returned. |
PackageId | string | - |
PackageIdSelectionPreference | PackageId[] | The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation |
Party | string | The party that signed the transaction. |
PartyId | string | The party ID corresponding to the wallet. |
PrepareExecute | (params: PrepareExecuteParams) => Promise<Null> | - |
PrepareExecuteAndWait | (params: PrepareExecuteParams) => Promise<PrepareExecuteAndWaitResult> | - |
Primary | boolean | Set as primary wallet for dApp usage. |
ProviderId | string | The unique identifier of the Provider. |
ProviderType | "browser" | "desktop" | "mobile" | "remote" | The type of client that implements the Provider. |
PublicKey | string | The public key of the party. |
ReadAs | Party[] | Set of parties that should be granted read access to the command, if submitted. If not set, no additional read parties are granted. |
Reason | string | Reason for the wallet state, e.g., ‘no signing provider matched’. |
RequestMethod | "get" | "post" | "patch" | "put" | "delete" | - |
Resource | string | - |
RpcTypes | { accountsChanged: { params: Params<AccountsChanged>; result: Result<AccountsChanged> }; connect: { params: Params<Connect>; result: Result<Connect> }; disconnect: { params: Params<Disconnect>; result: Result<Disconnect> }; getActiveNetwork: { params: Params<GetActiveNetwork>; result: Result<GetActiveNetwork> }; getPrimaryAccount: { params: Params<GetPrimaryAccount>; result: Result<GetPrimaryAccount> }; isConnected: { params: Params<IsConnected>; result: Result<IsConnected> }; ledgerApi: { params: Params<LedgerApi>; result: Result<LedgerApi> }; listAccounts: { params: Params<ListAccounts>; result: Result<ListAccounts> }; messageSignature: { params: Params<MessageSignature>; result: Result<MessageSignature> }; prepareExecute: { params: Params<PrepareExecute>; result: Result<PrepareExecute> }; prepareExecuteAndWait: { params: Params<PrepareExecuteAndWait>; result: Result<PrepareExecuteAndWait> }; signMessage: { params: Params<SignMessage>; result: Result<SignMessage> }; status: { params: Params<Status>; result: Result<Status> }; txChanged: { params: Params<TxChanged>; result: Result<TxChanged> } } | - |
Signature | string | The signature of the message. |
SignedBy | string | The identifier of the provider that signed the transaction. |
SigningProviderId | string | The signing provider ID the wallet corresponds to. |
SignMessage | (params: SignMessageParams) => Promise<SignMessageResult> | - |
Status | () => Promise<StatusEvent> | Generated! Represents an alias to any of the provided schemas |
StatusExecuted | "executed" | The status of the transaction. |
StatusFailed | "failed" | The status of the message signature. |
StatusPending | "pending" | The status of the message signature. |
StatusSigned | "signed" | The status of the message signature. |
SynchronizerId | string | If not set, a suitable synchronizer that this node is connected to will be chosen. |
TemplateId | string | The template identifier of the disclosed contract. |
TopologyTransactions | string | The topology transactions |
TxChanged | () => Promise<TxChangedEvent> | - |
TxChangedEvent | TxChangedPendingEvent | TxChangedSignedEvent | TxChangedExecutedEvent | TxChangedFailedEvent | Event emitted when a transaction changes. |
UpdateId | string | The update ID corresponding to the transaction. |
Url | string | The URL of the Wallet Provider. |
UserId | string | The user identifier. |
UserUrl | string | A URL that points to a user interface. |
Version | string | The version of the Provider. |
WalletStatus | "initialized" | "allocated" | "removed" | The status of the wallet. |
default | void | - |
Enumerations
ErrorCode
- Kind:
Enumeration - Introduced:
1.1.0 - Source:
dist/error.d.ts:1
| Member | Type | Description |
|---|---|---|
Other | 4 | - |
ProviderNotFound | 0 | - |
Timeout | 2 | - |
TransactionFailed | 3 | - |
UserCancelled | 1 | - |
Classes
DappClient
- Kind:
Class - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/client.d.ts:20
| Version | Changes |
|---|---|
1.3.0 | summary updated; members added: onMessageSignature, removeOnMessageSignature, signMessage |
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
| Member | Type | Description |
|---|---|---|
constructor | void | - |
connect | void | - |
disconnect | void | - |
getProvider | void | - |
isConnected | void | - |
ledgerApi | void | - |
listAccounts | void | - |
onAccountsChanged | void | - |
onConnected | void | - |
onMessageSignature | void | - |
onStatusChanged | void | - |
onTxChanged | void | - |
open | void | - |
prepareExecute | void | - |
prepareExecuteAndWait | void | - |
removeOnAccountsChanged | void | - |
removeOnConnected | void | - |
removeOnMessageSignature | void | - |
removeOnStatusChanged | void | - |
removeOnTxChanged | void | - |
signMessage | void | - |
status | void | - |
DappSDK
- Kind:
Class - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/sdk.d.ts:17
| Version | Changes |
|---|---|
1.3.0 | members added: onMessageSignature, removeOnMessageSignature, signMessage |
| Member | Type | Description |
|---|---|---|
constructor | void | - |
connect | void | - |
disconnect | void | - |
getConnectedProvider | void | - |
init | void | - |
isConnected | void | - |
ledgerApi | void | - |
listAccounts | void | - |
onAccountsChanged | void | - |
onConnected | void | - |
onMessageSignature | void | - |
onStatusChanged | void | - |
onTxChanged | void | - |
open | void | - |
prepareExecute | void | - |
prepareExecuteAndWait | void | - |
removeOnAccountsChanged | void | - |
removeOnConnected | void | - |
removeOnMessageSignature | void | - |
removeOnStatusChanged | void | - |
removeOnTxChanged | void | - |
signMessage | void | - |
status | void | - |
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
| Version | Changes |
|---|---|
1.3.0 | details updated |
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
| Member | Type | Description |
|---|---|---|
connect | void | - |
destroy | void | - |
disconnect | void | - |
getActiveSession | void | - |
getProvider | void | - |
listAdapters | void | - |
listWallets | void | - |
on | void | - |
registerAdapter | void | - |
removeListener | void | - |
restorePersistedSessionIfNeeded | void | - |
create | void | - |
DiscoveryError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:2
| Member | Type | Description |
|---|---|---|
constructor | void | - |
cause | unknown | - |
code | DiscoveryErrorCode | - |
message | string | - |
name | string | - |
stack | string | - |
stackTraceLimit | number | The Error.stackTraceLimit property specifies the number of stack framescollected by a stack trace (whether generated by new Error().stack orError.captureStackTrace(obj)).The default value is 10 but may be set to any valid JavaScript number. Changeswill affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
captureStackTrace | void | - |
prepareStackTrace | void | - |
EventEmitter
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:20
| Member | Type | Description |
|---|---|---|
constructor | void | - |
emit | void | - |
on | void | - |
removeAllListeners | void | - |
removeListener | void | - |
ExtensionAdapter
- Kind:
Class - Introduced:
1.1.0 - Source:
dist/adapter/extension-adapter.d.ts:19
| Member | Type | Description |
|---|---|---|
constructor | void | - |
icon | string | - |
name | string | - |
providerId | string | - |
target | string | - |
type | ProviderType | - |
detect | void | - |
getInfo | void | - |
provider | void | - |
restore | void | - |
teardown | void | - |
NotConnectedError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:22
| Member | Type | Description |
|---|---|---|
constructor | void | - |
cause | unknown | - |
code | DiscoveryErrorCode | - |
message | string | - |
name | string | - |
stack | string | - |
stackTraceLimit | number | The Error.stackTraceLimit property specifies the number of stack framescollected by a stack trace (whether generated by new Error().stack orError.captureStackTrace(obj)).The default value is 10 but may be set to any valid JavaScript number. Changeswill affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
captureStackTrace | void | - |
prepareStackTrace | void | - |
RemoteAdapter
- Kind:
Class - Introduced:
1.1.0 - Source:
dist/adapter/remote-adapter.d.ts:19
| Member | Type | Description |
|---|---|---|
constructor | void | - |
icon | string | - |
name | string | - |
providerId | string | - |
rpcUrl | string | - |
type | ProviderType | - |
detect | void | - |
getInfo | void | - |
provider | void | - |
restore | void | - |
teardown | void | - |
SessionExpiredError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:16
| Member | Type | Description |
|---|---|---|
constructor | void | - |
cause | unknown | - |
code | DiscoveryErrorCode | - |
message | string | - |
name | string | - |
stack | string | - |
stackTraceLimit | number | The Error.stackTraceLimit property specifies the number of stack framescollected by a stack trace (whether generated by new Error().stack orError.captureStackTrace(obj)).The default value is 10 but may be set to any valid JavaScript number. Changeswill affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
captureStackTrace | void | - |
prepareStackTrace | void | - |
TimeoutError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:19
| Member | Type | Description |
|---|---|---|
constructor | void | - |
cause | unknown | - |
code | DiscoveryErrorCode | - |
message | string | - |
name | string | - |
stack | string | - |
stackTraceLimit | number | The Error.stackTraceLimit property specifies the number of stack framescollected by a stack trace (whether generated by new Error().stack orError.captureStackTrace(obj)).The default value is 10 but may be set to any valid JavaScript number. Changeswill affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
captureStackTrace | void | - |
prepareStackTrace | void | - |
UserRejectedError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:13
| Member | Type | Description |
|---|---|---|
constructor | void | - |
cause | unknown | - |
code | DiscoveryErrorCode | - |
message | string | - |
name | string | - |
stack | string | - |
stackTraceLimit | number | The Error.stackTraceLimit property specifies the number of stack framescollected by a stack trace (whether generated by new Error().stack orError.captureStackTrace(obj)).The default value is 10 but may be set to any valid JavaScript number. Changeswill affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
captureStackTrace | void | - |
prepareStackTrace | void | - |
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
| Member | Type | Description |
|---|---|---|
constructor | void | - |
icon | string | - |
name | "WalletConnect" | - |
providerId | string | - |
type | ProviderType | - |
detect | void | - |
emit | void | - |
getInfo | void | - |
on | void | - |
provider | void | - |
removeListener | void | - |
request | void | - |
restore | void | - |
teardown | void | - |
create | void | - |
WalletNotFoundError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:7
| Member | Type | Description |
|---|---|---|
constructor | void | - |
cause | unknown | - |
code | DiscoveryErrorCode | - |
message | string | - |
name | string | - |
stack | string | - |
stackTraceLimit | number | The Error.stackTraceLimit property specifies the number of stack framescollected by a stack trace (whether generated by new Error().stack orError.captureStackTrace(obj)).The default value is 10 but may be set to any valid JavaScript number. Changeswill affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
captureStackTrace | void | - |
prepareStackTrace | void | - |
WalletNotInstalledError
- Kind:
Class - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/errors.d.ts:10
| Member | Type | Description |
|---|---|---|
constructor | void | - |
cause | unknown | - |
code | DiscoveryErrorCode | - |
message | string | - |
name | string | - |
stack | string | - |
stackTraceLimit | number | The Error.stackTraceLimit property specifies the number of stack framescollected by a stack trace (whether generated by new Error().stack orError.captureStackTrace(obj)).The default value is 10 but may be set to any valid JavaScript number. Changeswill affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
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
| Member | Type | Description |
|---|---|---|
constructor | void | - |
icon | string | - |
name | string | - |
providerId | string | - |
type | ProviderType | - |
detect | void | - |
getInfo | void | - |
provider | void | - |
restore | void | - |
teardown | void | - |
Interfaces
ActiveSession
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:14
| Member | Type | Description |
|---|---|---|
adapter | ProviderAdapter | - |
provider | Provider<RpcTypes> | - |
providerId | string | - |
DappClientOptions
- Kind:
Interface - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/client.d.ts:3
| Version | Changes |
|---|---|
1.3.0 | members removed: injectGlobal |
| Member | Type | Description |
|---|---|---|
providerType | ProviderType | Provider type hint — affects open() routing. Defaults to 'remote'. |
target | string | Optional routing key for extension open messages. |
DiscoveryClientConfig
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/client.d.ts:5
| Member | Type | Description |
|---|---|---|
adapters | ProviderAdapter[] | Adapters to register on init. |
walletPicker | WalletPickerFn | A function that presents wallet choices to the user and returns their selection. When not provided, connect() requires a providerId argument. |
DiscoveryConnectedEvent
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:2
| Member | Type | Description |
|---|---|---|
providerId | string | - |
DiscoveryDisconnectedEvent
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:5
| Member | Type | Description |
|---|---|---|
providerId | string | - |
DiscoveryErrorEvent
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:8
| Member | Type | Description |
|---|---|---|
cause | unknown | - |
code | string | - |
message | string | - |
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
| Version | Changes |
|---|---|
1.3.0 | details updated |
| Member | Type | Description |
|---|---|---|
icon | string | - |
name | string | - |
providerId | string | - |
type | ProviderType | - |
detect | void | - |
getInfo | void | - |
provider | void | - |
restore | void | - |
teardown | void | - |
RemoteAdapterConfig
- Kind:
Interface - Introduced:
1.1.0 - Source:
dist/adapter/remote-adapter.d.ts:6
| Member | Type | Description |
|---|---|---|
description | string | - |
icon | string | - |
name | string | - |
providerId | string | - |
rpcUrl | string | - |
WalletConnectAdapterConfig
- Kind:
Interface - Introduced:
1.1.0 - Changed in:
1.3.0 - Source:
dist/adapter/walletconnect-adapter.d.ts:52
| Version | Changes |
|---|---|
1.3.0 | members added: onSignInWithCanton, signInWithCanton |
| Member | Type | Description |
|---|---|---|
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. |
WalletInfo
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/types.d.ts:5
| Member | Type | Description |
|---|---|---|
description | string | - |
icon | string | - |
name | string | - |
providerId | string | - |
reuseGlobalWalletPopup | boolean | If set, wallet picker keeps the global popup open after pick for reuse by async navigations (e.g. HTTP wallet gateway). Not used for sync DApp API wallets even when type is remote. |
type | ProviderType | - |
url | string | - |
WalletPickerEntry
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:150
| Member | Type | Description |
|---|---|---|
description | string | - |
icon | string | - |
name | string | - |
providerId | string | - |
reuseGlobalWalletPopup | boolean | Keep the global wallet popup open after pick for async HTTP-gateway navigation. |
type | string | - |
url | string | - |
WalletPickerResult
- Kind:
Interface - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-types/dist/index.d.ts:166
| Member | Type | Description |
|---|---|---|
name | string | - |
providerId | string | - |
reuseGlobalWalletPopup | boolean | - |
type | string | - |
url | string | - |
Type Aliases
DiscoveryClientEventHandler
- Kind:
Type Alias - Introduced:
1.1.0 - Source:
node_modules/@canton-network/core-wallet-discovery/dist/events.d.ts:19
| Name | Constraint | Default | Description |
|---|---|---|---|
K | DiscoveryClientEventName | - | - |
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
| Version | Changes |
|---|---|
1.3.0 | details updated |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
options | DappSDKConnectOptions | yes | - |
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
| Parameter | Type | Required | Description |
|---|---|---|---|
options | DappSDKConnectOptions | no | - |
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
| Parameter | Type | Required | Description |
|---|---|---|---|
params | LedgerApiParams | yes | - |
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
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<AccountsChangedEvent> | yes | - |
Promise<void>
onConnected
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:111
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<StatusEvent> | yes | - |
Promise<void>
onStatusChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:109
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<StatusEvent> | yes | - |
Promise<void>
onTxChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:112
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<TxChangedEvent> | yes | - |
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
| Parameter | Type | Required | Description |
|---|---|---|---|
params | PrepareExecuteParams | yes | - |
Promise<null>
prepareExecuteAndWait
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:105
| Parameter | Type | Required | Description |
|---|---|---|---|
params | PrepareExecuteParams | yes | - |
Promise<PrepareExecuteAndWaitResult>
removeOnAccountsChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:115
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<AccountsChangedEvent> | yes | - |
Promise<void>
removeOnConnected
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:116
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<StatusEvent> | yes | - |
Promise<void>
removeOnStatusChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:114
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<StatusEvent> | yes | - |
Promise<void>
removeOnTxChanged
- Kind:
Function - Introduced:
1.1.0 - Source:
dist/sdk.d.ts:117
| Parameter | Type | Required | Description |
|---|---|---|---|
listener | EventListener<TxChangedEvent> | yes | - |
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
| 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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
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 |
|---|---|
1.3.0 | details updated |