@acala-network/chopsticks-core

@acala-network/chopsticks-core

Chopsticks core package. A common package for usage in both server and browser. It contains a local blockchain implementation, a transaction pool, a runtime executor and more!

Table of contents

Enumerations

• BuildBlockMode
• StorageValueKind

Classes

• Api
• Block
• Blockchain
• ChopsticksProvider
• Database
• GenesisProvider
• HeadState
• OffchainWorker
• RemoteStorageLayer
• ResponseError
• StorageLayer
• TxPool

Interfaces

• BlockEntry
• BuildBlockParams
• Context
• DownwardMessage
• HorizontalMessage
• InherentProvider
• JsCallback
• KeyValueEntry
• Options
• StorageLayerProvider
• SubscriptionManager
• WasmExecutor

Type Aliases

• BuildBlockCallbacks
• ChainProperties
• Deferred
• Genesis
• GetKeys
• Handler
• Handlers
• Header
• ProcessKey
• RuntimeLog
• RuntimeVersion
• SetupOptions
• SignedBlock
• StorageValue
• StorageValues
• TaskCallResponse
• TaskResponse

Variables

• APPLY_EXTRINSIC_ERROR
• CHILD_PREFIX_LENGTH
• PREFIX_LENGTH
• allHandlers
• defaultLogger
• dev
• emptyTaskHandler
• environment
• environmentSchema
• genesisSchema
• inherentProviders
• pinoLogger
• substrate
• xcmLogger

Functions

• buildBlock
• calculateStateRoot
• compactHex
• connectParachains
• connectVertical
• createProof
• decodeBlockStorageDiff
• decodeKey
• decodeKeyValue
• decodeProof
• defer
• destroyWorker
• dryRunExtrinsic
• dryRunInherents
• fetchKeys
• fetchKeysToArray
• genesisDigestLogs
• getAuraSlotDuration
• getCurrentSlot
• getCurrentTimestamp
• getParaId
• getRuntimeVersion
• getSlotDuration
• getWorker
• isPrefixedChildKey
• isUrl
• newHeader
• prefixedChildKey
• processOptions
• randomId
• runTask
• setStorage
• setup
• splitChildKey
• stripChildPrefix
• taskHandler
• timeTravel
• toStorageObject
• truncate

Type Aliases

BuildBlockCallbacks

Ƭ BuildBlockCallbacks: Object

Type declaration

Name	Type
onApplyExtrinsicError?	(extrinsic: HexString, error: TransactionValidityError) => void
onPhaseApplied?	(phase: "initialize" | "finalize" | number, resp: TaskCallResponse) => void

Defined in

packages/core/src/blockchain/block-builder.ts:207

---

ChainProperties

Ƭ ChainProperties: Object

Type declaration

Name	Type
ss58Format?	number
tokenDecimals?	number[]
tokenSymbol?	string[]

Defined in

packages/core/src/index.ts:13

---

Deferred

Ƭ Deferred<T>: Object

Type parameters

Name
T

Type declaration

Name	Type
promise	Promise<T>
reject	(reason?: any) => void
resolve	(value: T | PromiseLike<T>) => void

Defined in

packages/core/src/utils/index.ts:68

---

Genesis

Ƭ Genesis: z.infer<typeof genesisSchema>

Defined in

packages/core/src/schema/index.ts:14

---

GetKeys

Ƭ GetKeys: (startKey?: string) => Promise<StorageKey<any>[]>

Type declaration

▸ (startKey?): Promise<StorageKey<any>[]>

Parameters

Name	Type
startKey?	string

Returns

Promise<StorageKey<any>[]>

Defined in

packages/core/src/utils/index.ts:15

---

Handler

Ƭ Handler<TParams, TReturn>: (context: Context, params: TParams, subscriptionManager: SubscriptionManager) => Promise<TReturn>

Type parameters

Name	Type
TParams	any
TReturn	any

Type declaration

▸ (context, params, subscriptionManager): Promise<TReturn>

Parameters

Name	Type
context	Context
params	TParams
subscriptionManager	SubscriptionManager

Returns

Promise<TReturn>

Defined in

packages/core/src/rpc/shared.ts:41

---

Handlers

Ƭ Handlers: Record<string, Handler>

Defined in

packages/core/src/rpc/shared.ts:46

---

Header

