Class SmoldotProvider

Name

SmoldotProvider

Hierarchy

SubscriptionProvider
- SmoldotProvider

Index

Constructors

Properties

_handlers _onReceiveResponse _pendingNotifications _status _subscriptions

Accessors

Methods

_cleanUp _handleNotification _handleResponse _setStatus chain clearEvents connect disconnect doSend emit off on once send setChain subscribe

Constructors

constructor

new SmoldotProvider(chain): SmoldotProvider
Parameters
- chain: Chain | Promise<Chain>
Returns SmoldotProvider
Overrides SubscriptionProvider.constructor
- Defined in packages/providers/dist/smoldot/SmoldotProvider.d.ts:9

Properties

`Protected`_handlers

_handlers: Record<number, RequestState<any>>

`Protected`_onReceiveResponse

_onReceiveResponse: ((response: string) => void)

`Protected`_pendingNotifications

_pendingNotifications: Record<string, JsonRpcResponseNotification<any>[]>

`Protected`_status

_status: ConnectionStatus

`Protected`_subscriptions

_subscriptions: Record<string, SubscriptionState>

Accessors

status

get status(): ConnectionStatus
The current connection status

Returns ConnectionStatus
Inherited from SubscriptionProvider.status
- Defined in packages/providers/dist/base/SubscriptionProvider.d.ts:30

Methods

`Protected`_cleanUp

_cleanUp(): void
Returns void
Inherited from SubscriptionProvider._cleanUp
- Defined in packages/providers/dist/base/SubscriptionProvider.d.ts:29

_handleNotification

_handleNotification(response): void
Parameters
- response: JsonRpcResponseNotification<any>
Returns void
Inherited from SubscriptionProvider._handleNotification
- Defined in packages/providers/dist/base/SubscriptionProvider.d.ts:33

`Protected`_handleResponse

_handleResponse(response): void
Parameters
- response: JsonRpcResponse
Returns void
Inherited from SubscriptionProvider._handleResponse
- Defined in packages/providers/dist/base/SubscriptionProvider.d.ts:32

`Protected`_setStatus

_setStatus(status): void
Parameters
- status: ConnectionStatus
Returns void
Inherited from SubscriptionProvider._setStatus
- Defined in packages/providers/dist/base/SubscriptionProvider.d.ts:28

chain

chain(): Promise<Chain>
Returns Promise<Chain>
- Defined in packages/providers/dist/smoldot/SmoldotProvider.d.ts:10

`Protected`clearEvents

clearEvents(): void
Returns void
Inherited from SubscriptionProvider.clearEvents
- Defined in packages/utils/dist/event/EventEmitter.d.ts:12

connect

connect(): Promise<SmoldotProvider>
Returns Promise<SmoldotProvider>
Overrides SubscriptionProvider.connect
- Defined in packages/providers/dist/smoldot/SmoldotProvider.d.ts:12

disconnect

disconnect(): Promise<void>
Disconnect the provider & remove the chain

To reconnect again, make sure set a new smoldot.Chain instance via setChain first & call connect

Returns Promise<void>
Overrides SubscriptionProvider.disconnect
- Defined in packages/providers/dist/smoldot/SmoldotProvider.d.ts:19

`Protected`doSend

doSend(request): Promise<void>
Parameters
- request: JsonRpcRequest
Returns Promise<void>
Overrides SubscriptionProvider.doSend
- Defined in packages/providers/dist/smoldot/SmoldotProvider.d.ts:20

emit

emit(event, ...args): boolean
Parameters
- event: ProviderEvent
- Rest...args: any[]
Returns boolean
Inherited from SubscriptionProvider.emit
- Defined in packages/utils/dist/event/EventEmitter.d.ts:11

off

off(event, handler?): this
Parameters
- event: ProviderEvent
- Optionalhandler: HandlerFn
Returns this
Inherited from SubscriptionProvider.off
- Defined in packages/utils/dist/event/EventEmitter.d.ts:15

on

on(event, handler): Unsub
Parameters
- event: ProviderEvent
- handler: HandlerFn
Returns Unsub
Inherited from SubscriptionProvider.on
- Defined in packages/utils/dist/event/EventEmitter.d.ts:13

once

once(event, handler): Unsub
Parameters
- event: ProviderEvent
- handler: HandlerFn
Returns Unsub
Inherited from SubscriptionProvider.once
- Defined in packages/utils/dist/event/EventEmitter.d.ts:14

send

send<T>(method, params): Promise<T>
Send a JSON-RPC request, make sure to connect to the provider first before sending requests
Type Parameters
- T = any
Parameters
- method: string
- params: any[]
Returns Promise<T>
Inherited from SubscriptionProvider.send
- Defined in packages/providers/dist/base/SubscriptionProvider.d.ts:34

setChain

setChain(chain): void
Parameters
- chain: Chain | Promise<Chain>
Returns void
- Defined in packages/providers/dist/smoldot/SmoldotProvider.d.ts:11

subscribe

subscribe<T>(input, callback): Promise<JsonRpcSubscription>
Make a subscription request, make sure to connect to the provider first before sending requests
Type Parameters
- T = any
Parameters
- input: JsonRpcSubscriptionInput
- callback: JsonRpcSubscriptionCallback<T>
Returns Promise<JsonRpcSubscription>
Inherited from SubscriptionProvider.subscribe
- Defined in packages/providers/dist/base/SubscriptionProvider.d.ts:35