Skip to content

@acala-network/chopsticks-core


@acala-network/chopsticks-core / Api

Class: Api

Defined in: packages/core/src/api.ts:22

API class. Calls provider to get on-chain data. Either endpoint or genesis porvider must be provided.

Example

ts
const provider = new WsProvider(options.endpoint)
const api = new Api(provider)
await api.isReady

Constructors

Constructor

new Api(provider, signedExtensions?): Api

Defined in: packages/core/src/api.ts:34

Parameters

provider

ProviderInterface

signedExtensions?

ExtDef

Returns

Api

Properties

signedExtensions

readonly signedExtensions: ExtDef

Defined in: packages/core/src/api.ts:28

Accessors

chain

Get Signature

get chain(): Promise<string>

Defined in: packages/core/src/api.ts:62

Returns

Promise<string>


chainProperties

Get Signature

get chainProperties(): Promise<ChainProperties>

Defined in: packages/core/src/api.ts:69

Returns

Promise<ChainProperties>


isReady

Get Signature

get isReady(): undefined | Promise<void>

Defined in: packages/core/src/api.ts:43

Returns

undefined | Promise<void>

Methods

disconnect()

disconnect(): Promise<void>

Defined in: packages/core/src/api.ts:39

Returns

Promise<void>


getBlock()

getBlock(hash?): Promise<null | SignedBlock>

Defined in: packages/core/src/api.ts:114

Parameters

hash?

string

Returns

Promise<null | SignedBlock>


getBlockHash()

getBlockHash(blockNumber?): Promise<null | `0x${string}`>

Defined in: packages/core/src/api.ts:98

Parameters

blockNumber?

number

Returns

Promise<null | `0x${string}`>


getFinalizedHead()

getFinalizedHead(): Promise<string>

Defined in: packages/core/src/api.ts:110

Returns

Promise<string>


getHeader()

getHeader(hash?): Promise<null | Header>

Defined in: packages/core/src/api.ts:106

Parameters

hash?

string

Returns

Promise<null | Header>


getKeysPaged()

getKeysPaged(prefix, pageSize, startKey, hash?): Promise<`0x${string}`[]>

Defined in: packages/core/src/api.ts:132

Parameters

prefix

string

pageSize

number

startKey

string

hash?

string

Returns

Promise<`0x${string}`[]>


getStorage()

getStorage(key, hash?): Promise<null | `0x${string}`>

Defined in: packages/core/src/api.ts:118

Parameters

key

string

hash?

string

Returns

Promise<null | `0x${string}`>


getStorageBatch()

getStorageBatch(prefix, keys, hash?): any

Defined in: packages/core/src/api.ts:149

Parameters

prefix

`0x${string}`

keys

`0x${string}`[]

hash?

`0x${string}`

Returns

any


getSystemChain()

getSystemChain(): Promise<string>

Defined in: packages/core/src/api.ts:94

Returns

Promise<string>


getSystemName()

getSystemName(): Promise<string>

Defined in: packages/core/src/api.ts:86

Returns

Promise<string>


getSystemProperties()

getSystemProperties(): Promise<ChainProperties>

Defined in: packages/core/src/api.ts:90

Returns

Promise<ChainProperties>


onFetching()

onFetching(fetching?): void

Defined in: packages/core/src/api.ts:77

Parameters

fetching?

() => void

Returns

void


send()

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

Defined in: packages/core/src/api.ts:81

Type Parameters

T

T = any

Parameters

method

string

params

unknown[]

isCacheable?

boolean

Returns

Promise<T>


subscribeRemoteFinalizedHeads()

subscribeRemoteFinalizedHeads(cb): Promise<string | number>

Defined in: packages/core/src/api.ts:191

Parameters

cb

ProviderInterfaceCallback

Returns

Promise<string | number>


subscribeRemoteNewHeads()

subscribeRemoteNewHeads(cb): Promise<string | number>

Defined in: packages/core/src/api.ts:184

Parameters

cb

ProviderInterfaceCallback

Returns

Promise<string | number>