Ƭ Header: Object

Type declaration

Name	Type
digest	{ logs: HexString[] }
digest.logs	HexString[]
extrinsicsRoot	HexString
number	HexString
parentHash	HexString
stateRoot	HexString

Defined in

packages/core/src/index.ts:19

---

ProcessKey

Ƭ ProcessKey: (key: StorageKey<any>) => any

Type declaration

▸ (key): any

Parameters

Name	Type
key	StorageKey<any>

Returns

any

Defined in

packages/core/src/utils/index.ts:17

---

RuntimeLog

Ƭ RuntimeLog: Object

Type declaration

Name	Type
level?	number
message	string
target?	string

Defined in

packages/core/src/wasm-executor/index.ts:25

---

RuntimeVersion

Ƭ RuntimeVersion: Object

Type declaration

Name	Type
apis	[HexString, number][]
authoringVersion	number
implName	string
implVersion	number
specName	string
specVersion	number
stateVersion	number
transactionVersion	number

Defined in

packages/core/src/wasm-executor/index.ts:14

---

SetupOptions

Ƭ SetupOptions: Object

Type declaration

Name	Type
allowUnresolvedImports?	boolean
block?	string | number | null
buildBlockMode?	BuildBlockMode
db?	Database
endpoint?	string | string[]
genesis?	GenesisProvider
maxMemoryBlockCount?	number
mockSignatureHost?	boolean
offchainWorker?	boolean
processQueuedMessages?	boolean
registeredTypes?	RegisteredTypes
runtimeLogLevel?	number

Defined in

packages/core/src/setup.ts:15

---

SignedBlock

Ƭ SignedBlock: Object

Type declaration

Name	Type
block	{ extrinsics: HexString[] ; header: Header }
block.extrinsics	HexString[]
block.header	Header
justifications?	HexString[]

Defined in

packages/core/src/index.ts:29

---

StorageValue

Ƭ StorageValue: string | StorageValueKind | undefined

Defined in

packages/core/src/blockchain/storage-layer.ts:19

---

StorageValues

Ƭ StorageValues: RawStorageValues | StorageConfig

Defined in

packages/core/src/utils/set-storage.ts:12

---

TaskCallResponse

Ƭ TaskCallResponse: Object

Type declaration

Name	Type
offchainStorageDiff	[HexString, HexString | null][]
result	HexString
runtimeLogs	RuntimeLog[]
storageDiff	[HexString, HexString | null][]

Defined in

packages/core/src/wasm-executor/index.ts:31

---

TaskResponse

Ƭ TaskResponse: { Call: TaskCallResponse } | { Error: string }

Defined in

packages/core/src/wasm-executor/index.ts:38

Variables

APPLY_EXTRINSIC_ERROR

• Const APPLY_EXTRINSIC_ERROR: "TxPool::ApplyExtrinsicError"

Defined in

packages/core/src/blockchain/txpool.ts:15

---

CHILD_PREFIX_LENGTH

• Const CHILD_PREFIX_LENGTH: number

Defined in

packages/core/src/utils/index.ts:90

---

PREFIX_LENGTH

• Const PREFIX_LENGTH: 66

Defined in

packages/core/src/utils/index.ts:93

---

allHandlers

• Const allHandlers: Handlers

Defined in

packages/core/src/rpc/index.ts:5

---

defaultLogger

• Const defaultLogger: Logger<never>

Defined in

packages/core/src/logger.ts:16

---

dev

• Const dev: Object

Type declaration

Name	Type
dev_newBlock	(context: Context, params: [NewBlockParams]) => Promise<`0x${string}`>
dev_setBlockBuildMode	(context: Context, params: [BuildBlockMode]) => Promise<void>
dev_setHead	(context: Context, hashOrNumber: [number | `0x${string}`]) => Promise<`0x${string}`>
dev_setRuntimeLogLevel	(context: Context, runtimeLogLevel: [number]) => Promise<void>
dev_setStorage	(context: Context, params: [StorageValues, `0x${string}`?]) => Promise<`0x${string}`>
dev_timeTravel	(context: Context, date: [string | number]) => Promise<number>

Defined in

packages/core/src/rpc/dev/index.ts:8

---

emptyTaskHandler

• Const emptyTaskHandler: Object

Type declaration

