ethereumjs-monorepo

@ethereumjs/client

---

@ethereumjs/client / Config

Class: Config

Defined in: config.ts:342

Constructors

Constructor

new Config(options): Config

Defined in: config.ts:463

Parameters

options

ConfigOptions = {}

Returns

Config

Properties

accountCache

readonly accountCache: number

Defined in: config.ts:411

---

accounts

readonly accounts: [Address, Uint8Array<ArrayBufferLike>][]

Defined in: config.ts:420

---

blobsAndProofsCacheBlocks

readonly blobsAndProofsCacheBlocks: number

Defined in: config.ts:445

---

bootnodes?

readonly optional bootnodes: Multiaddr[]

Defined in: config.ts:397

---

chainCommon

readonly chainCommon: Common

Defined in: config.ts:456

---

codeCache

readonly codeCache: number

Defined in: config.ts:413

---

datadir

readonly datadir: string

Defined in: config.ts:395

---

debugCode

readonly debugCode: boolean

Defined in: config.ts:415

---

discDns

readonly discDns: boolean

Defined in: config.ts:416

---

discV4

readonly discV4: boolean

Defined in: config.ts:417

---

dnsAddr

readonly dnsAddr: string

Defined in: config.ts:408

---

enableSnapSync

readonly enableSnapSync: boolean

Defined in: config.ts:441

---

engineNewpayloadMaxExecute

readonly engineNewpayloadMaxExecute: number

Defined in: config.ts:434

---

engineNewpayloadMaxTxsExecute

readonly engineNewpayloadMaxTxsExecute: number

Defined in: config.ts:435

---

engineParentLookupMaxDepth

readonly engineParentLookupMaxDepth: number

Defined in: config.ts:433

---

events

readonly events: EventEmitter<EventParams>

Defined in: config.ts:347

Central event bus for events emitted by the different components of the client

---

execCommon

readonly execCommon: Common

Defined in: config.ts:457

---

execution

readonly execution: boolean

Defined in: config.ts:409

---

extIP?

readonly optional extIP: string

Defined in: config.ts:399

---

isSingleNode

readonly isSingleNode: boolean

Defined in: config.ts:419

---

key

readonly key: Uint8Array

Defined in: config.ts:396

---

lastSyncDate

lastSyncDate: number

Defined in: config.ts:450

lastSyncDate in ms

---

lastSynchronized?

optional lastSynchronized: boolean

Defined in: config.ts:448

---

logger

readonly logger: Logger | undefined

Defined in: config.ts:392

---

maxAccountRange

readonly maxAccountRange: bigint

Defined in: config.ts:428

---

maxFetcherJobs

readonly maxFetcherJobs: number

Defined in: config.ts:404

---

maxFetcherRequests

readonly maxFetcherRequests: number

Defined in: config.ts:405

---

maxInvalidBlocksErrorCache

readonly maxInvalidBlocksErrorCache: number

Defined in: config.ts:430

---

maxPeers

readonly maxPeers: number

Defined in: config.ts:407

---

maxPerRequest

readonly maxPerRequest: number

Defined in: config.ts:403

---

maxRangeBytes

readonly maxRangeBytes: number

Defined in: config.ts:427

---

maxStorageRange

readonly maxStorageRange: bigint

Defined in: config.ts:429

---

metrics

readonly metrics: PrometheusMetrics | undefined

Defined in: config.ts:461

---

mine

readonly mine: boolean

Defined in: config.ts:418

---

minerCoinbase?

readonly optional minerCoinbase: Address

Defined in: config.ts:421

---

minPeers

readonly minPeers: number

Defined in: config.ts:406

---

multiaddrs?

readonly optional multiaddrs: Multiaddr[]

Defined in: config.ts:400

---

numBlocksPerIteration

readonly numBlocksPerIteration: number

Defined in: config.ts:410

---

port?

readonly optional port: number

Defined in: config.ts:398

---

prefixStorageTrieKeys

readonly prefixStorageTrieKeys: boolean

Defined in: config.ts:439

---

pruneEngineCache

readonly pruneEngineCache: boolean

Defined in: config.ts:431

---

safeReorgDistance

readonly safeReorgDistance: number

Defined in: config.ts:424

---

