SpliceProvider
Defined in: packages/dapp/src/provider/interface.ts:23
SpliceProvider interface for CIP-103 dApp ↔ Wallet communication.
Exposed to dApps as window.canton. CIP-103 specifies the request/on/emit/removeListener
object shape (the EIP-1193 pattern) and the method/event surface; this interface implements
that contract. See CIP-103.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”request
Section titled “request”request:
TypedRequestFn
Defined in: packages/dapp/src/provider/interface.ts:46
Send a JSON-RPC request to the wallet.
Strictly typed to canonical OpenRPC methods. Use the method name as a literal type to get correct params/result types.
Typed request payload with method and params
Returns
Section titled “Returns”Promise resolving to the typed method result
Throws
Section titled “Throws”RPC error if request fails
Example
Section titled “Example”// Methods without paramsconst status = await window.canton.request({ method: 'status' })// status is StatusEvent
// Methods with paramsconst result = await window.canton.request({ method: 'prepareExecuteAndWait', params: { commands: {...}, commandId: 'cmd-1' }})// result is PrepareExecuteAndWaitResultMethods
Section titled “Methods”emit()
Section titled “emit()”emit<
T>(event, …args):boolean
Defined in: packages/dapp/src/provider/interface.ts:67
Emit an event to all registered listeners.
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”string
Event name
…T[]
Arguments to pass to listeners
Returns
Section titled “Returns”boolean
true if event had listeners, false otherwise
on<
T>(event,listener):SpliceProvider
Defined in: packages/dapp/src/provider/interface.ts:58
Subscribe to wallet events.
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”string
Event name (e.g., ‘accountsChanged’, ‘txChanged’)
listener
Section titled “listener”Callback function
Returns
Section titled “Returns”SpliceProvider
Provider instance for chaining
Example
Section titled “Example”window.canton.on('accountsChanged', (accounts) => console.log(accounts))removeListener()
Section titled “removeListener()”removeListener<
T>(event,listener):SpliceProvider
Defined in: packages/dapp/src/provider/interface.ts:76
Unsubscribe from wallet events.
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”string
Event name
listener
Section titled “listener”Callback function to remove
Returns
Section titled “Returns”SpliceProvider
Provider instance for chaining