@acala-network/chopsticks-core

---

@acala-network/chopsticks-core / Api

Class: Api

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

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

Example

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

Parameters

provider

ProviderInterface

signedExtensions?

ExtDef

Returns

Api

Properties

signedExtensions

readonly signedExtensions: ExtDef

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

Accessors

chain

Get Signature

get chain(): Promise<string>

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

Returns

Promise<string>

---

chainProperties

Get Signature

get chainProperties(): Promise<ChainProperties>

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

Returns

Promise<ChainProperties>

---

isReady

Get Signature

get isReady(): Promise<void> | undefined

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

Returns

Promise<void> | undefined

Methods

disconnect()

disconnect(): Promise<void>

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

Returns

Promise<void>

---

getBlock()

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

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

Parameters

hash?

string

Returns

Promise<SignedBlock | null>

---

getBlockHash()

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

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

Parameters

blockNumber?

number

Returns

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

---

getFinalizedHead()

getFinalizedHead(): Promise<string>

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

Returns

Promise<string>

---

getHeader()

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

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

Parameters

hash?

string

Returns

Promise<Header | null>

---

getKeysPaged()

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

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

Parameters

prefix

string

pageSize

number

startKey

string

hash?

string

Returns

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

---

getReadProof()

getReadProof(keys, hash?): Promise<{ at: `0x${string}`; proof: `0x${string}`[]; }>

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

Upstream state_getReadProof. Throws if upstream doesn't expose it.

Parameters

keys

`0x${string}`[]

hash?

`0x${string}`

Returns

Promise<{ at: `0x${string}`; proof: `0x${string}`[]; }>

---

getStorage()

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

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

Parameters

key

string

hash?

string

Returns

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

---

getStorageBatch()

getStorageBatch(prefix, keys, hash?): any

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

Parameters

prefix

`0x${string}`

keys

`0x${string}`[]

hash?

`0x${string}`

Returns

any

---

getSystemChain()

getSystemChain(): Promise<string>

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

Returns

Promise<string>

---

getSystemName()

getSystemName(): Promise<string>

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

Returns

Promise<string>

---

getSystemProperties()

getSystemProperties(): Promise<ChainProperties>

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

Returns

Promise<ChainProperties>

---

onFetching()

onFetching(fetching?): void

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

Parameters

fetching?

() => void

Returns

void

---

send()

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

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

Type Parameters

T

T = any

Parameters

method

string

params

unknown[]

isCacheable?

boolean

Returns

Promise<T>

---

setDb()

setDb(db, scope): void

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

Parameters

db

Database

scope

string

Returns

void

---

subscribeRemoteFinalizedHeads()

subscribeRemoteFinalizedHeads(cb): Promise<string | number>

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

Parameters

cb

ProviderInterfaceCallback

Returns

Promise<string | number>

---

subscribeRemoteNewHeads()

subscribeRemoteNewHeads(cb): Promise<string | number>

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

Parameters

cb

ProviderInterfaceCallback

Returns

Promise<string | number>