Name	Type
getNextKey	(_prefix: `0x${string}`, _key: `0x${string}`) => Promise<never>
getStorage	(_key: `0x${string}`) => Promise<never>
offchainGetStorage	(_key: `0x${string}`) => Promise<never>
offchainRandomSeed	() => Promise<never>
offchainSubmitTransaction	(_tx: `0x${string}`) => Promise<never>
offchainTimestamp	() => Promise<never>

Defined in

packages/core/src/wasm-executor/index.ts:174

---

environment

• Const environment: Object

Environment variables available for users

Type declaration

Name	Type	Description
DISABLE_AUTO_HRMP	boolean	Disable auto HRMP on setup. Default is false.
DISABLE_PLUGINS	boolean	Disable plugins for faster startup. Default is false.
HTTPS_PROXY?	string	-
HTTP_PROXY?	string	-
LOG_COMPACT	boolean	Don't log objects. Default is false.
LOG_LEVEL	"error" | "fatal" | "warn" | "info" | "debug" | "trace"	Chopsticks log level, "fatal" | "error" | "warn" | "info" | "debug" | "trace". Default is "info".
PORT?	string	Set port for Chopsticks to listen on, default is 8000.
VERBOSE_LOG	boolean	Don't truncate log messages, show full log output. Default is false.
http_proxy?	string	-
https_proxy?	string	-

Defined in

packages/core/src/env.ts:50

---

environmentSchema

• Const environmentSchema: ZodObject<{ DISABLE_AUTO_HRMP: ZodEffects<ZodDefault<ZodEnum<["true", "false"]>>, boolean, undefined | "true" | "false"> ; DISABLE_PLUGINS: ZodEffects<ZodDefault<ZodEnum<["true", "false"]>>, boolean, undefined | "true" | "false"> ; HTTPS_PROXY: ZodOptional<ZodString> ; HTTP_PROXY: ZodOptional<ZodString> ; LOG_COMPACT: ZodEffects<ZodDefault<ZodEnum<["true", "false"]>>, boolean, undefined | "true" | "false"> ; LOG_LEVEL: ZodDefault<ZodEnum<["fatal", "error", "warn", "info", "debug", "trace"]>> ; PORT: ZodOptional<ZodString> ; VERBOSE_LOG: ZodEffects<ZodDefault<ZodEnum<["true", "false"]>>, boolean, undefined | "true" | "false"> ; http_proxy: ZodOptional<ZodString> ; https_proxy: ZodOptional<ZodString> }, "strip", ZodTypeAny, { DISABLE_AUTO_HRMP: boolean ; DISABLE_PLUGINS: boolean ; HTTPS_PROXY?: string ; HTTP_PROXY?: string ; LOG_COMPACT: boolean ; LOG_LEVEL: "error" | "fatal" | "warn" | "info" | "debug" | "trace" ; PORT?: string ; VERBOSE_LOG: boolean ; http_proxy?: string ; https_proxy?: string }, { DISABLE_AUTO_HRMP?: "true" | "false" ; DISABLE_PLUGINS?: "true" | "false" ; HTTPS_PROXY?: string ; HTTP_PROXY?: string ; LOG_COMPACT?: "true" | "false" ; LOG_LEVEL?: "error" | "fatal" | "warn" | "info" | "debug" | "trace" ; PORT?: string ; VERBOSE_LOG?: "true" | "false" ; http_proxy?: string ; https_proxy?: string }>

Defined in

packages/core/src/env.ts:3

---

genesisSchema

• Const genesisSchema: ZodObject<{ genesis: ZodObject<{ raw: ZodObject<{ top: ZodRecord<ZodString, ZodString> }, "strip", ZodTypeAny, { top: Record<string, string> }, { top: Record<string, string> }> }, "strip", ZodTypeAny, { raw: { top: Record<string, string> } }, { raw: { top: Record<string, string> } }> ; id: ZodString ; name: ZodString ; properties: ZodObject<{ ss58Format: ZodOptional<ZodNumber> ; tokenDecimals: ZodOptional<ZodUnion<[ZodNumber, ZodArray<ZodNumber, "many">]>> ; tokenSymbol: ZodOptional<ZodUnion<[ZodString, ZodArray<ZodString, "many">]>> }, "strip", ZodTypeAny, { ss58Format?: number ; tokenDecimals?: number | number[] ; tokenSymbol?: string | string[] }, { ss58Format?: number ; tokenDecimals?: number | number[] ; tokenSymbol?: string | string[] }> }, "strip", ZodTypeAny, { genesis: { raw: { top: Record<string, string> } } ; id: string ; name: string ; properties: { ss58Format?: number ; tokenDecimals?: number | number[] ; tokenSymbol?: string | string[] } }, { genesis: { raw: { top: Record<string, string> } } ; id: string ; name: string ; properties: { ss58Format?: number ; tokenDecimals?: number | number[] ; tokenSymbol?: string | string[] } }>