savePreimages

readonly savePreimages: boolean

Defined in: config.ts:443

---

saveReceipts

readonly saveReceipts: boolean

Defined in: config.ts:401

---

server

readonly server: RlpxServer | undefined = undefined

Defined in: config.ts:459

---

shutdown

shutdown: boolean = false

Defined in: config.ts:454

Client is in the process of shutting down

---

skeletonFillCanonicalBackStep

readonly skeletonFillCanonicalBackStep: number

Defined in: config.ts:425

---

skeletonSubchainMergeMinimum

readonly skeletonSubchainMergeMinimum: number

Defined in: config.ts:426

---

snapAvailabilityDepth

readonly snapAvailabilityDepth: bigint

Defined in: config.ts:436

---

snapTransitionSafeDepth

readonly snapTransitionSafeDepth: bigint

Defined in: config.ts:437

---

storageCache

readonly storageCache: number

Defined in: config.ts:412

---

syncedStateRemovalPeriod

readonly syncedStateRemovalPeriod: number

Defined in: config.ts:432

---

synchronized

synchronized: boolean

Defined in: config.ts:447

---

syncmode

readonly syncmode: SyncMode

Defined in: config.ts:393

---

syncTargetHeight?

optional syncTargetHeight: bigint

Defined in: config.ts:452

Best known block height

---

trieCache

readonly trieCache: number

Defined in: config.ts:414

---

txLookupLimit

readonly txLookupLimit: number

Defined in: config.ts:402

---

useStringValueTrieDB

readonly useStringValueTrieDB: boolean

Defined in: config.ts:442

---

vm?

readonly optional vm: VM

Defined in: config.ts:394

---

vmProfilerOpts?

readonly optional vmProfilerOpts: VMProfilerOpts

Defined in: config.ts:422

---

ACCOUNT_CACHE

readonly static ACCOUNT_CACHE: 400000 = 400000

Defined in: config.ts:361

---

BLOBS_AND_PROOFS_CACHE_BLOCKS

readonly static BLOBS_AND_PROOFS_CACHE_BLOCKS: 32 = 32

Defined in: config.ts:390

---

CHAIN_DEFAULT

readonly static CHAIN_DEFAULT: ChainConfig = Mainnet

Defined in: config.ts:349

---

CODE_CACHE

readonly static CODE_CACHE: 200000 = 200000

Defined in: config.ts:363

---

DATADIR_DEFAULT

readonly static DATADIR_DEFAULT: "./datadir"

Defined in: config.ts:351

---

DEBUGCODE_DEFAULT

readonly static DEBUGCODE_DEFAULT: false = false

Defined in: config.ts:365

---

DNSADDR_DEFAULT

readonly static DNSADDR_DEFAULT: "8.8.8.8" = '8.8.8.8'

Defined in: config.ts:358

---

ENGINE_NEWPAYLOAD_MAX_EXECUTE

readonly static ENGINE_NEWPAYLOAD_MAX_EXECUTE: 2 = 2

Defined in: config.ts:382

---

ENGINE_NEWPAYLOAD_MAX_TXS_EXECUTE

readonly static ENGINE_NEWPAYLOAD_MAX_TXS_EXECUTE: 200 = 200

Defined in: config.ts:383

---

ENGINE_PARENT_LOOKUP_MAX_DEPTH

readonly static ENGINE_PARENT_LOOKUP_MAX_DEPTH: 128 = 128

Defined in: config.ts:381

---

EXECUTION

readonly static EXECUTION: true = true

Defined in: config.ts:359

---

MAX_ACCOUNT_RANGE

readonly static MAX_ACCOUNT_RANGE: bigint

Defined in: config.ts:372

---

MAX_INVALID_BLOCKS_ERROR_CACHE

readonly static MAX_INVALID_BLOCKS_ERROR_CACHE: 128 = 128

Defined in: config.ts:376

---

MAX_RANGE_BYTES

readonly static MAX_RANGE_BYTES: 50000 = 50000

Defined in: config.ts:370

---

MAX_STORAGE_RANGE

readonly static MAX_STORAGE_RANGE: bigint

Defined in: config.ts:374

---

MAXFETCHERJOBS_DEFAULT

