common: GethGenesis interface (#3973)

* common: GethGenesis interface

* monorepo: apply gethGenesis interface throughout monorepo

* common: add pragueTime to gethGenesis

* common: fix poa adjusted test case

* common: minor improvements

* chore: remove non null assertion

* common: add typecasting note

Author: gabrocheleau

packages/blockchain/README.md

@@ -127,8 +127,8 @@ For many custom chains we might come across a genesis configuration, which can b
 // ./examples/gethGenesis.ts
 
 import { createBlockchain } from '@ethereumjs/blockchain'
-import { createCommonFromGethGenesis } from '@ethereumjs/common'
-import { bytesToHex, parseGethGenesisState } from '@ethereumjs/util'
+import { createCommonFromGethGenesis, parseGethGenesisState } from '@ethereumjs/common'
+import { bytesToHex} from '@ethereumjs/util'
 
 import { postMergeGethGenesis } from './genesisData/post-merge.ts'
 

packages/blockchain/examples/gethGenesis.ts

@@ -1,7 +1,7 @@
 import { createBlockchain } from '@ethereumjs/blockchain'
-import { createCommonFromGethGenesis } from '@ethereumjs/common'
+import { createCommonFromGethGenesis, parseGethGenesisState } from '@ethereumjs/common'
 import { postMergeGethGenesis } from '@ethereumjs/testdata'
-import { bytesToHex, parseGethGenesisState } from '@ethereumjs/util'
+import { bytesToHex } from '@ethereumjs/util'
 
 const main = async () => {
   // Load geth genesis file

packages/blockchain/src/blockchain.ts

@@ -30,14 +30,8 @@ import { DBManager } from './db/manager.ts'
 import { DBTarget } from './db/operation.ts'
 
 import type { HeaderData } from '@ethereumjs/block'
-import type { CliqueConfig } from '@ethereumjs/common'
-import type {
-  BigIntLike,
-  DB,
-  DBObject,
-  GenesisState,
-  VerkleExecutionWitness,
-} from '@ethereumjs/util'
+import type { CliqueConfig, GenesisState } from '@ethereumjs/common'
+import type { BigIntLike, DB, DBObject, VerkleExecutionWitness } from '@ethereumjs/util'
 import type { Debugger } from 'debug'
 import type {
   BlockchainEvent,

packages/blockchain/src/helpers.ts

@@ -1,8 +1,7 @@
 import { ChainGenesis } from '@ethereumjs/common'
 import { genesisMPTStateRoot } from '@ethereumjs/mpt'
-import { type GenesisState } from '@ethereumjs/util'
 
-import type { Chain, Common } from '@ethereumjs/common'
+import type { Chain, Common, GenesisState } from '@ethereumjs/common'
 
 /**
  * Safe creation of a new Blockchain object awaiting the initialization function,

packages/blockchain/src/types.ts

@@ -1,6 +1,6 @@
 import type { Block, BlockHeader } from '@ethereumjs/block'
-import type { Common, ConsensusAlgorithm } from '@ethereumjs/common'
-import type { DB, DBObject, GenesisState } from '@ethereumjs/util'
+import type { Common, ConsensusAlgorithm, GenesisState } from '@ethereumjs/common'
+import type { DB, DBObject } from '@ethereumjs/util'
 import type { EventEmitter } from 'eventemitter3'
 import type { Blockchain } from './index.ts'
 

packages/blockchain/test/utils.spec.ts

@@ -1,14 +1,18 @@
-import { createCommonFromGethGenesis } from '@ethereumjs/common'
+import {
+  type GethGenesis,
+  createCommonFromGethGenesis,
+  parseGethGenesisState,
+} from '@ethereumjs/common'
 import { genesisMPTStateRoot } from '@ethereumjs/mpt'
 import { postMergeGethGenesis } from '@ethereumjs/testdata'
-import { bytesToHex, parseGethGenesisState } from '@ethereumjs/util'
+import { bytesToHex } from '@ethereumjs/util'
 import { assert, describe, it } from 'vitest'
 
 import { createBlockchain } from '../src/index.ts'
 
 import type { Blockchain } from '../src/blockchain.ts'
 
-async function getBlockchain(gethGenesis: any): Promise<Blockchain> {
+async function getBlockchain(gethGenesis: GethGenesis): Promise<Blockchain> {
   const common = createCommonFromGethGenesis(gethGenesis, { chain: 'kiln' })
   const genesisState = parseGethGenesisState(gethGenesis)
   const blockchain = await createBlockchain({

packages/client/bin/cli.ts

@@ -19,7 +19,7 @@ import { generateClientConfig, getArgs } from './utils.ts'
 import type * as http from 'http'
 import type { Block, BlockBytes } from '@ethereumjs/block'
 import type { ConsensusDict } from '@ethereumjs/blockchain'
-import type { GenesisState } from '@ethereumjs/util'
+import type { GenesisState } from '@ethereumjs/common'
 import type { AbstractLevel } from 'abstract-level'
 import type { Server as RPCServer } from 'jayson/promise/index.js'
 import type { Config } from '../src/config.ts'

packages/client/bin/repl.ts

@@ -6,8 +6,7 @@ import { createInlineClient } from '../src/util/index.ts'
 import { startRPCServers } from './startRPC.ts'
 import { generateClientConfig, getArgs } from './utils.ts'
 
-import type { Common } from '@ethereumjs/common'
-import type { GenesisState } from '@ethereumjs/util'
+import type { Common, GenesisState } from '@ethereumjs/common'
 import type { Config } from '../src/config.ts'
 import type { EthereumClient } from '../src/index.ts'
 import type { ClientOpts } from '../src/types.ts'

packages/client/bin/utils.ts

@@ -13,6 +13,7 @@ import {
   createCommonFromGethGenesis,
   createCustomCommon,
   getPresetChainConfig,
+  parseGethGenesisState,
 } from '@ethereumjs/common'
 import {
   EthereumJSErrorWithoutCode,
@@ -24,7 +25,6 @@ import {
   createAddressFromString,
   ecrecover,
   hexToBytes,
-  parseGethGenesisState,
   randomBytes,
   setLengthLeft,
 } from '@ethereumjs/util'
@@ -52,8 +52,8 @@ import { Event } from '../src/types.ts'
 import { parseMultiaddrs } from '../src/util/index.ts'
 import { setupMetrics } from '../src/util/metrics.ts'
 
-import type { CustomCrypto } from '@ethereumjs/common'
-import type { Address, GenesisState, PrefixedHexString } from '@ethereumjs/util'
+import type { CustomCrypto, GenesisState } from '@ethereumjs/common'
+import type { Address, PrefixedHexString } from '@ethereumjs/util'
 import type { Logger } from '../src/logging.ts'
 import type { ClientOpts } from '../src/types.ts'
 

packages/client/src/blockchain/chain.ts

@@ -8,7 +8,8 @@ import { Event } from '../types.ts'
 
 import type { Block, BlockHeader } from '@ethereumjs/block'
 import type { Blockchain, ConsensusDict } from '@ethereumjs/blockchain'
-import type { DB, DBObject, GenesisState } from '@ethereumjs/util'
+import type { GenesisState } from '@ethereumjs/common'
+import type { DB, DBObject } from '@ethereumjs/util'
 import type { AbstractLevel } from 'abstract-level'
 import type { Config } from '../config.ts'