Defined in

packages/core/src/schema/index.ts:3

---

inherentProviders

• Const inherentProviders: (ParaInherentEnter | SetBabeRandomness | SetNimbusAuthorInherent | SetTimestamp | SetValidationData)[]

Defined in

packages/core/src/blockchain/inherent/index.ts:14

---

pinoLogger

• Const pinoLogger: Logger<never>

Defined in

packages/core/src/logger.ts:5

---

substrate

• Const substrate: Object

Type declaration

Name	Type	Description
author_pendingExtrinsics	Handler<void, `0x${string}`[]>	Get pending extrinsics
author_submitAndWatchExtrinsic	Handler<[`0x${string}`], string>	Param Param [extrinsic] Param
author_submitExtrinsic	Handler<[`0x${string}`], `0x${string}`>	Param Param [extrinsic]
author_unwatchExtrinsic	Handler<[string], void>	Param Param [subid]
chain_getBlock	Handler<[`0x${string}`], { block: { extrinsics: `0x${string}`[] ; header: Header } ; justifications: null }>	Param Param [blockhash]
chain_getBlockHash	Handler<[null | number | `0x${string}` | `0x${string}`[] | number[]], null | `0x${string}` | (null | `0x${string}`)[]>	Param Param [blockNumber | blockNumber[] | null]
chain_getFinalizedHead	Handler<void, `0x${string}`>	Param
chain_getHead	Handler<[null | number | `0x${string}` | `0x${string}`[] | number[]], null | `0x${string}` | (null | `0x${string}`)[]>	-
chain_getHeader	Handler<[`0x${string}`], Header>	Param Param [blockhash]
chain_subscribeFinalizedHeads	Handler<void, string>	-
chain_subscribeNewHead	Handler<void, string>	-
chain_subscribeNewHeads	Handler<void, string>	-
chain_unsubscribeFinalizedHeads	Handler<[string], void>	-
chain_unsubscribeNewHead	Handler<[string], void>	-
chain_unsubscribeNewHeads	Handler<[string], void>	-
childstate_getKeysPaged	Handler<[`0x${string}`, `0x${string}`, number, `0x${string}`, `0x${string}`], undefined | `0x${string}`[]>	Param Param [child, prefix, pageSize, startKey, blockhash]
childstate_getStorage	Handler<[`0x${string}`, `0x${string}`, `0x${string}`], null | string>	Param Param [child, key, blockhash]
payment_queryFeeDetails	Handler<[`0x${string}`, `0x${string}`], `0x${string}`>	Param Param [extrinsic, blockhash]
payment_queryInfo	Handler<[`0x${string}`, `0x${string}`], `0x${string}`>	Param Param [extrinsic, blockhash]
state_call	Handler<[`0x${string}`, `0x${string}`, `0x${string}`], `0x${string}`>	Param Param [method, data, blockhash]
state_getKeysPaged	Handler<[string, number, string, `0x${string}`], undefined | string[]>	Param Param [prefix, pageSize, startKey, blockhash]
state_getMetadata	Handler<[`0x${string}`], null | `0x${string}`>	Param Param [blockhash]
state_getRuntimeVersion	Handler<[`0x${string}`], null | RuntimeVersion>	Param Param [blockhash]
state_getStorage	Handler<[`0x${string}`, `0x${string}`], null | string>	Param Param [key, blockhash]
state_getStorageAt	Handler<[`0x${string}`, `0x${string}`], null | string>	-
state_queryStorageAt	Handler<[string[], `0x${string}`], [] | [{ block: `0x${string}` ; changes: [string, null | string][] }]>	Param Param [keys, blockhash]
state_subscribeRuntimeVersion	Handler<[], string>
state_subscribeStorage	Handler<[string[]], string>	Param Param [keys] Param
state_unsubscribeRuntimeVersion	Handler<[`0x${string}`], void>	Param Param [subid] Param
state_unsubscribeStorage	Handler<[string], void>	Param Param [subid] Param
system_accountNextIndex	Handler<[`0x${string}`], number>	Param Param [address]
system_chain	Handler<void, string>	-
system_chainType	Handler<void, string>	-
system_dryRun	Handler<[`0x${string}`, `0x${string}`], string>	Param Param [extrinsic, at]
system_health	() => Promise<{ isSyncing: boolean = false; peers: number = 0; shouldHavePeers: boolean = false }>	-
system_localListenAddresses	() => Promise<never[]>	-
system_localPeerId	() => Promise<string>	-
system_name	Handler<void, string>	-
system_nodeRoles	() => Promise<string[]>	-
system_properties	Handler<void, ChainProperties>	-
system_version	Handler<void, string>	-

