Class StateEntries

Full, in-memory state represented as serialized entries dictionary.

State entries may be wrapped into SerializedState to access the contained values.

Index

Properties

Methods

[iterator] [TEST_COMPARE_USING] applyUpdate get getRootHash toString fromDictionaryUnsafe fromEntriesUnsafe serializeInMemory

Properties

`Static`Codec

Codec: Descriptor<StateEntries, StateEntries> = ...

Methods

[iterator]

"[iterator]"(): Generator<[TruncatedHash, BytesBlob], any, any>
Returns Generator<[TruncatedHash, BytesBlob], any, any>
- Defined in packages/jam/state-merkleization/state-entries.ts:84

[TEST_COMPARE_USING]

"[TEST_COMPARE_USING]"(): any
When comparing, we can safely ignore trieCache and just use entries.

Returns any
- Defined in packages/jam/state-merkleization/state-entries.ts:68

applyUpdate

applyUpdate(stateEntriesUpdate: Iterable<StateEntryUpdate>): void
Modify underlying entries dictionary with given update.
Parameters
- stateEntriesUpdate: Iterable<StateEntryUpdate>
Returns void
- Defined in packages/jam/state-merkleization/state-entries.ts:94

get

get(key: OpaqueHash & pvm.WithOpaque<"stateKey">): BytesBlob | null
Retrieve value of some serialized key (if present).
Parameters
- key: OpaqueHash & pvm.WithOpaque<"stateKey">
Returns BytesBlob | null
- Defined in packages/jam/state-merkleization/state-entries.ts:89

getRootHash

getRootHash(blake2b: Blake2b): OpaqueHash & pvm.WithOpaque<"StateRootHash">
https://graypaper.fluffylabs.dev/#/68eaa1f/391600391600?v=0.6.4
Parameters
- blake2b: Blake2b
Returns OpaqueHash & pvm.WithOpaque<"StateRootHash">
- Defined in packages/jam/state-merkleization/state-entries.ts:107

toString

toString(): string
Dump state entries to JSON string (format compatible with stf vectors).

Returns string
- Defined in packages/jam/state-merkleization/state-entries.ts:73

`Static`fromDictionaryUnsafe

fromDictionaryUnsafe(
    data: TruncatedHashDictionary<
        OpaqueHash & pvm.WithOpaque<"stateKey">,
        BytesBlob,
    >,
): StateEntries
Wrap a collection of truncated state entries and treat it as state.

NOTE: There is no verification happening, so the state may be incomplete. Use only if you are sure this is all the entries needed.
Parameters
- data: TruncatedHashDictionary<OpaqueHash & pvm.WithOpaque<"stateKey">, BytesBlob>
Returns StateEntries
- Defined in packages/jam/state-merkleization/state-entries.ts:49

`Static`fromEntriesUnsafe

fromEntriesUnsafe(
    entries: Iterable<
        | [TruncatedHash | OpaqueHash & pvm.WithOpaque<"stateKey">, BytesBlob]
        | readonly [
            TruncatedHash
            | OpaqueHash & pvm.WithOpaque<"stateKey">,
            BytesBlob,
        ],
    >,
): StateEntries
Create a new serialized state from a collection of existing entries.

NOTE: There is no verification happening, so the state may be incomplete. Use only if you are sure this is all the entries needed.
Parameters
- entries: Iterable<
      | [TruncatedHash | OpaqueHash & pvm.WithOpaque<"stateKey">, BytesBlob]
      | readonly [
          TruncatedHash
          | OpaqueHash & pvm.WithOpaque<"stateKey">,
          BytesBlob,
      ],
  >
Returns StateEntries
- Defined in packages/jam/state-merkleization/state-entries.ts:59

`Static`serializeInMemory

serializeInMemory(
    spec: ChainSpec,
    blake2b: Blake2b,
    state: InMemoryState,
): StateEntries
Turn in-memory state into it's serialized form.
Parameters
- spec: ChainSpec
- blake2b: Blake2b
- state: InMemoryState
Returns StateEntries
- Defined in packages/jam/state-merkleization/state-entries.ts:39