ExtendedSpliceProvider
Defined in: packages/dapp/src/provider/interface.ts:77
Extended provider interface with additional methods.
Extends
Section titled “Extends”Properties
Section titled “Properties”request
Section titled “request”request:
TypedRequestFn
Defined in: packages/dapp/src/provider/interface.ts:41
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 PrepareExecuteAndWaitResultInherited from
Section titled “Inherited from”Methods
Section titled “Methods”emit()
Section titled “emit()”emit<
T>(event, …args):boolean
Defined in: packages/dapp/src/provider/interface.ts:62
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
Inherited from
Section titled “Inherited from”isConnected()
Section titled “isConnected()”isConnected():
boolean
Defined in: packages/dapp/src/provider/interface.ts:79
Check if provider is connected to the network
Returns
Section titled “Returns”boolean
listenerCount()
Section titled “listenerCount()”listenerCount(
event):number
Defined in: packages/dapp/src/provider/interface.ts:85
Get the number of listeners for an event
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number
on<
T>(event,listener):SpliceProvider
Defined in: packages/dapp/src/provider/interface.ts:53
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”Provider instance for chaining
Example
Section titled “Example”window.canton.on('accountsChanged', (accounts) => console.log(accounts))Inherited from
Section titled “Inherited from”removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
event?):SpliceProvider
Defined in: packages/dapp/src/provider/interface.ts:82
Remove all listeners for an event (or all events)
Parameters
Section titled “Parameters”event?
Section titled “event?”string
Returns
Section titled “Returns”removeListener()
Section titled “removeListener()”removeListener<
T>(event,listener):SpliceProvider
Defined in: packages/dapp/src/provider/interface.ts:71
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”Provider instance for chaining