Defined in

packages/core/src/rpc/substrate/index.ts:13

---

xcmLogger

• Const xcmLogger: Logger<never>

Defined in

packages/core/src/xcm/index.ts:8

Functions

buildBlock

▸ buildBlock(head, inherentProviders, params, callbacks?): Promise<[Block, `0x${string}`[]]>

Parameters

Name	Type
head	Block
inherentProviders	InherentProvider[]
params	BuildBlockParams
callbacks?	BuildBlockCallbacks

Returns

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

Defined in

packages/core/src/blockchain/block-builder.ts:212

---

calculateStateRoot

▸ calculateStateRoot(entries, trie_version): Promise<`0x${string}`>

Parameters

Name	Type
entries	[`0x${string}`, `0x${string}`][]
trie_version	number

Returns

Promise<`0x${string}`>

Defined in

packages/core/src/wasm-executor/index.ts:90

---

compactHex

▸ compactHex(value): `0x${string}`

Parameters

Name	Type
value	Uint8Array

Returns

`0x${string}`

Defined in

packages/core/src/utils/index.ts:46

---

connectParachains

▸ connectParachains(parachains, disableAutoHrmp?): Promise<void>

Parameters

Name	Type	Default value
parachains	Blockchain[]	undefined
disableAutoHrmp	boolean	false

Returns

Promise<void>

Defined in

packages/core/src/xcm/index.ts:18

---

connectVertical

▸ connectVertical(relaychain, parachain): Promise<void>

Parameters

Name	Type
relaychain	Blockchain
parachain	Blockchain

Returns

Promise<void>

Defined in

packages/core/src/xcm/index.ts:10

---

createProof

▸ createProof(nodes, updates): Promise<{ nodes: `0x${string}`[] = newNodes; trieRootHash: `0x${string}` }>

Parameters

Name	Type
nodes	`0x${string}`[]
updates	[`0x${string}`, null | `0x${string}`][]

Returns

Promise<{ nodes: `0x${string}`[] = newNodes; trieRootHash: `0x${string}` }>

Defined in

packages/core/src/wasm-executor/index.ts:110

---

decodeBlockStorageDiff

▸ decodeBlockStorageDiff(block, diff): Promise<{}[]>

Decode block storage diff

Parameters

Name	Type	Description
block	Block	Block to compare storage diff
diff	[`0x${string}`, null | `0x${string}`][]	Storage diff

Returns

Promise<{}[]>

decoded old state and new state

Defined in

packages/core/src/utils/decoder.ts:129

---

decodeKey

▸ decodeKey(meta, key): Object

Parameters

Name	Type
meta	DecoratedMeta
key	`0x${string}`

Returns

Object

Name	Type
decodedKey?	StorageKey<AnyTuple>
storage?	StorageEntry

Defined in

packages/core/src/utils/decoder.ts:48

---

decodeKeyValue

▸ decodeKeyValue(meta, key, value?, toHuman?): undefined | { key: any[] = res.key; method: string = res.name; section: string = 'substrate'; value: AnyJson = res.value }

Parameters

Name	Type	Default value
meta	DecoratedMeta	undefined
key	`0x${string}`	undefined
value?	null | `0x${string}`	undefined
toHuman	boolean	true

Returns

undefined | { key: any[] = res.key; method: string = res.name; section: string = 'substrate'; value: AnyJson = res.value }

Defined in

