Interface StatesDb<T>

Interface for accessing states stored in the database.

NOTE that the design of this interface is heavily influenced by the LMDB implementation, so that we can implement it efficiently.

See the documentation there for more detailed reasoning.

interface StatesDb<T extends State = State> {
    close(): Promise<void>;
    getState(header: OpaqueHash & pvm.WithOpaque<"HeaderHash">): T | null;
    getStateRoot(
        state: T,
    ): Promise<OpaqueHash & pvm.WithOpaque<"StateRootHash">>;
    updateAndSetState(
        header: OpaqueHash & pvm.WithOpaque<"HeaderHash">,
        state: T,
        update: Partial<State & ServicesUpdate>,
    ): Promise<pvm.Result<typeof pvm.OK, StateUpdateError>>;
}

Type Parameters

T extends State = State

Implemented by

Index

Methods

close getState getStateRoot updateAndSetState

Methods

close

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

Returns Promise<void>
- Defined in packages/jam/database/states.ts:50

getState

getState(header: OpaqueHash & pvm.WithOpaque<"HeaderHash">): T | null
Retrieve posterior state of given header.
Parameters
- header: OpaqueHash & pvm.WithOpaque<"HeaderHash">
Returns T | null
- Defined in packages/jam/database/states.ts:47

getStateRoot

getStateRoot(state: T): Promise<OpaqueHash & pvm.WithOpaque<"StateRootHash">>
Compute a state root for given state.
Parameters
- state: T
Returns Promise<OpaqueHash & pvm.WithOpaque<"StateRootHash">>
- Defined in packages/jam/database/states.ts:33

updateAndSetState

updateAndSetState(
    header: OpaqueHash & pvm.WithOpaque<"HeaderHash">,
    state: T,
    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: T
- update: Partial<State & ServicesUpdate>
Returns Promise<pvm.Result<typeof pvm.OK, StateUpdateError>>
- Defined in packages/jam/database/states.ts:40