SpliceProvider

Defined in: packages/dapp/src/provider/interface.ts:18

SpliceProvider interface for dApp ↔ Wallet communication.

Exposed to dApps as window.canton. Follows the EIP-1193 style pattern with request/on/emit/removeListener methods.

Extended by

• ExtendedSpliceProvider

Properties

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.

Param

Typed request payload with method and params

Returns

Promise resolving to the typed method result

Throws

RPC error if request fails

Example

// Methods without params
const status = await window.canton.request({ method: 'status' })
// status is StatusEvent

// Methods with params
const result = await window.canton.request({
  method: 'prepareExecuteAndWait',
  params: { commands: {...}, commandId: 'cmd-1' }
})
// result is PrepareExecuteAndWaitResult

Methods

emit()

emit<T>(event, …args): boolean

Defined in: packages/dapp/src/provider/interface.ts:62

Emit an event to all registered listeners.

Type Parameters

T

T = unknown

Parameters

event

string

Event name

args

…T[]

Arguments to pass to listeners

Returns

boolean

true if event had listeners, false otherwise

---

on()

on<T>(event, listener): SpliceProvider

Defined in: packages/dapp/src/provider/interface.ts:53

Subscribe to wallet events.

Type Parameters

T

T = unknown

Parameters

event

string

Event name (e.g., ‘accountsChanged’, ‘txChanged’)

listener

EventListener<T>

Callback function

Returns

SpliceProvider

Provider instance for chaining

Example

window.canton.on('accountsChanged', (accounts) => console.log(accounts))

---

removeListener()

removeListener<T>(event, listener): SpliceProvider

Defined in: packages/dapp/src/provider/interface.ts:71

Unsubscribe from wallet events.

Type Parameters

T

T = unknown

Parameters

event

string

Event name

listener

EventListener<T>

Callback function to remove

Returns

SpliceProvider

Provider instance for chaining