Class InMemorySerializedStates

In-memory serialized-states db.

Implements

Index

Constructors

Methods

close getState getStateRoot insertInitialState updateAndSetState

Constructors

constructor

new InMemorySerializedStates(
spec: ChainSpec,
blake2b: Blake2b,
): InMemorySerializedStates
Parameters
- spec: ChainSpec
- blake2b: Blake2b
Returns InMemorySerializedStates
- Defined in packages/jam/database/serialized-states-db.ts:28

Methods

close

close(): Promise<void>
Close the database and free resources.

Returns Promise<void>
Implementation of StatesDb.close
- Defined in packages/jam/database/serialized-states-db.ts:98

getState

getState(
header: OpaqueHash & pvm.WithOpaque<"HeaderHash">,
): SerializedState<LeafDb> | null
Retrieve posterior state of given header.
Parameters
- header: OpaqueHash & pvm.WithOpaque<"HeaderHash">
Returns SerializedState<LeafDb> | null
Implementation of StatesDb.getState
- Defined in packages/jam/database/serialized-states-db.ts:80

getStateRoot

getStateRoot(
state: SerializedState<LeafDb>,
): Promise<OpaqueHash & pvm.WithOpaque<"StateRootHash">>
Compute a state root for given state.
Parameters
- state: SerializedState<LeafDb>
Returns Promise<OpaqueHash & pvm.WithOpaque<"StateRootHash">>
Implementation of StatesDb.getStateRoot
- Defined in packages/jam/database/serialized-states-db.ts:50

insertInitialState

insertInitialState(
headerHash: OpaqueHash & pvm.WithOpaque<"HeaderHash">,
entries: StateEntries,
): Promise<pvm.Result<typeof pvm.OK, StateUpdateError>>
Insert a pre-defined initial state directly into the database.
Parameters
- headerHash: OpaqueHash & pvm.WithOpaque<"HeaderHash">
- entries: StateEntries
Returns Promise<pvm.Result<typeof pvm.OK, StateUpdateError>>
Implementation of InitStatesDb.insertInitialState
- Defined in packages/jam/database/serialized-states-db.ts:33

updateAndSetState

updateAndSetState(
    header: OpaqueHash & pvm.WithOpaque<"HeaderHash">,
    state: SerializedState<LeafDb>,
    update: Partial<State & ServicesUpdate>,
): Promise<pvm.Result<typeof pvm.OK, StateUpdateError>>
Apply & commit a state update.

NOTE: for efficiency, the implementation MAY alter given state object.
Parameters
- header: OpaqueHash & pvm.WithOpaque<"HeaderHash">
- state: SerializedState<LeafDb>
- update: Partial<State & ServicesUpdate>
Returns Promise<pvm.Result<typeof pvm.OK, StateUpdateError>>
Implementation of StatesDb.updateAndSetState
- Defined in packages/jam/database/serialized-states-db.ts:54