readonly static MAXFETCHERJOBS_DEFAULT: 100 = 100

Defined in: config.ts:354

---

MAXFETCHERREQUESTS_DEFAULT

readonly static MAXFETCHERREQUESTS_DEFAULT: 5 = 5

Defined in: config.ts:355

---

MAXPEERS_DEFAULT

readonly static MAXPEERS_DEFAULT: 25 = 25

Defined in: config.ts:357

---

MAXPERREQUEST_DEFAULT

readonly static MAXPERREQUEST_DEFAULT: 100 = 100

Defined in: config.ts:353

---

MINPEERS_DEFAULT

readonly static MINPEERS_DEFAULT: 1 = 1

Defined in: config.ts:356

---

NUM_BLOCKS_PER_ITERATION

readonly static NUM_BLOCKS_PER_ITERATION: 100 = 100

Defined in: config.ts:360

---

PORT_DEFAULT

readonly static PORT_DEFAULT: 30303 = 30303

Defined in: config.ts:352

---

PRUNE_ENGINE_CACHE

readonly static PRUNE_ENGINE_CACHE: true = true

Defined in: config.ts:377

---

SAFE_REORG_DISTANCE

readonly static SAFE_REORG_DISTANCE: 100 = 100

Defined in: config.ts:366

---

SKELETON_FILL_CANONICAL_BACKSTEP

readonly static SKELETON_FILL_CANONICAL_BACKSTEP: 100 = 100

Defined in: config.ts:367

---

SKELETON_SUBCHAIN_MERGE_MINIMUM

readonly static SKELETON_SUBCHAIN_MERGE_MINIMUM: 1000 = 1000

Defined in: config.ts:368

---

SNAP_AVAILABILITY_DEPTH

readonly static SNAP_AVAILABILITY_DEPTH: bigint

Defined in: config.ts:384

---

SNAP_TRANSITION_SAFE_DEPTH

readonly static SNAP_TRANSITION_SAFE_DEPTH: bigint

Defined in: config.ts:387

---

STORAGE_CACHE

readonly static STORAGE_CACHE: 200000 = 200000

Defined in: config.ts:362

---

SYNCED_STATE_REMOVAL_PERIOD

readonly static SYNCED_STATE_REMOVAL_PERIOD: 60000 = 60000

Defined in: config.ts:379

---

SYNCMODE_DEFAULT

readonly static SYNCMODE_DEFAULT: "full" = SyncMode.Full

Defined in: config.ts:350

---

TRIE_CACHE

readonly static TRIE_CACHE: 200000 = 200000

Defined in: config.ts:364

Methods

getDataDirectory()

getDataDirectory(dir): string

Defined in: config.ts:646

Returns the location for each DataDirectory

Parameters

dir

DataDirectory

Returns

string

---

getDnsDiscovery()

getDnsDiscovery(option): boolean

Defined in: config.ts:707

Returns specified option or the default setting for whether DNS-based peer discovery is enabled based on chainName.

Parameters

option

boolean

undefined

Returns

boolean

---

getInvalidPayloadsDir()

getInvalidPayloadsDir(): string

Defined in: config.ts:639

Returns

string

---

getNetworkDirectory()

getNetworkDirectory(): string

Defined in: config.ts:634

Returns the network directory for the chain.

Returns

string

---

superMsg()

superMsg(msgs, meta?): void

Defined in: config.ts:688

Parameters

msgs

string

string[]

meta?

any

Returns

void

---

updateSynchronizedState()

updateSynchronizedState(latest?, emitSyncEvent?): void

Defined in: config.ts:575

Update the synchronized state of the chain

Parameters

latest?

BlockHeader

null

emitSyncEvent?

boolean

Returns

void

Emits

Event.SYNC_SYNCHRONIZED

---

getClientKey()

static getClientKey(datadir, common): Promise<Uint8Array<ArrayBufferLike> | undefined>

Defined in: config.ts:670

Gets the client private key from the config db.

Parameters

datadir

string

common

Common

Returns

Promise<Uint8Array<ArrayBufferLike> | undefined>

---

getConfigDB()

static getConfigDB(networkDir): Level<string | Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>

Defined in: config.ts:663

Returns the config level db.

Parameters

networkDir

string

Returns

Level<string | Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>