README.md

@ethereumjs/common

@ethereumjs/common

Table of contents

Enumerations

• Chain
• ConsensusAlgorithm
• ConsensusType
• CustomChain
• Hardfork

Classes

• Common

Interfaces

• BootstrapNodeConfig
• ChainConfig
• ChainName
• ChainsConfig
• CommonOpts
• CustomCommonOpts
• CustomCrypto
• EVMStateManagerInterface
• GenesisBlockConfig
• GethConfigOpts
• HardforkByOpts
• HardforkTransitionConfig
• StateManagerInterface
• StorageDump
• StorageRange

Type Aliases

• AccessList
• AccessListBytes
• AccessListBytesItem
• AccessListItem
• AccountFields
• CasperConfig
• CliqueConfig
• EIPConfig
• EIPOrHFConfig
• EthashConfig
• HardforkConfig
• HardforksDict
• Proof
• StorageProof

Variables

• ChainGenesis

Functions

• parseGethGenesis

Type Aliases

AccessList

Ƭ AccessList: AccessListItem[]

Defined in

interfaces.ts:66

---

AccessListBytes

Ƭ AccessListBytes: AccessListBytesItem[]

Defined in

interfaces.ts:65

---

AccessListBytesItem

Ƭ AccessListBytesItem: [Uint8Array, Uint8Array[]]

Defined in

interfaces.ts:64

---

AccessListItem

Ƭ AccessListItem: Object

Type declaration

Name	Type
address	PrefixedHexString
storageKeys	PrefixedHexString[]

Defined in

interfaces.ts:56

---

AccountFields

Ƭ AccountFields: Partial<Pick<Account, "nonce" | "balance" | "storageRoot" | "codeHash">>

Defined in

interfaces.ts:34

---

CasperConfig

Ƭ CasperConfig: Object

Defined in

types.ts:18

---

CliqueConfig

Ƭ CliqueConfig: Object

Type declaration

Name	Type
epoch	number
period	number

Defined in

types.ts:11

---

EIPConfig

Ƭ EIPConfig: { minimumHardfork: Hardfork ; requiredEIPs: number[] } & EIPOrHFConfig

Defined in

types.ts:188

---

EIPOrHFConfig

Ƭ EIPOrHFConfig: Object

Type declaration

Name	Type
comment	string
gasConfig?	{ [key: string]: ParamDict; }
gasPrices?	{ [key: string]: ParamDict; }
pow?	{ [key: string]: ParamDict; }
sharding?	{ [key: string]: ParamDict; }
status	string
url	string
vm?	{ [key: string]: ParamDict; }

Defined in

types.ts:167

---

EthashConfig

Ƭ EthashConfig: Object

Defined in

types.ts:16

---

HardforkConfig

Ƭ HardforkConfig: { consensus?: ConsensusConfig ; eips?: number[] ; name: string } & EIPOrHFConfig

Defined in

types.ts:193

---

HardforksDict

Ƭ HardforksDict: Object

Index signature

▪ [key: string]: HardforkConfig

Defined in

types.ts:199

---

Proof

Ƭ Proof: Object

Type declaration

Name	Type
accountProof	PrefixedHexString[]
address	PrefixedHexString
balance	PrefixedHexString
codeHash	PrefixedHexString
nonce	PrefixedHexString
storageHash	PrefixedHexString
storageProof	StorageProof[]

Defined in

interfaces.ts:42

---

StorageProof

Ƭ StorageProof: Object

Type declaration

Name	Type
key	PrefixedHexString
proof	PrefixedHexString[]
value	PrefixedHexString

Defined in

interfaces.ts:36

Variables

ChainGenesis

• Const ChainGenesis: Record<Chain, GenesisState>

GenesisState info about well known ethereum chains

Defined in

enums.ts:26

Functions

parseGethGenesis

▸ parseGethGenesis(json, name?, mergeForkIdPostMerge?): Object

Parses a genesis.json exported from Geth into parameters for Common instance

Parameters

Name	Type	Description
json	any	representing the Geth genesis file
name?	string	optional chain name
mergeForkIdPostMerge?	boolean	-

Returns

Object

parsed params

Name	Type
bootstrapNodes	never[]
chainId	number
consensus	{ algorithm: string = 'clique'; clique: { epoch: any ; period: any } ; ethash: undefined = {}; type: string = 'poa' } | { algorithm: string = 'ethash'; clique: undefined ; ethash: {} = {}; type: string = 'pow' }
genesis	{ baseFeePerGas: string ; coinbase: string ; difficulty: string ; excessBlobGas: string ; extraData: string ; gasLimit: string ; mixHash: string ; nonce: string ; timestamp: string }
genesis.baseFeePerGas	string
genesis.coinbase	string
genesis.difficulty	string
genesis.excessBlobGas	string
genesis.extraData	string
genesis.gasLimit	string
genesis.mixHash	string
genesis.nonce	string
genesis.timestamp	string
hardfork	undefined | string
hardforks	ConfigHardfork[]
name	string
networkId	number

Defined in

utils.ts:209