Chopsticks Docs

Appearance

@acala-network/chopsticks-core

@acala-network/chopsticks-core / Api

Class: Api ​

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

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 ​

new Api() ​

new Api(provider, signedExtensions?): Api

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

Parameters ​

provider ​

ProviderInterface

signedExtensions? ​

ExtDef

Returns ​

Api

Properties ​

signedExtensions ​

readonly signedExtensions: ExtDef

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

Accessors ​

chain ​

Get Signature ​

get chain(): Promise<string>

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

Returns ​

Promise<string>

chainProperties ​

Get Signature ​

get chainProperties(): Promise<ChainProperties>

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

Returns ​

Promise<ChainProperties>

isReady ​

Get Signature ​

get isReady(): undefined | Promise<void>

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

Returns ​

undefined | Promise<void>

Methods ​

disconnect() ​

disconnect(): Promise<void>

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

Returns ​

Promise<void>

getBlock() ​

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

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

Parameters ​

hash? ​

string

Returns ​

Promise<null | SignedBlock>

getBlockHash() ​

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

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

Parameters ​

blockNumber? ​

number

Returns ​

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

getFinalizedHead() ​

getFinalizedHead(): Promise<string>

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

Returns ​

Promise<string>

getHeader() ​

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

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

Parameters ​

hash? ​

string

Returns ​

Promise<null | Header>

getKeysPaged() ​

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

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

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:117

Parameters ​

key ​

string

hash? ​

string

Returns ​

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

getStorageBatch() ​

getStorageBatch(prefix, keys, hash?): Promise<[`0x${string}`, null | `0x${string}`][]>

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

Parameters ​

prefix ​

`0x${string}`

keys ​

`0x${string}`[]

hash? ​

`0x${string}`

Returns ​

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

getSystemChain() ​

getSystemChain(): Promise<string>

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

Returns ​

Promise<string>

getSystemName() ​

getSystemName(): Promise<string>

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

Returns ​

Promise<string>

getSystemProperties() ​

getSystemProperties(): Promise<ChainProperties>

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

Returns ​

Promise<ChainProperties>

onFetching() ​

onFetching(fetching?): void

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

Parameters ​

fetching? ​

() => void

Returns ​

void

send() ​

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

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

Type Parameters ​

• 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:174

Parameters ​

cb ​

ProviderInterfaceCallback

Returns ​

Promise<string | number>

subscribeRemoteNewHeads() ​

subscribeRemoteNewHeads(cb): Promise<string | number>

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

Parameters ​

cb ​

ProviderInterfaceCallback

Returns ​

Promise<string | number>