packages/core/src/utils/decoder.ts:58

---

decodeProof

▸ decodeProof(trieRootHash, nodes): Promise<{ [key: HexString]: HexString; }>

Parameters

Name	Type
trieRootHash	`0x${string}`
nodes	`0x${string}`[]

Returns

Promise<{ [key: HexString]: HexString; }>

Defined in

packages/core/src/wasm-executor/index.ts:98

---

defer

▸ defer<T>(): Deferred<T>

Type parameters

Name
T

Returns

Deferred<T>

Defined in

packages/core/src/utils/index.ts:74

---

destroyWorker

▸ destroyWorker(): Promise<void>

Returns

Promise<void>

Defined in

packages/core/src/wasm-executor/index.ts:208

---

dryRunExtrinsic

▸ dryRunExtrinsic(head, inherentProviders, extrinsic, params): Promise<TaskCallResponse>

Parameters

Name	Type
head	Block
inherentProviders	InherentProvider[]
extrinsic	`0x${string}` | { address: string ; call: `0x${string}` }
params	BuildBlockParams

Returns

Promise<TaskCallResponse>

Defined in

packages/core/src/blockchain/block-builder.ts:379

---

dryRunInherents

▸ dryRunInherents(head, inherentProviders, params): Promise<[`0x${string}`, null | `0x${string}`][]>

Parameters

Name	Type
head	Block
inherentProviders	InherentProvider[]
params	BuildBlockParams

Returns

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

Defined in

packages/core/src/blockchain/block-builder.ts:424

---

fetchKeys

▸ fetchKeys(getKeys, processKey): Promise<void>

Parameters

Name	Type
getKeys	GetKeys
processKey	ProcessKey

Returns

Promise<void>

Defined in

packages/core/src/utils/index.ts:19

---

fetchKeysToArray

▸ fetchKeysToArray(getKeys): Promise<StorageKey<any>[]>

Parameters

Name	Type
getKeys	GetKeys

Returns

Promise<StorageKey<any>[]>

Defined in

packages/core/src/utils/index.ts:40

---

genesisDigestLogs

▸ genesisDigestLogs(head): Promise<DigestItem[]>

Parameters

Name	Type
head	Block

Returns

Promise<DigestItem[]>

Defined in

packages/core/src/blockchain/block-builder.ts:24

---

getAuraSlotDuration

▸ getAuraSlotDuration(wasm): Promise<number>

Parameters

Name	Type
wasm	`0x${string}`

Returns

Promise<number>

Defined in

packages/core/src/wasm-executor/index.ts:195

---

getCurrentSlot

▸ getCurrentSlot(head): Promise<number>

Parameters

Name	Type
head	Block

Returns

Promise<number>

Defined in

packages/core/src/utils/index.ts:125

---

getCurrentTimestamp

▸ getCurrentTimestamp(head): Promise<bigint>

Parameters

Name	Type
head	Block

Returns

Promise<bigint>

Defined in

packages/core/src/utils/index.ts:138

---

getParaId

▸ getParaId(chain): Promise<u32>

Parameters

Name	Type
chain	Blockchain

Returns

Promise<u32>

Defined in

packages/core/src/utils/index.ts:50

---

getRuntimeVersion

▸ getRuntimeVersion(code): Promise<RuntimeVersion>

Parameters

Name	Type
code	`0x${string}`

Returns

Promise<RuntimeVersion>

Defined in

packages/core/src/wasm-executor/index.ts:80

---

getSlotDuration

▸ getSlotDuration(head): Promise<number>

Parameters

Name	Type
head	Block

Returns

Promise<number>

Defined in

packages/core/src/utils/index.ts:144

---

getWorker

▸ getWorker(): Promise<{ remote: Remote<WasmExecutor> ; terminate: () => Promise<void> }>

Returns

Promise<{ remote: Remote<WasmExecutor> ; terminate: () => Promise<void> }>

Defined in

packages/core/src/wasm-executor/index.ts:67

---

isPrefixedChildKey

▸ isPrefixedChildKey(key): boolean

Parameters

Name	Type
key	`0x${string}`

Returns

boolean

Defined in

packages/core/src/utils/index.ts:99

---

isUrl

▸ isUrl(url): boolean

Parameters

Name	Type
url	string

Returns

boolean

Defined in

