Skip to main content
Version: 1.17.1

Class: CantonJsonRpcProvider

Defined in: canton/provider.ts:68

Node-side Canton provider.

Unlike the in-browser dApp provider, which proxies ledgerApi requests through the validator wallet, this provider talks to the Canton JSON Ledger API directly: ledgerApi requests are already in wire format, so the translation layer is a thin HTTP pass-through with JWT authentication.

Implements​

  • CantonRpcProvider

Methods​

emit()​

emit<E>(event: string, ...args: E[]): boolean

Defined in: canton/provider.ts:183

Type Parameters​

Type Parameter
E

Parameters​

ParameterType
eventstring
...argsE[]

Returns​

boolean

Implementation of​

CantonRpcProvider.emit


getParty()​

getParty(): PartyId

Defined in: canton/provider.ts:199

Returns​

PartyId


on()​

on<E>(event: string, listener: EventListener<E>): Provider<RpcTypes>

Defined in: canton/provider.ts:176

Type Parameters​

Type Parameter
E

Parameters​

ParameterType
eventstring
listenerEventListener<E>

Returns​

Provider<RpcTypes>

Implementation of​

CantonRpcProvider.on


removeListener()​

removeListener<E>(event: string, listenerToRemove: EventListener<E>): Provider<RpcTypes>

Defined in: canton/provider.ts:190

Type Parameters​

Type Parameter
E

Parameters​

ParameterType
eventstring
listenerToRemoveEventListener<E>

Returns​

Provider<RpcTypes>

Implementation of​

CantonRpcProvider.removeListener


request()​

request<M extends keyof RpcTypes>(args: RequestArgs<RpcTypes, M>): Promise<RpcTypes[M]["result"]>

Defined in: canton/provider.ts:135

Type Parameters​

Type Parameter
M extends keyof RpcTypes

Parameters​

ParameterType
argsRequestArgs<RpcTypes, M>

Returns​

Promise<RpcTypes[M]["result"]>

Implementation of​

CantonRpcProvider.request


fromUrl()​

static fromUrl(chainId: string, url: string, jwt: string | (() => Promise<string>), fetchFn?: (input: string | URL | Request, init?: RequestInit) => Promise<Response>, httpVersion?: "1" | "2", party?: string, signer?: TransactionSigner): Promise<CantonJsonRpcProvider>

Defined in: canton/provider.ts:100

Parameters​

ParameterType
chainIdstring
urlstring
jwtstring | (() => Promise<string>)
fetchFn?(input: string | URL | Request, init?: RequestInit) => Promise<Response>
httpVersion?"1" | "2"
party?string
signer?TransactionSigner

Returns​

Promise<CantonJsonRpcProvider>