Add last_committed_validators field to the Header

Modules require information about the committed validators of last
block.

Author: HoOngEe

coordinator/src/header.rs

@@ -28,17 +28,27 @@ pub struct Header {
     number: u64,
     /// Block author.
     author: Public,
+    /// Validators who submitted tendermint Commit for last block.
+    last_committed_validators: Vec<Public>,
     /// Block extra data.
     extra_data: Bytes,
 }
 
 impl Header {
-    pub fn new(parent_hash: BlockHash, timestamp: u64, number: u64, author: Public, extra_data: Bytes) -> Self {
+    pub fn new(
+        parent_hash: BlockHash,
+        timestamp: u64,
+        number: u64,
+        author: Public,
+        last_committed_validators: Vec<Public>,
+        extra_data: Bytes,
+    ) -> Self {
         Self {
             parent_hash,
             timestamp,
             number,
             author,
+            last_committed_validators,
             extra_data,
         }
     }

core/src/encoded.rs

@@ -69,7 +69,14 @@ impl Header {
 
     pub fn into_simplified(self) -> coordinator::Header {
         let view = self.view();
-        coordinator::Header::new(view.parent_hash(), view.timestamp(), view.number(), view.author(), view.extra_data())
+        coordinator::Header::new(
+            view.parent_hash(),
+            view.timestamp(),
+            view.number(),
+            view.author(),
+            view.last_committed_validators(),
+            view.extra_data(),
+        )
     }
 }
 
@@ -120,6 +127,10 @@ impl Header {
         self.view().timestamp()
     }
 
+    pub fn last_committed_validators(&self) -> Vec<Public> {
+        self.view().last_committed_validators()
+    }
+
     /// Block extra data.
     pub fn extra_data(&self) -> Vec<u8> {
         self.view().extra_data()

core/src/views/header.rs

@@ -90,14 +90,18 @@ impl<'a> HeaderView<'a> {
         self.rlp.val_at(7).unwrap()
     }
 
+    pub fn last_committed_validators(&self) -> Vec<Public> {
+        self.rlp.list_at(8).unwrap()
+    }
+
     /// Returns block extra data.
     pub fn extra_data(&self) -> Bytes {
-        self.rlp.val_at(8).unwrap()
+        self.rlp.val_at(9).unwrap()
     }
 
     /// Returns a vector of post-RLP-encoded seal fields.
     pub fn seal(&self) -> Vec<Bytes> {
-        const SIZE_WITHOUT_SEAL: usize = 9;
+        const SIZE_WITHOUT_SEAL: usize = 10;
 
         let item_count = self.rlp.item_count().unwrap();
         let mut seal = Vec::with_capacity(item_count - SIZE_WITHOUT_SEAL);

test/src/e2e.long/invalidBlockPropagation.helper.ts

@@ -57,6 +57,7 @@ async function setup(): Promise<[Header, Block, Header]> {
         new U256(block0.timestamp),
         new U256(block0.number),
         authorPaddress.pubkey,
+        [], // lastCommittedValidators
         Buffer.from(block0.extraData),
         BLAKE_NULL_RLP,
         new H256(block0.transactionsRoot),
@@ -70,6 +71,7 @@ async function setup(): Promise<[Header, Block, Header]> {
         new U256(block1.timestamp),
         new U256(block1.number),
         author1.pubkey,
+        [], // lastCommittedValidators
         Buffer.from(block1.extraData),
         BLAKE_NULL_RLP,
         new H256(block1.transactionsRoot),
@@ -83,6 +85,7 @@ async function setup(): Promise<[Header, Block, Header]> {
         new U256(block2.timestamp),
         new U256(block2.number),
         author3.pubkey,
+        [], // lastCommittedValidators
         Buffer.from(block2.extraData),
         BLAKE_NULL_RLP,
         new H256(block2.transactionsRoot),
@@ -147,6 +150,7 @@ async function testBody(
         new U256(block1.timestamp),
         new U256(block1.number),
         author4.pubkey,
+        [], // lastCommittedValidators
         Buffer.from(block1.extraData),
         BLAKE_NULL_RLP,
         new H256(block1.transactionsRoot),

test/src/e2e.long/onChainBlockValid.test.ts

@@ -64,6 +64,7 @@ describe("Test onChain block communication", async function() {
             new U256(genesisBlock.timestamp),
             new U256(genesisBlock.number),
             author1PlatformAddr.pubkey,
+            [], // lastCommittedValidators
             Buffer.from(genesisBlock.extraData),
             BLAKE_NULL_RLP,
             new H256(genesisBlock.transactionsRoot),
@@ -77,6 +78,7 @@ describe("Test onChain block communication", async function() {
             new U256(block1.timestamp),
             new U256(block1.number),
             author2PlatformAddr.pubkey,
+            [], // lastCommittedValidators
             Buffer.from(block1.extraData),
             BLAKE_NULL_RLP,
             new H256(block1.transactionsRoot),
@@ -90,6 +92,7 @@ describe("Test onChain block communication", async function() {
             new U256(block2.timestamp),
             new U256(block2.number),
             author3PlatformAddr.pubkey,
+            [], // lastCommittedValidators
             Buffer.from(block2.extraData),
             BLAKE_NULL_RLP,
             new H256(block2.transactionsRoot),

test/src/e2e.long/onChainHeaderValid.test.ts

@@ -153,6 +153,7 @@ describe("Test onChain header communication", async function() {
             new U256(genesisBlock.timestamp),
             new U256(genesisBlock.number),
             author1PlatformAddr.pubkey,
+            [], // lastCommittedValidators
             Buffer.from(genesisBlock.extraData),
             BLAKE_NULL_RLP,
             new H256(genesisBlock.transactionsRoot),
@@ -166,6 +167,7 @@ describe("Test onChain header communication", async function() {
             new U256(block1.timestamp),
             new U256(block1.number),
             author2PlatformAddr.pubkey,
+            [], // lastCommittedValidators
             Buffer.from(block1.extraData),
             BLAKE_NULL_RLP,
             new H256(block1.transactionsRoot),
@@ -179,6 +181,7 @@ describe("Test onChain header communication", async function() {
             new U256(block2.timestamp),
             new U256(block2.number),
             author3PlatformAddr.pubkey,
+            [], // lastCommittedValidators
             Buffer.from(block2.extraData),
             BLAKE_NULL_RLP,
             new H256(block2.transactionsRoot),
@@ -192,6 +195,7 @@ describe("Test onChain header communication", async function() {
             new U256(block3.timestamp),
             new U256(block3.number),
             author4PlatformAddr.pubkey,
+            [], // lastCommittedValidators
             Buffer.from(block3.extraData),
             BLAKE_NULL_RLP,
             new H256(block3.transactionsRoot),

test/src/helper/mock/cHeader.ts

@@ -32,14 +32,16 @@ export class Header {
         const nextValidatorSetHash = new H256(decodedmsg[5].toString("hex"));
         const number = new U256(parseInt(decodedmsg[6].toString("hex"), 16));
         const timestamp = new U256(parseInt(decodedmsg[7].toString("hex"), 16));
-        const extraData = decodedmsg[8];
+        const lastCommittedValidators: string[] = decodedmsg[8];
+        const extraData = decodedmsg[9];
 
         // Be careful of the order! Three roots have same types, so mistake on the order will not be catched by typechecker.
         const header = new Header(
             parentHash,
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             evidencesRoot,
             transactionsRoot,
@@ -65,6 +67,7 @@ export class Header {
             new H256(
                 "0000000000000000000000000000000000000000000000000000000000000000"
             ),
+            [],
             Buffer.alloc(0),
             BLAKE_NULL_RLP,
             BLAKE_NULL_RLP,
@@ -78,6 +81,7 @@ export class Header {
     private timestamp: U256;
     private number: U256;
     private author: H256;
+    private lastCommittedValidators: string[];
     private extraData: Buffer;
     private evidencesRoot: H256;
     private transactionsRoot: H256;
@@ -92,6 +96,7 @@ export class Header {
         timestamp: U256,
         number: U256,
         author: H256,
+        lastCommittedValidators: string[],
         extraData: Buffer,
         evidencesRoot: H256,
         transactionsRoot: H256,
@@ -105,6 +110,7 @@ export class Header {
         this.timestamp = timestamp;
         this.number = number;
         this.author = author;
+        this.lastCommittedValidators = lastCommittedValidators;
         this.extraData = extraData;
         this.evidencesRoot = evidencesRoot;
         this.transactionsRoot = transactionsRoot;
@@ -177,6 +183,7 @@ export class Header {
             this.nextValidatorSetHash.toEncodeObject(),
             this.number.toEncodeObject(),
             this.timestamp.toEncodeObject(),
+            this.lastCommittedValidators,
             this.extraData
         ].concat(this.seal);
     }

test/src/helper/mock/index.ts

@@ -384,6 +384,7 @@ export class Mock {
         const author = new H256(
             "0000000000000000000000000000000000000000000000000000000000000000"
         );
+        const lastCommittedValidators: string[] = [];
         const extraData = Buffer.from([
             23,
             108,
@@ -436,6 +437,7 @@ export class Mock {
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             transactionsRoot,
             evidencesRoot,
@@ -454,6 +456,7 @@ export class Mock {
         const author = new H256(
             "7777777777777777777777777777777777777777777777777777777777777777"
         );
+        const lastCommittedValidators: string[] = [];
         const extraData = Buffer.alloc(0);
         const transactionsRoot = new H256(
             "45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0"
@@ -473,6 +476,7 @@ export class Mock {
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             transactionsRoot,
             evidencesRoot,
@@ -491,6 +495,7 @@ export class Mock {
         const author = new H256(
             "6666666666666666666666666666666666666666666666666666666666666666"
         );
+        const lastCommittedValidators: string[] = [];
         const extraData = Buffer.alloc(0);
         const transactionsRoot = new H256(
             "45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0"
@@ -510,6 +515,7 @@ export class Mock {
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             evidencesRoot,
             transactionsRoot,

test/src/helper/mock/test/header.test.ts

@@ -16,7 +16,7 @@ describe("Check Header RLP encoding", function() {
         const header = Header.default();
         // Find the empty header's rlp encoded data in the unit test in header.rs file
         expect(header.rlpBytes().toString("hex")).deep.equal(
-            "f8c9a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0808080"
+            "f8caa00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c08080c080"
         );
     });
 
@@ -39,7 +39,7 @@ describe("Check Header RLP encoding", function() {
         header.setSeal([0, 0, [Buffer.from(signature, "hex")], bitset]);
         // Find the header's rlp encoded data in the unit test in the tendermint/mod.rs file
         expect(header.rlpBytes().toString("hex")).deep.equal(
-            "f90175a00000000000000000000000000000000000000000000000000000000000000000a03b21399e52ae4d7582032df537c00eaa3f4611210b3305ce48ac5407cd8f91bfa045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c00480808080f842b8404752ae46a97e2e4ff11b8212b85610f81ae63c5b541cc5f1e89238150c122be650b9abc954bab919de4be9a2f1dba992e88b9aa5596d2bdf2645597163697d07b86404000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
+            "f90176a00000000000000000000000000000000000000000000000000000000000000000a03b21399e52ae4d7582032df537c00eaa3f4611210b3305ce48ac5407cd8f91bfa045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0a045b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c00480c0808080f842b8404752ae46a97e2e4ff11b8212b85610f81ae63c5b541cc5f1e89238150c122be650b9abc954bab919de4be9a2f1dba992e88b9aa5596d2bdf2645597163697d07b86404000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
         );
     });
 

test/src/sdk/core/Block.ts

@@ -11,6 +11,7 @@ export interface BlockData {
     timestamp: number;
     number: number;
     author: Address;
+    lastCommittedValidators: string[];
     extraData: number[];
     transactionsRoot: H256;
     stateRoot: H256;
@@ -24,6 +25,7 @@ export interface BlockJSON {
     timestamp: number;
     number: number;
     author: string;
+    lastCommittedValidators: string[];
     extraData: number[];
     transactionsRoot: string;
     stateRoot: string;
@@ -42,6 +44,7 @@ export class Block {
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             transactionsRoot,
             stateRoot,
@@ -55,6 +58,7 @@ export class Block {
             timestamp,
             number,
             author: Address.fromString(author),
+            lastCommittedValidators,
             extraData,
             transactionsRoot: new H256(transactionsRoot),
             stateRoot: new H256(stateRoot),
@@ -68,6 +72,7 @@ export class Block {
     public timestamp: number;
     public number: number;
     public author: Address;
+    public lastCommittedValidators: string[];
     public extraData: number[];
     public transactionsRoot: H256;
     public stateRoot: H256;
@@ -82,6 +87,7 @@ export class Block {
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             transactionsRoot,
             stateRoot,
@@ -94,6 +100,7 @@ export class Block {
         this.timestamp = timestamp;
         this.number = number;
         this.author = author;
+        this.lastCommittedValidators = lastCommittedValidators;
         this.extraData = extraData;
         this.transactionsRoot = transactionsRoot;
         this.stateRoot = stateRoot;
@@ -109,6 +116,7 @@ export class Block {
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             transactionsRoot,
             stateRoot,
@@ -122,6 +130,7 @@ export class Block {
             timestamp,
             number,
             author: author.toString(),
+            lastCommittedValidators: [...lastCommittedValidators],
             extraData: [...extraData],
             transactionsRoot: transactionsRoot.toJSON(),
             stateRoot: stateRoot.toJSON(),
@@ -138,6 +147,7 @@ export class Block {
             timestamp,
             number,
             author,
+            lastCommittedValidators,
             extraData,
             transactionsRoot,
             stateRoot,
@@ -154,6 +164,7 @@ export class Block {
         blockHeader.push(nextValidatorSetHash.toEncodeObject());
         blockHeader.push(number);
         blockHeader.push(timestamp);
+        blockHeader.push(lastCommittedValidators);
         blockHeader.push(`0x${Buffer.from(extraData).toString("hex")}`);
         blockHeader.push(
             ...seal.map(s => `0x${Buffer.from(s).toString("hex")}`)