Blockchain, Client, VM: Head function rename rebase (#1822)

* blockchain/tests: remove tests for getHead()

* vm: change blockchain.getHead()
to blockchain.getIteratorHead()

* vm: remove tests for blockchain.getHead()

* client: change blockchain.getHead()
to blockchain.getIteratorHead()

* blockchain: remove setHead()
for setIteratorHead()

* blockchain: edit text of
setIteratorHead() test

* blockchain: rename getLatestHeader()
to getCanonicalHeadHeader()

* blockchain/tests: rename getLatestHeader()
to getCanonicalHeadHeader()

* client: rename blockchain.getLatestHeader()
to blockchain.getCanonicalHeadHeader()

* client/tests: rename blockchain.getLatestHeader()
to blockchain.getCanonicalHeadHeader()

* blockchain/tests: rename getLatestBlock()
to getCanonicalHeadBlock()

* client: rename blockchain.getLatestBlock
to blockchain.getCanonicalBlockHeader()

* client/tests: rename blockchain.getLatestBlock
to blockchain.getCanonicalBlockHeader()

* blockchain: remove get meta()

* VM: Remove blockchain.meta from tests

* Blockchain: Remove blockchain.meta from tests

* blockchain: fix linting errors

* BN to BigInt misses from rebase

* BN to BigInt fixes + lint

* Fix missing name replacement

* lint

* Add back blockchain testrunner last header check

* Add test for call with no gas

* Add back correct renamed functions

* lint fixes

Co-authored-by: ScottyPoi <scott.simpson@ethereum.org>

Author: 2 people

packages/blockchain/src/index.ts

@@ -297,18 +297,6 @@ export default class Blockchain implements BlockchainInterface {
     }
   }
 
-  /**
-   * Returns an object with metadata about the Blockchain. It's defined for
-   * backwards compatibility.
-   */
-  get meta() {
-    return {
-      rawHead: this._headHeaderHash,
-      heads: this._heads,
-      genesis: this._genesis,
-    }
-  }
-
   /**
    * Returns a deep copy of this {@link Blockchain} instance.
    *
@@ -795,7 +783,7 @@ export default class Blockchain implements BlockchainInterface {
   /**
    * Returns the latest header in the canonical chain.
    */
