Chopsticks Docs

Appearance

@acala-network/chopsticks-core

@acala-network/chopsticks-core / Block

Class: Block ​

Defined in: packages/core/src/blockchain/block.ts:37

Block class.

Examples ​

ts
const block = new Block(chain, number, hash)
ts
const block = await chain.getBlock('0x...')
block.storage()

Constructors ​

Constructor ​

new Block(chain, number, hash, parentBlock?, block?): Block

Defined in: packages/core/src/blockchain/block.ts:53

Parameters ​

chain ​

Blockchain

number ​

number

hash ​

`0x${string}`

parentBlock? ​

Block

block? ​
extrinsics ​

`0x${string}`[]

Extrinsics

Header

See @polkadot/types/interfaces Header

storage? ​

StorageLayerProvider

Storage provider. Default to RemoteStorageLayer with chain.api as remote.

storageDiff? ​

Record<string, StorageValue | null>

Storage diff to apply.

Returns ​

Block

Properties ​

hash ​

readonly hash: `0x${string}`

Defined in: packages/core/src/blockchain/block.ts:56

number ​

readonly number: number

Defined in: packages/core/src/blockchain/block.ts:55

Accessors ​

chain ​

Get Signature ​

get chain(): Blockchain

Defined in: packages/core/src/blockchain/block.ts:97

Returns ​

Blockchain

extrinsics ​

Get Signature ​

get extrinsics(): `0x${string}`[] | Promise<`0x${string}`[]>

Defined in: packages/core/src/blockchain/block.ts:110

Returns ​

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

header ​

Get Signature ​

get header(): Header | Promise<Header>

Defined in: packages/core/src/blockchain/block.ts:101

Returns ​

Header | Promise<Header>

meta ​

Get Signature ​

get meta(): Promise<DecoratedMeta>

Defined in: packages/core/src/blockchain/block.ts:304

Returns ​

Promise<DecoratedMeta>

metadata ​

Get Signature ​

get metadata(): Promise<`0x${string}`>

Defined in: packages/core/src/blockchain/block.ts:297

Returns ​

Promise<`0x${string}`>

parentBlock ​

Get Signature ​

get parentBlock(): Promise<Block | undefined>

Defined in: packages/core/src/blockchain/block.ts:122

Returns ​

Promise<Block | undefined>

registry ​

Get Signature ​

get registry(): Promise<TypeRegistry>

Defined in: packages/core/src/blockchain/block.ts:281

Get the type registry.

See ​

https://polkadot.js.org/docs/api/start/types.create#why-create-types

Returns ​

Promise<TypeRegistry>

runtimeVersion ​

Get Signature ​

get runtimeVersion(): Promise<RuntimeVersion>

Defined in: packages/core/src/blockchain/block.ts:290

Returns ​

Promise<RuntimeVersion>

storage ​

Get Signature ​

get storage(): StorageLayerProvider

Defined in: packages/core/src/blockchain/block.ts:147

Get the block storage.

Returns ​

StorageLayerProvider

storageLayerCount ​

Get Signature ​

get storageLayerCount(): number

Defined in: packages/core/src/blockchain/block.ts:229

The current depth of the storage layer stack.

Returns ​

number

wasm ​

Get Signature ​

get wasm(): Promise<`0x${string}`>

Defined in: packages/core/src/blockchain/block.ts:249

Get the wasm string.

Returns ​

Promise<`0x${string}`>

Methods ​

call() ​

call(method, args, mockSigantureHostOverride): Promise<TaskCallResponse>

Defined in: packages/core/src/blockchain/block.ts:317

Call a runtime method.

Parameters ​

method ​

string

args ​

`0x${string}`[]

mockSigantureHostOverride ​

boolean = false

Returns ​

Promise<TaskCallResponse>

get() ​

get(key): Promise<`0x${string}` | undefined>

Defined in: packages/core/src/blockchain/block.ts:154

Get the block storage by key.

Parameters ​

key ​

string

Returns ​

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

getKeysPaged() ​

getKeysPaged(options): Promise<string[]>

Defined in: packages/core/src/blockchain/block.ts:193

Get paged storage keys.

Parameters ​

options ​
pageSize ​

number

prefix? ​

string

startKey? ​

string

Returns ​

Promise<string[]>

getMany() ​

getMany(keys): Promise<(`0x${string}` | undefined)[]>

Defined in: packages/core/src/blockchain/block.ts:167

Get the block storage by key.

Parameters ​

keys ​

string[]

Returns ​

Promise<(`0x${string}` | undefined)[]>

popStorageLayer() ​

popStorageLayer(): void

Defined in: packages/core/src/blockchain/block.ts:213

Pop a layer from the storage stack.

Returns ​

void

pushStorageLayer() ​

pushStorageLayer(): StorageLayer

Defined in: packages/core/src/blockchain/block.ts:204

Push a layer to the storage stack.

Returns ​

StorageLayer

read() ​

read<T>(type, query, ...args): Promise<DetectCodec<Codec, T> | undefined>

Defined in: packages/core/src/blockchain/block.ts:179

Type Parameters ​

T ​

T extends string

Parameters ​

type ​

T

query ​

StorageEntry

args ​

...any[]

Returns ​

Promise<DetectCodec<Codec, T> | undefined>

resetStorageLayers() ​

resetStorageLayers(targetCount): void

Defined in: packages/core/src/blockchain/block.ts:224

Truncate the storage layer stack back to a target depth.

Used by snapshot-restore mechanisms to undo accumulated dev.setStorage calls when reverting to a previously captured state, without losing the underlying block.

Parameters ​

targetCount ​

number

Returns ​

void

setWasm() ​

setWasm(wasm): void

Defined in: packages/core/src/blockchain/block.ts:267

Set the runtime wasm.

Parameters ​

wasm ​

`0x${string}`

Returns ​

void

storageDiff() ​

storageDiff(): Promise<Record<`0x${string}`, `0x${string}` | null>>

Defined in: packages/core/src/blockchain/block.ts:236

Get storage diff.

Returns ​

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