packages/core/src/utils/index.ts:59

---

newHeader

▸ newHeader(head, unsafeBlockHeight?): Promise<Header>

Parameters

Name	Type
head	Block
unsafeBlockHeight?	number

Returns

Promise<Header>

Defined in

packages/core/src/blockchain/block-builder.ts:87

---

prefixedChildKey

▸ prefixedChildKey(prefix, key): string

Parameters

Name	Type
prefix	`0x${string}`
key	`0x${string}`

Returns

string

Defined in

packages/core/src/utils/index.ts:96

---

processOptions

▸ processOptions(options): Promise<{ allowUnresolvedImports?: boolean ; api: Api ; block?: null | string | number ; blockHash: string ; buildBlockMode?: BuildBlockMode ; db?: Database ; endpoint?: string | string[] ; genesis?: GenesisProvider ; maxMemoryBlockCount?: number ; mockSignatureHost?: boolean ; offchainWorker?: boolean ; processQueuedMessages?: boolean ; registeredTypes?: RegisteredTypes ; runtimeLogLevel?: number }>

Parameters

Name	Type
options	SetupOptions

Returns

Promise<{ allowUnresolvedImports?: boolean ; api: Api ; block?: null | string | number ; blockHash: string ; buildBlockMode?: BuildBlockMode ; db?: Database ; endpoint?: string | string[] ; genesis?: GenesisProvider ; maxMemoryBlockCount?: number ; mockSignatureHost?: boolean ; offchainWorker?: boolean ; processQueuedMessages?: boolean ; registeredTypes?: RegisteredTypes ; runtimeLogLevel?: number }>

Defined in

packages/core/src/setup.ts:30

---

randomId

▸ randomId(): string

Returns

string

Defined in

packages/core/src/blockchain/head-state.ts:6

---

runTask

▸ runTask(task, callback?): Promise<{ Call: TaskCallResponse } | { Error: string }>

Parameters

Name	Type	Default value
task	Object	undefined
task.allowUnresolvedImports	boolean	undefined
task.calls	[string, `0x${string}`[]][]	undefined
task.mockSignatureHost	boolean	undefined
task.runtimeLogLevel	number	undefined
task.wasm	`0x${string}`	undefined
callback	JsCallback	emptyTaskHandler

Returns

Promise<{ Call: TaskCallResponse } | { Error: string }>

Defined in

packages/core/src/wasm-executor/index.ts:116

---

setStorage

▸ setStorage(chain, storage, blockHash?): Promise<`0x${string}`>

Parameters

Name	Type
chain	Blockchain
storage	StorageValues
blockHash?	`0x${string}`

Returns

Promise<`0x${string}`>

Defined in

packages/core/src/utils/set-storage.ts:67

---

setup

▸ setup(options): Promise<Blockchain>

Parameters

Name	Type
options	SetupOptions

Returns

Promise<Blockchain>

Defined in

packages/core/src/setup.ts:71

---

splitChildKey

▸ splitChildKey(key): [`0x${string}`, `0x${string}`] | never[]

Parameters

Name	Type
key	`0x${string}`

Returns

[`0x${string}`, `0x${string}`] | never[]

Defined in

packages/core/src/utils/index.ts:102

---

stripChildPrefix

▸ stripChildPrefix(key): `0x${string}`

Parameters

Name	Type
key	`0x${string}`

Returns

`0x${string}`

Defined in

packages/core/src/utils/index.ts:111

---

taskHandler

▸ taskHandler(block): JsCallback

Parameters

Name	Type
block	Block

Returns

JsCallback

Defined in

packages/core/src/wasm-executor/index.ts:137

---

timeTravel

▸ timeTravel(chain, timestamp): Promise<void>

Parameters

Name	Type
chain	Blockchain
timestamp	number

Returns

Promise<void>

Defined in

packages/core/src/utils/time-travel.ts:8

---

toStorageObject

▸ toStorageObject(decoded): undefined | {}

Parameters

Name	Type
decoded	undefined | { key: any[] = res.key; method: string = res.name; section: string = 'substrate'; value: AnyJson = res.value }

Returns

undefined | {}

Defined in

packages/core/src/utils/decoder.ts:98

---

truncate

▸ truncate(val): any

Parameters

Name	Type
val	any

Returns

any

Defined in

packages/core/src/logger.ts:48