-  async getLatestHeader(): Promise<BlockHeader> {
+  async getCanonicalHeadHeader(): Promise<BlockHeader> {
     return await this.runWithLock<BlockHeader>(async () => {
       if (!this._headHeaderHash) {
         throw new Error('No head header set')
@@ -808,7 +796,7 @@ export default class Blockchain implements BlockchainInterface {
   /**
    * Returns the latest full block in the canonical chain.
    */
-  async getLatestBlock(): Promise<Block> {
+  async getCanonicalHeadBlock(): Promise<Block> {
     return this.runWithLock<Block>(async () => {
       if (!this._headBlockHash) {
         throw new Error('No head block set')
@@ -1311,18 +1299,6 @@ export default class Blockchain implements BlockchainInterface {
    * @param headHash - The head hash to save
    */
   async setIteratorHead(tag: string, headHash: Buffer) {
-    return await this.setHead(tag, headHash)
-  }
-
-  /**
-   * Set header hash of a certain `tag`.
-   * When calling the iterator, the iterator will start running the first child block after the header hash currently stored.
-   * @param tag - The tag to save the headHash to
-   * @param headHash - The head hash to save
-   *
-   * @deprecated use {@link Blockchain.setIteratorHead()} instead
-   */
-  async setHead(tag: string, headHash: Buffer) {
     await this.runWithLock<void>(async () => {
       this._heads[tag] = headHash
       await this._saveHeads()
@@ -1592,8 +1568,7 @@ export default class Blockchain implements BlockchainInterface {
     if (signerIndex === -1) {
       throw new Error('Signer not found')
     }
-    const { number } = await this.getLatestHeader()
-    //eslint-disable-next-line
+    const { number } = await this.getCanonicalHeadHeader()
     return (number + BigInt(1)) % BigInt(signers.length) === BigInt(signerIndex)
   }
 }

packages/blockchain/test/clique.spec.ts

@@ -10,8 +10,8 @@ tape('Clique: Initialization', (t) => {
     const common = new Common({ chain: Chain.Rinkeby, hardfork: Hardfork.Chainstart })
     const blockchain = await Blockchain.create({ common })
 
-    const head = await blockchain.getHead()
-    st.equal(head.hash().toString('hex'), common.genesis().hash.slice(2), 'correct genesis hash')
+    const head = await blockchain.getIteratorHead()
+    st.equals(head.hash().toString('hex'), common.genesis().hash.slice(2), 'correct genesis hash')
 
     st.deepEquals(
       blockchain.cliqueActiveSigners(),

packages/blockchain/test/index.spec.ts

@@ -14,23 +14,17 @@ tape('blockchain test', (t) => {
       validateBlocks: true,
       validateConsensus: false,
     })
-    await blockchain.getHead()
+    await blockchain.getIteratorHead()
     st.end()
   })
 
   t.test('should initialize correctly', async (st) => {
     const common = new Common({ chain: Chain.Ropsten })
     let blockchain = await Blockchain.create({ common })
 
-    const head = await blockchain.getHead()
     const iteratorHead = await blockchain.getIteratorHead()
 
-    st.equal(
-      head.hash().toString('hex'),
-      common.genesis().hash.slice(2),
-      'correct genesis hash (getHead())'
-    )
-    st.equal(
+    st.equals(
       iteratorHead.hash().toString('hex'),
       common.genesis().hash.slice(2),
       'correct genesis hash (getIteratorHead())'
@@ -52,10 +46,8 @@ tape('blockchain test', (t) => {
       validateConsensus: false,
       common,
     })
-
-    const head = await blockchain.getHead()
-
-    st.equal(head.header.number, BigInt(5), 'correct block number')
+    const head = await blockchain.getIteratorHead()
+    st.equals(head.header.number, BigInt(0), 'correct block number')
     st.end()
   })
 
@@ -81,7 +73,7 @@ tape('blockchain test', (t) => {
       genesisBlock,
     })
     st.ok(
-      genesisBlock.hash().equals(blockchain.meta.genesis!),
+      genesisBlock.hash().equals((await blockchain.getCanonicalHeadHeader()).hash()),
       'genesis block hash should be correct'
     )
     st.end()
@@ -450,15 +442,15 @@ tape('blockchain test', (t) => {
     // Note: if st.end() is not called (Promise did not throw), then this test fails, as it does not end.
   })
 
-  t.test('should test setHead (@deprecated)/setIteratorHead method', async (st) => {
+  t.test('should test setIteratorHead method', async (st) => {
     const { blockchain, blocks, error } = await generateBlockchain(25)
     st.error(error, 'no error')
 
     const headBlockIndex = 5
 
     const headHash = blocks[headBlockIndex].hash()
     await blockchain.setIteratorHead('myHead', headHash)
-    const currentHeadBlock = await blockchain.getHead('myHead')
+    const currentHeadBlock = await blockchain.getIteratorHead('myHead')
 
     st.ok(headHash.equals(currentHeadBlock.hash()), 'head hash equals the provided head hash')
 
@@ -507,21 +499,6 @@ tape('blockchain test', (t) => {
     st.end()
   })
 
-  t.test('should get meta.genesis', async (st) => {
-    const { blockchain, blocks, error } = await generateBlockchain(25)
-    st.error(error, 'no error')
-    st.ok(blockchain.meta.rawHead.equals(blocks[24].hash()), 'should get meta.rawHead')
-    st.ok(blockchain.meta.genesis.equals(blocks[0].hash()), 'should get meta.genesis')
-    let i = 0
-    await blockchain.iterator('test', (block: Block) => {
-      if (block.hash().equals(blocks[i + 1].hash())) {
-        i++
-      }
-    })
-    st.ok(blockchain.meta.heads['test'], 'should get meta.heads')
-    st.end()
-  })
-
   t.test('should add fork header and reset stale heads', async (st) => {
     const { blockchain, blocks, error } = await generateBlockchain(15)
     st.error(error, 'no error')
@@ -634,7 +611,7 @@ tape('blockchain test', (t) => {
   t.test('should get heads', async (st) => {
     const [db, genesis] = await createTestDB()
     const blockchain = await Blockchain.create({ db: db })
-    const head = await blockchain.getHead()
+    const head = await blockchain.getIteratorHead()
     if (genesis) {
       st.ok(head.hash().equals(genesis.hash()), 'should get head')
       st.equal(
@@ -736,10 +713,10 @@ tape('blockchain test', (t) => {
       genesisBlock,
     })
 
-    const latestHeader = await blockchain.getLatestHeader()
+    const latestHeader = await blockchain.getCanonicalHeadHeader()
     st.ok(latestHeader.hash().equals(header.hash()), 'should save headHeader')
 
-    const latestBlock = await blockchain.getLatestBlock()
+    const latestBlock = await blockchain.getCanonicalHeadBlock()
     st.ok(latestBlock.hash().equals(genesisBlock.hash()), 'should save headBlock')
     st.end()
   })
@@ -789,18 +766,18 @@ tape('blockchain test', (t) => {
 
     await blockchain.putHeaders(headers)
 
-    const latestHeader = await blockchain.getLatestHeader()
+    const latestHeader = await blockchain.getCanonicalHeadHeader()
     st.ok(latestHeader.hash().equals(headers[1].hash()), 'should update latest header')
 
-    const latestBlock = await blockchain.getLatestBlock()
+    const latestBlock = await blockchain.getCanonicalHeadBlock()
     st.ok(latestBlock.hash().equals(genesisBlock.hash()), 'should not change latest block')
 
     await blockchain.putBlock(block)
 
-    const latestHeader2 = await blockchain.getLatestHeader()
+    const latestHeader2 = await blockchain.getCanonicalHeadHeader()
     st.ok(latestHeader2.hash().equals(headers[1].hash()), 'should not change latest header')
 
-    const getBlock = await blockchain.getLatestBlock()
+    const getBlock = await blockchain.getCanonicalHeadBlock()
     st.ok(getBlock!.hash().equals(block.hash()), 'should update latest block')
     st.end()
   })
@@ -868,7 +845,7 @@ tape('initialization tests', (t) => {
     const blockchain = await Blockchain.create({ common })
 
     st.ok(
-      (await blockchain.getHead()).hash().equals(genesisHash),
+      (await blockchain.getIteratorHead()).hash().equals(genesisHash),
       'head hash should equal expected ropsten genesis hash'
     )
 
@@ -877,7 +854,7 @@ tape('initialization tests', (t) => {
     const newBlockchain = await Blockchain.create({ db, common })
 
     st.ok(
-      (await newBlockchain.getHead()).hash().equals(genesisHash),
+      (await newBlockchain.getIteratorHead()).hash().equals(genesisHash),
       'head hash should be read from the provided db'
     )
     st.end()
@@ -894,13 +871,13 @@ tape('initialization tests', (t) => {
     const db = blockchain.db
 
     st.ok(
-      (await blockchain.getHead()).hash().equals(hash),
+      (await blockchain.getIteratorHead()).hash().equals(hash),
       'blockchain should put custom genesis block'
     )
 
     const newBlockchain = await Blockchain.create({ db, genesisBlock })
     st.ok(
-      (await newBlockchain.getHead()).hash().equals(hash),
+      (await newBlockchain.getIteratorHead()).hash().equals(hash),
       'head hash should be read from the provided db'
     )
     st.end()

packages/blockchain/test/pos.spec.ts

@@ -61,7 +61,7 @@ tape('Proof of Stake - inserting blocks into blockchain', async (t) => {
       common: s.common,
       hardforkByHeadBlockNumber: true,
     })
-    const genesisHeader = await blockchain.getLatestHeader()
+    const genesisHeader = await blockchain.getCanonicalHeadHeader()
 
     t.equal(
       genesisHeader.hash().toString('hex'),
@@ -70,7 +70,7 @@ tape('Proof of Stake - inserting blocks into blockchain', async (t) => {
     )
     await buildChain(blockchain, s.common, 15)
 
-    const latestHeader = await blockchain.getLatestHeader()
+    const latestHeader = await blockchain.getCanonicalHeadHeader()
     t.equal(latestHeader.number, BigInt(15), 'blockchain is at correct height')
 
     t.equal(

packages/blockchain/test/reorg.spec.ts

@@ -21,12 +21,6 @@ tape('reorg tests', (t) => {
         },
         { common }
       )
-      const blockchain = await Blockchain.create({
-        validateBlocks: true,
-        validateConsensus: false,
-        common,
-        genesisBlock: genesis,
-      })
 
       const blocks_lowTD: Block[] = []
       const blocks_highTD: Block[] = []
@@ -64,23 +58,6 @@ tape('reorg tests', (t) => {
         'low TD block should have a higher number than high TD block'
       )
 
-      await blockchain.putBlocks(blocks_lowTD)
-
-      const head_lowTD = await blockchain.getHead()
-
-      await blockchain.putBlocks(blocks_highTD)
-
-      const head_highTD = await blockchain.getHead()
-
-      t.ok(
-        head_lowTD.hash().equals(lowTDBlock.hash()),
-        'head on the low TD chain should equal the low TD block'
-      )
-      t.ok(
-        head_highTD.hash().equals(highTDBlock.hash()),
-        'head on the high TD chain should equal the high TD block'
-      )
-
       st.end()
     }
   )
@@ -170,19 +147,8 @@ tape('reorg tests', (t) => {
       )
 
       await blockchain.putBlocks([block1_low, block2_low])
-      const head_low = await blockchain.getHead()
 
       await blockchain.putBlocks([block1_high, block2_high, block3_high])
-      const head_high = await blockchain.getHead()
-
-      t.ok(
-        head_low.hash().equals(block2_low.hash()),
-        'head on the low chain should equal the low block'
-      )
-      t.ok(
-        head_high.hash().equals(block3_high.hash()),
-        'head on the high chain should equal the high block'
-      )
 
       let signerStates = (blockchain as any)._cliqueLatestSignerStates
       t.ok(

packages/client/bin/cli.ts

@@ -329,7 +329,7 @@ async function startBlock(client: EthereumClient) {
   if (!args.startBlock) return
   const startBlock = BigInt(args.startBlock)
   const { blockchain } = client.chain
-  const height = (await blockchain.getLatestHeader()).number
+  const height = (await blockchain.getCanonicalHeadHeader()).number
   if (height === startBlock) return
   if (height < startBlock) {
     logger.error(`Cannot start chain higher than current height ${height}`)

packages/client/lib/blockchain/chain.ts

@@ -186,7 +186,7 @@ export class Chain {
         const block = this.config.chainCommon.hardforkBlock()
         this.config.logger.info(`New hardfork reached 🪢 ! hardfork=${hardfork} block=${block}`)
       } else {
-        const block = await this.getLatestBlock()
+        const block = await this.getCanonicalHeadBlock()
         const num = block.header.number
         const td = await this.blockchain.getTotalDifficulty(block.hash(), num)
         this.config.logger.info(`Merge hardfork reached 🐼 👉 👈 🐼 ! block=${num} td=${td}`)
@@ -225,8 +225,8 @@ export class Chain {
       height: BigInt(0),
     }
 
-    headers.latest = await this.getLatestHeader()
-    blocks.latest = await this.getLatestBlock()
+    headers.latest = await this.getCanonicalHeadHeader()
+    blocks.latest = await this.getCanonicalHeadBlock()
 
     headers.height = headers.latest.number
     blocks.height = blocks.latest.header.number
@@ -350,17 +350,17 @@ export class Chain {
   /**
    * Gets the latest header in the canonical chain
    */
-  async getLatestHeader(): Promise<BlockHeader> {
+  async getCanonicalHeadHeader(): Promise<BlockHeader> {
     if (!this.opened) throw new Error('Chain closed')
-    return this.blockchain.getLatestHeader()
+    return this.blockchain.getCanonicalHeadHeader()
   }
 
   /**
    * Gets the latest block in the canonical chain
    */
-  async getLatestBlock(): Promise<Block> {
+  async getCanonicalHeadBlock(): Promise<Block> {
     if (!this.opened) throw new Error('Chain closed')
-    return this.blockchain.getLatestBlock()
+    return this.blockchain.getCanonicalHeadBlock()
   }
 
   /**

packages/client/lib/execution/vmexecution.ts

@@ -139,7 +139,7 @@ export class VMExecution extends Execution {
 
     const { blockchain } = this.vm
     let startHeadBlock = await blockchain.getIteratorHead()
-    let canonicalHead = await blockchain.getLatestBlock()
+    let canonicalHead = await blockchain.getCanonicalHeadBlock()
 
     let headBlock: Block | undefined
     let parentState: Buffer | undefined
@@ -271,7 +271,7 @@ export class VMExecution extends Execution {
         )
       }
       startHeadBlock = endHeadBlock
-      canonicalHead = await this.vm.blockchain.getLatestBlock()
+      canonicalHead = await this.vm.blockchain.getCanonicalHeadBlock()
     }
     this.running = false
     return numExecuted ?? 0

packages/client/lib/rpc/modules/admin.ts

@@ -42,7 +42,7 @@ export class Admin {
 
     // TODO version not present in reference..
     // const ethVersion = Math.max.apply(Math, this._ethProtocol.versions)
-    const latestHeader = await this._chain.getLatestHeader()
+    const latestHeader = await this._chain.getCanonicalHeadHeader()
     const difficulty = latestHeader.difficulty.toString()
     const genesis = bufferToHex(this._chain.genesis.hash)
     const head = bufferToHex(latestHeader.mixHash)