@typeberry/lib 0.5.0-5c5fc1c → 0.5.0-6a64d40

package/index.cjs

@@ -5523,6 +5523,10 @@ class TruncatedHashDictionary {
         const truncatedKey = getTruncatedKey(key);
         this.dict.delete(truncatedKey);
     }
+    /** Iterator over keys of the dictionary. */
+    keys() {
+        return this.dict.keys();
+    }
     /** Iterator over values of the dictionary. */
     values() {
         return this.dict.values();
@@ -6966,7 +6970,6 @@ class Header extends WithDebug {
     static create(h) {
         return Object.assign(Header.empty(), h);
     }
-    // TODO [ToDr] the fields should be readonly
     /**
      * `H_p`: Hash of the parent header.
      *
@@ -7145,8 +7148,7 @@ class Block extends WithDebug {
     }
 }
 function emptyBlock(slot = tryAsTimeSlot(0)) {
-    const header = Header.empty();
-    header.timeSlotIndex = slot;
+    const header = Header.create({ ...Header.empty(), timeSlotIndex: slot });
     return Block.create({
         header,
         extrinsic: Extrinsic.create({
@@ -7694,21 +7696,22 @@ const headerFromJson = json.object({
     entropy_source: bandersnatchVrfSignature,
     seal: bandersnatchVrfSignature,
 }, ({ parent, parent_state_root, extrinsic_hash, slot, epoch_mark, tickets_mark, offenders_mark, author_index, entropy_source, seal, }) => {
-    const header = Header.empty();
-    header.parentHeaderHash = parent;
-    header.priorStateRoot = parent_state_root;
-    header.extrinsicHash = extrinsic_hash;
-    header.timeSlotIndex = slot;
-    header.epochMarker = epoch_mark ?? null;
-    header.ticketsMarker =
-        tickets_mark === undefined || tickets_mark === null
-            ? null
-            : TicketsMarker.create({ tickets: asOpaqueType(tickets_mark) });
-    header.offendersMarker = offenders_mark;
-    header.bandersnatchBlockAuthorIndex = author_index;
-    header.entropySource = entropy_source;
-    header.seal = seal;
-    return header;
+    const epochMarker = epoch_mark ?? null;
+    const ticketsMarker = tickets_mark === undefined || tickets_mark === null
+        ? null
+        : TicketsMarker.create({ tickets: asOpaqueType(tickets_mark) });
+    return Header.create({
+        parentHeaderHash: parent,
+        priorStateRoot: parent_state_root,
+        extrinsicHash: extrinsic_hash,
+        timeSlotIndex: slot,
+        epochMarker,
+        ticketsMarker,
+        offendersMarker: offenders_mark,
+        bandersnatchBlockAuthorIndex: author_index,
+        entropySource: entropy_source,
+        seal,
+    });
 });
 
 const blockFromJson = (spec) => json.object({
@@ -11504,14 +11507,14 @@ const stateEntriesSequenceCodec = sequenceVarLen(pair(bytes(TRUNCATED_HASH_SIZE)
  * State entries may be wrapped into `SerializedState` to access the contained values.
  */
 class StateEntries {
-    entries;
+    dictionary;
     static Codec = custom({
         name: "StateEntries",
         sizeHint: {
             isExact: false,
             bytes: TYPICAL_STATE_ITEMS * (HASH_SIZE + TYPICAL_STATE_ITEM_LEN),
         },
-    }, (e, v) => stateEntriesSequenceCodec.encode(e, Array.from(v.entries)), (d) => StateEntries.fromEntriesUnsafe(stateEntriesSequenceCodec.decode(d)), (s) => stateEntriesSequenceCodec.skip(s));
+    }, (e, v) => stateEntriesSequenceCodec.encode(e, Array.from(v.dictionary)), (d) => StateEntries.fromEntriesUnsafe(stateEntriesSequenceCodec.decode(d)), (s) => stateEntriesSequenceCodec.skip(s));
     /** Turn in-memory state into it's serialized form. */
     static serializeInMemory(spec, blake2b, state) {
         return new StateEntries(convertInMemoryStateToDictionary(spec, blake2b, state));
@@ -11534,35 +11537,47 @@ class StateEntries {
     static fromEntriesUnsafe(entries) {
         return new StateEntries(TruncatedHashDictionary.fromEntries(entries));
     }
-    constructor(entries) {
-        this.entries = entries;
+    constructor(dictionary) {
+        this.dictionary = dictionary;
     }
     /** When comparing, we can safely ignore `trieCache` and just use entries. */
     [TEST_COMPARE_USING]() {
-        return Object.fromEntries(this.entries);
+        return Object.fromEntries(this.dictionary);
+    }
+    /** Iterator over entries */
+    entries() {
+        return this.dictionary.entries();
+    }
+    /** Iterator over entries keys */
+    *keys() {
+        yield* this.dictionary.keys();
+    }
+    /** Iterator over entries values */
+    *values() {
+        yield* this.dictionary.values();
     }
     /** Dump state entries to JSON string (format compatible with stf vectors). */
     toString() {
-        return JSON.stringify(Array.from(this.entries.entries()).map(([key, value]) => ({
+        return JSON.stringify(Array.from(this.entries()).map(([key, value]) => ({
             key,
             value,
         })), null, 2);
     }
     [Symbol.iterator]() {
-        return this.entries[Symbol.iterator]();
+        return this.dictionary[Symbol.iterator]();
     }
     /** Retrieve value of some serialized key (if present). */
     get(key) {
-        return this.entries.get(key) ?? null;
+        return this.dictionary.get(key) ?? null;
     }
     /** Modify underlying entries dictionary with given update. */
     applyUpdate(stateEntriesUpdate) {
         for (const [action, key, value] of stateEntriesUpdate) {
             if (action === StateEntryUpdateAction.Insert) {
-                this.entries.set(key, value);
+                this.dictionary.set(key, value);
             }
             else if (action === StateEntryUpdateAction.Remove) {
-                this.entries.delete(key);
+                this.dictionary.delete(key);
             }
             else {
                 assertNever(action);

package/index.d.ts

@@ -1960,6 +1960,8 @@ declare class TruncatedHashDictionary<T extends OpaqueHash, V> {
     set(key: T | TruncatedHash, value: V): void;
     /** Remove a value that matches the key on `TRUNCATED_HASH_SIZE`. */
     delete(key: T | TruncatedHash): void;
+    /** Iterator over keys of the dictionary. */
+    keys(): Iterator<TruncatedHash, any, any> & Iterable<TruncatedHash>;
     /** Iterator over values of the dictionary. */
     values(): Iterator<V, any, any> & Iterable<V>;
     /** Iterator over entries of the dictionary (with truncated keys) */
@@ -2767,35 +2769,35 @@ declare class Header extends WithDebug {
      *
      * In case of the genesis block, the hash will be zero.
      */
-    parentHeaderHash: HeaderHash;
+    readonly parentHeaderHash: HeaderHash;
     /** `H_r`: The state trie root hash before executing that block. */
-    priorStateRoot: StateRootHash;
+    readonly priorStateRoot: StateRootHash;
     /** `H_x`: The hash of block extrinsic. */
-    extrinsicHash: ExtrinsicHash;
+    readonly extrinsicHash: ExtrinsicHash;
     /** `H_t`: JAM time-slot index. */
-    timeSlotIndex: TimeSlot;
+    readonly timeSlotIndex: TimeSlot;
     /**
      * `H_e`: Key and entropy relevant to the following epoch in case the ticket
      *        contest does not complete adequately.
      */
-    epochMarker: EpochMarker | null;
+    readonly epochMarker: EpochMarker | null;
     /**
      * `H_w`: Winning tickets provides the series of 600 slot sealing "tickets"
      *        for the next epoch.
      */
-    ticketsMarker: TicketsMarker | null;
+    readonly ticketsMarker: TicketsMarker | null;
     /** `H_i`: Block author's index in the current validator set. */
-    bandersnatchBlockAuthorIndex: ValidatorIndex;
+    readonly bandersnatchBlockAuthorIndex: ValidatorIndex;
     /** `H_v`: Entropy-yielding VRF signature. */
-    entropySource: BandersnatchVrfSignature;
+    readonly entropySource: BandersnatchVrfSignature;
     /** `H_o`: Sequence of keys of newly misbehaving validators. */
-    offendersMarker: Ed25519Key[];
+    readonly offendersMarker: Ed25519Key[];
     /**
      * `H_s`: Block seal.
      *
      * https://graypaper.fluffylabs.dev/#/579bd12/0d0c010d1101
      */
-    seal: BandersnatchVrfSignature;
+    readonly seal: BandersnatchVrfSignature;
     private constructor();
     /** Create an empty header with some dummy values. */
     static empty(): Header;
@@ -6237,7 +6239,7 @@ declare function serializeStateUpdate(spec: ChainSpec, blake2b: Blake2b, update:
  * State entries may be wrapped into `SerializedState` to access the contained values.
  */
 declare class StateEntries {
-    private readonly entries;
+    private readonly dictionary;
     static Codec: Descriptor<StateEntries, StateEntries>;
     /** Turn in-memory state into it's serialized form. */
     static serializeInMemory(spec: ChainSpec, blake2b: Blake2b, state: InMemoryState): StateEntries;
@@ -6258,6 +6260,12 @@ declare class StateEntries {
     private constructor();
     /** When comparing, we can safely ignore `trieCache` and just use entries. */
     [TEST_COMPARE_USING](): any;
+    /** Iterator over entries */
+    entries(): Generator<[TruncatedHash, BytesBlob]>;
+    /** Iterator over entries keys */
+    keys(): Generator<TruncatedHash>;
+    /** Iterator over entries values */
+    values(): Generator<BytesBlob>;
     /** Dump state entries to JSON string (format compatible with stf vectors). */
     toString(): string;
     [Symbol.iterator](): Generator<[TruncatedHash, BytesBlob], any, any>;

package/index.js

@@ -5520,6 +5520,10 @@ class TruncatedHashDictionary {
         const truncatedKey = getTruncatedKey(key);
         this.dict.delete(truncatedKey);
     }
+    /** Iterator over keys of the dictionary. */
+    keys() {
+        return this.dict.keys();
+    }
     /** Iterator over values of the dictionary. */
     values() {
         return this.dict.values();
@@ -6963,7 +6967,6 @@ class Header extends WithDebug {
     static create(h) {
         return Object.assign(Header.empty(), h);
     }
-    // TODO [ToDr] the fields should be readonly
     /**
      * `H_p`: Hash of the parent header.
      *
@@ -7142,8 +7145,7 @@ class Block extends WithDebug {
     }
 }
 function emptyBlock(slot = tryAsTimeSlot(0)) {
-    const header = Header.empty();
-    header.timeSlotIndex = slot;
+    const header = Header.create({ ...Header.empty(), timeSlotIndex: slot });
     return Block.create({
         header,
         extrinsic: Extrinsic.create({
@@ -7691,21 +7693,22 @@ const headerFromJson = json.object({
     entropy_source: bandersnatchVrfSignature,
     seal: bandersnatchVrfSignature,
 }, ({ parent, parent_state_root, extrinsic_hash, slot, epoch_mark, tickets_mark, offenders_mark, author_index, entropy_source, seal, }) => {
-    const header = Header.empty();
-    header.parentHeaderHash = parent;
-    header.priorStateRoot = parent_state_root;
-    header.extrinsicHash = extrinsic_hash;
-    header.timeSlotIndex = slot;
-    header.epochMarker = epoch_mark ?? null;
-    header.ticketsMarker =
-        tickets_mark === undefined || tickets_mark === null
-            ? null
-            : TicketsMarker.create({ tickets: asOpaqueType(tickets_mark) });
-    header.offendersMarker = offenders_mark;
-    header.bandersnatchBlockAuthorIndex = author_index;
-    header.entropySource = entropy_source;
-    header.seal = seal;
-    return header;
+    const epochMarker = epoch_mark ?? null;
+    const ticketsMarker = tickets_mark === undefined || tickets_mark === null
+        ? null
+        : TicketsMarker.create({ tickets: asOpaqueType(tickets_mark) });
+    return Header.create({
+        parentHeaderHash: parent,
+        priorStateRoot: parent_state_root,
+        extrinsicHash: extrinsic_hash,
+        timeSlotIndex: slot,
+        epochMarker,
+        ticketsMarker,
+        offendersMarker: offenders_mark,
+        bandersnatchBlockAuthorIndex: author_index,
+        entropySource: entropy_source,
+        seal,
+    });
 });
 
 const blockFromJson = (spec) => json.object({
@@ -11501,14 +11504,14 @@ const stateEntriesSequenceCodec = sequenceVarLen(pair(bytes(TRUNCATED_HASH_SIZE)
  * State entries may be wrapped into `SerializedState` to access the contained values.
  */
 class StateEntries {
-    entries;
+    dictionary;
     static Codec = custom({
         name: "StateEntries",
         sizeHint: {
             isExact: false,
             bytes: TYPICAL_STATE_ITEMS * (HASH_SIZE + TYPICAL_STATE_ITEM_LEN),
         },
-    }, (e, v) => stateEntriesSequenceCodec.encode(e, Array.from(v.entries)), (d) => StateEntries.fromEntriesUnsafe(stateEntriesSequenceCodec.decode(d)), (s) => stateEntriesSequenceCodec.skip(s));
+    }, (e, v) => stateEntriesSequenceCodec.encode(e, Array.from(v.dictionary)), (d) => StateEntries.fromEntriesUnsafe(stateEntriesSequenceCodec.decode(d)), (s) => stateEntriesSequenceCodec.skip(s));
     /** Turn in-memory state into it's serialized form. */
     static serializeInMemory(spec, blake2b, state) {
         return new StateEntries(convertInMemoryStateToDictionary(spec, blake2b, state));
@@ -11531,35 +11534,47 @@ class StateEntries {
     static fromEntriesUnsafe(entries) {
         return new StateEntries(TruncatedHashDictionary.fromEntries(entries));
     }
-    constructor(entries) {
-        this.entries = entries;
+    constructor(dictionary) {
+        this.dictionary = dictionary;
     }
     /** When comparing, we can safely ignore `trieCache` and just use entries. */
     [TEST_COMPARE_USING]() {
-        return Object.fromEntries(this.entries);
+        return Object.fromEntries(this.dictionary);
+    }
+    /** Iterator over entries */
+    entries() {
+        return this.dictionary.entries();
+    }
+    /** Iterator over entries keys */
+    *keys() {
+        yield* this.dictionary.keys();
+    }
+    /** Iterator over entries values */
+    *values() {
+        yield* this.dictionary.values();
     }
     /** Dump state entries to JSON string (format compatible with stf vectors). */
     toString() {
-        return JSON.stringify(Array.from(this.entries.entries()).map(([key, value]) => ({
+        return JSON.stringify(Array.from(this.entries()).map(([key, value]) => ({
             key,
             value,
         })), null, 2);
     }
     [Symbol.iterator]() {
-        return this.entries[Symbol.iterator]();
+        return this.dictionary[Symbol.iterator]();
     }
     /** Retrieve value of some serialized key (if present). */
     get(key) {
-        return this.entries.get(key) ?? null;
+        return this.dictionary.get(key) ?? null;
     }
     /** Modify underlying entries dictionary with given update. */
     applyUpdate(stateEntriesUpdate) {
         for (const [action, key, value] of stateEntriesUpdate) {
             if (action === StateEntryUpdateAction.Insert) {
-                this.entries.set(key, value);
+                this.dictionary.set(key, value);
             }
             else if (action === StateEntryUpdateAction.Remove) {
-                this.entries.delete(key);
+                this.dictionary.delete(key);
             }
             else {
                 assertNever(action);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typeberry/lib",
-  "version": "0.5.0-5c5fc1c",
+  "version": "0.5.0-6a64d40",
   "main": "index.js",
   "author": "Fluffy Labs",
   "license": "MPL-2.0",