@acala-network/chopsticks-core

---

@acala-network/chopsticks-core / ChopsticksProvider

Class: ChopsticksProvider

Defined in: packages/core/src/chopsticks-provider.ts:36

Provider for local chopsticks chain

Implements

• ProviderInterface

Constructors

Constructor

new ChopsticksProvider(chain): ChopsticksProvider

Defined in: packages/core/src/chopsticks-provider.ts:42

Parameters

chain

Blockchain

Returns

ChopsticksProvider

Properties

chain

readonly chain: Blockchain

Defined in: packages/core/src/chopsticks-provider.ts:42

---

subscriptionManager

subscriptionManager: object

Defined in: packages/core/src/chopsticks-provider.ts:99

subscribe()

subscribe: (method, subid, onCancel) => (data) => void

Parameters

method

string

subid

string

onCancel

() => void

Returns

(data): void

Parameters

data

any

Returns

void

unsubscribe()

unsubscribe: (subid) => void

Parameters

subid

string

Returns

void

Accessors

hasSubscriptions

Get Signature

get hasSubscriptions(): boolean

Defined in: packages/core/src/chopsticks-provider.ts:61

true if the provider supports subscriptions (not available for HTTP)

Returns

boolean

Implementation of

ProviderInterface.hasSubscriptions

---

isClonable

Get Signature

get isClonable(): boolean

Defined in: packages/core/src/chopsticks-provider.ts:65

true if the clone() functionality is available on the provider

Returns

boolean

Implementation of

ProviderInterface.isClonable

---

isConnected

Get Signature

get isConnected(): boolean

Defined in: packages/core/src/chopsticks-provider.ts:69

true if the provider is currently connected (ws/sc has connection logic)

Returns

boolean

Implementation of

ProviderInterface.isConnected

---

isReady

Get Signature

get isReady(): Promise<void>

Defined in: packages/core/src/chopsticks-provider.ts:73

Returns

Promise<void>

Methods

clone()

clone(): ChopsticksProvider

Defined in: packages/core/src/chopsticks-provider.ts:77

Returns

ChopsticksProvider

Implementation of

ProviderInterface.clone

---

connect()

connect(): Promise<void>

Defined in: packages/core/src/chopsticks-provider.ts:81

Returns

Promise<void>

Implementation of

ProviderInterface.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: packages/core/src/chopsticks-provider.ts:86

Returns

Promise<void>

Implementation of

ProviderInterface.disconnect

---

on()

on(type, sub): () => void

Defined in: packages/core/src/chopsticks-provider.ts:91

Parameters

type

ProviderInterfaceEmitted

sub

ProviderInterfaceEmitCb

Returns

(): void

Returns

void

Implementation of

ProviderInterface.on

---

send()

send<T>(method, params, _isCacheable?, subscription?): Promise<T>

Defined in: packages/core/src/chopsticks-provider.ts:128

Type Parameters

T

T

Parameters

method

string

params

unknown[]

_isCacheable?

boolean

subscription?

SubscriptionHandler

Returns

Promise<T>

Implementation of

ProviderInterface.send

---

subscribe()

subscribe(type, method, params, callback): Promise<string | number>

Defined in: packages/core/src/chopsticks-provider.ts:167

Parameters

type

string

method

string

params

unknown[]

callback

ProviderInterfaceCallback

Returns

Promise<string | number>

Implementation of

ProviderInterface.subscribe

---

unsubscribe()

unsubscribe(_type, method, id): Promise<boolean>

Defined in: packages/core/src/chopsticks-provider.ts:176

Parameters

_type

string

method

string

id

string | number

Returns

Promise<boolean>

Implementation of

ProviderInterface.unsubscribe

---

fromEndpoint()

static fromEndpoint(endpoint, block?, db?): Promise<ChopsticksProvider>

Defined in: packages/core/src/chopsticks-provider.ts:50

Parameters

endpoint

string

block?

null | string | number

db?

Database

Returns

Promise<ChopsticksProvider>