forked from ethereumjs/ethereumjs-monorepo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cli.ts
executable file
·1215 lines (1150 loc) · 41.7 KB
/
cli.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env node
import { Block } from '@ethereumjs/block'
import { Blockchain } from '@ethereumjs/blockchain'
import { Chain, Common, ConsensusAlgorithm, Hardfork } from '@ethereumjs/common'
import { RLP } from '@ethereumjs/rlp'
import {
Address,
BIGINT_2,
bytesToHex,
calculateSigRecovery,
concatBytes,
ecrecover,
ecsign,
hexToBytes,
parseGethGenesisState,
randomBytes,
setLengthLeft,
short,
} from '@ethereumjs/util'
import {
keccak256 as keccak256WASM,
secp256k1Expand,
secp256k1Recover,
secp256k1Sign,
waitReady as waitReadyPolkadotSha256,
sha256 as wasmSha256,
} from '@polkadot/wasm-crypto'
import { keccak256 } from 'ethereum-cryptography/keccak'
import { ecdsaRecover, ecdsaSign } from 'ethereum-cryptography/secp256k1-compat'
import { sha256 } from 'ethereum-cryptography/sha256.js'
import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'fs'
import * as http from 'http'
import { loadKZG } from 'kzg-wasm'
import { Level } from 'level'
import { homedir } from 'os'
import * as path from 'path'
import * as promClient from 'prom-client'
import * as readline from 'readline'
import * as url from 'url'
import * as yargs from 'yargs'
import { hideBin } from 'yargs/helpers'
import { EthereumClient } from '../src/client.js'
import { Config, DataDirectory, SyncMode } from '../src/config.js'
import { LevelDB } from '../src/execution/level.js'
import { getLogger } from '../src/logging.js'
import { Event } from '../src/types.js'
import { parseMultiaddrs } from '../src/util/index.js'
import { setupMetrics } from '../src/util/metrics.js'
import { helprpc, startRPCServers } from './startRpc.js'
import type { Logger } from '../src/logging.js'
import type { FullEthereumService } from '../src/service/index.js'
import type { ClientOpts } from '../src/types.js'
import type { RPCArgs } from './startRpc.js'
import type { BlockBytes } from '@ethereumjs/block'
import type { CustomCrypto } from '@ethereumjs/common'
import type { GenesisState, PrefixedHexString } from '@ethereumjs/util'
import type { AbstractLevel } from 'abstract-level'
import type { Server as RPCServer } from 'jayson/promise/index.js'
type Account = [address: Address, privateKey: Uint8Array]
const networks = Object.entries(Common.getInitializedChains().names)
let logger: Logger
const args: ClientOpts = yargs
.default(hideBin(process.argv))
.parserConfiguration({
'dot-notation': false,
})
.option('network', {
describe: 'Network',
choices: networks.map((n) => n[1]).filter((el) => isNaN(parseInt(el))),
default: 'mainnet',
})
.option('networkId', {
describe: 'Network ID',
choices: networks.map((n) => parseInt(n[0])).filter((el) => !isNaN(el)),
default: undefined,
conflicts: ['customChain', 'customGenesisState', 'gethGenesis'], // Disallows custom chain data and networkId
})
.option('sync', {
describe: 'Blockchain sync mode (light sync experimental)',
choices: Object.values(SyncMode),
default: Config.SYNCMODE_DEFAULT,
})
.option('lightServe', {
describe: 'Serve light peer requests',
boolean: true,
default: Config.LIGHTSERV_DEFAULT,
})
.option('dataDir', {
describe: 'Data directory for the blockchain',
default: `${homedir()}/Library/Ethereum/ethereumjs`,
})
.option('customChain', {
describe: 'Path to custom chain parameters json file (@ethereumjs/common format)',
coerce: (arg: string) => (arg ? path.resolve(arg) : undefined),
implies: 'customGenesisState',
})
.option('customGenesisState', {
describe: 'Path to custom genesis state json file (@ethereumjs/common format)',
coerce: (arg: string) => (arg ? path.resolve(arg) : undefined),
implies: 'customChain',
})
.option('verkleGenesisStateRoot', {
describe: 'State root of the verkle genesis genesis (experimental)',
string: true,
coerce: (customGenesisStateRoot: PrefixedHexString) => hexToBytes(customGenesisStateRoot),
})
.option('gethGenesis', {
describe: 'Import a geth genesis file for running a custom network',
coerce: (arg: string) => (arg ? path.resolve(arg) : undefined),
})
.option('trustedSetup', {
describe: 'A custom trusted setup txt file for initializing the kzg library',
coerce: (arg: string) => (arg ? path.resolve(arg) : undefined),
})
.option('mergeForkIdPostMerge', {
describe:
'Place mergeForkIdTransition hardfork before (false) or after (true) Merge hardfork in the custom gethGenesis',
boolean: true,
default: true,
})
.option('bootnodes', {
describe:
'Comma-separated list of network bootnodes (format: "enode://<id>@<host:port>,enode://..." ("[?discport=<port>]" not supported) or path to a bootnode.txt file',
array: true,
coerce: (arr) => arr.filter((el: any) => el !== undefined).map((el: any) => el.toString()),
})
.option('port', {
describe: 'RLPx listening port',
default: Config.PORT_DEFAULT,
})
.option('extIP', {
describe: 'RLPx external IP',
string: true,
})
.option('multiaddrs', {
describe: 'Network multiaddrs',
array: true,
coerce: (arr) => arr.filter((el: any) => el !== undefined).map((el: any) => el.toString()),
})
.option('rpc', {
describe: 'Enable the JSON-RPC server with HTTP endpoint',
boolean: true,
})
.option('rpcPort', {
describe: 'HTTP-RPC server listening port',
default: 8545,
})
.option('rpcAddr', {
describe: 'HTTP-RPC server listening interface address',
default: 'localhost',
})
.option('ws', {
describe: 'Enable the JSON-RPC server with WS endpoint',
boolean: true,
})
.option('wsPort', {
describe: 'WS-RPC server listening port',
default: 8546,
})
.option('wsAddr', {
describe: 'WS-RPC server listening address',
default: 'localhost',
})
.option('rpcEngine', {
describe: 'Enable the JSON-RPC server for Engine namespace',
boolean: true,
})
.option('rpcEnginePort', {
describe: 'HTTP-RPC server listening port for Engine namespace',
number: true,
default: 8551,
})
.option('rpcEngineAddr', {
describe: 'HTTP-RPC server listening interface address for Engine namespace',
string: true,
default: 'localhost',
})
.option('wsEnginePort', {
describe: 'WS-RPC server listening port for Engine namespace',
number: true,
default: 8552,
})
.option('wsEngineAddr', {
describe: 'WS-RPC server listening interface address for Engine namespace',
string: true,
default: 'localhost',
})
.option('rpcEngineAuth', {
describe: 'Enable jwt authentication for Engine RPC server',
boolean: true,
default: true,
})
.option('jwtSecret', {
describe: 'Provide a file containing a hex encoded jwt secret for Engine RPC server',
coerce: (arg: string) => (arg ? path.resolve(arg) : undefined),
})
.option('helpRpc', {
describe: 'Display the JSON RPC help with a list of all RPC methods implemented (and exit)',
boolean: true,
})
.option('logLevel', {
describe: 'Logging verbosity',
choices: ['error', 'warn', 'info', 'debug'],
default: 'info',
})
.option('logFile', {
describe:
'File to save log file (default logs to `$dataDir/ethereumjs.log`, pass false to disable)',
default: true,
})
.option('logLevelFile', {
describe: 'Log level for logFile',
choices: ['error', 'warn', 'info', 'debug'],
default: 'debug',
})
.option('logRotate', {
describe: 'Rotate log file daily',
boolean: true,
default: true,
})
.option('logMaxFiles', {
describe: 'Maximum number of log files when rotating (older will be deleted)',
number: true,
default: 5,
})
.option('prometheus', {
describe: 'Enable the Prometheus metrics server with HTTP endpoint',
boolean: true,
default: false,
})
.option('prometheusPort', {
describe: 'Enable the Prometheus metrics server with HTTP endpoint',
number: true,
default: 8000,
})
.option('rpcDebug', {
describe:
'Additionally log truncated RPC calls filtered by name (prefix), e.g.: "eth,engine_getPayload" (use "all" for all methods). Truncated by default, add verbosity using "rpcDebugVerbose"',
default: '',
string: true,
})
.option('rpcDebugVerbose', {
describe:
'Additionally log complete RPC calls filtered by name (prefix), e.g.: "eth,engine_getPayload" (use "all" for all methods).',
default: '',
string: true,
})
.option('rpcCors', {
describe: 'Configure the Access-Control-Allow-Origin CORS header for RPC server',
string: true,
default: '*',
})
.option('maxPerRequest', {
describe: 'Max items per block or header request',
number: true,
default: Config.MAXPERREQUEST_DEFAULT,
})
.option('maxFetcherJobs', {
describe: 'Max tasks or jobs to be created for a fetcher at a time',
number: true,
default: Config.MAXFETCHERJOBS_DEFAULT,
})
.option('minPeers', {
describe: 'Peers needed before syncing',
number: true,
default: Config.MINPEERS_DEFAULT,
})
.option('maxPeers', {
describe: 'Maximum peers to sync with',
number: true,
default: Config.MAXPEERS_DEFAULT,
})
.option('dnsAddr', {
describe: 'IPv4 address of DNS server to use when acquiring peer discovery targets',
string: true,
default: Config.DNSADDR_DEFAULT,
})
.option('dnsNetworks', {
describe: 'EIP-1459 ENR tree urls to query for peer discovery targets',
array: true,
coerce: (arr) => arr.filter((el: any) => el !== undefined).map((el: any) => el.toString()),
})
.option('execution', {
describe: 'Start continuous VM execution (pre-Merge setting)',
boolean: true,
default: Config.EXECUTION,
})
.option('numBlocksPerIteration', {
describe: 'Number of blocks to execute in batch mode and logged to console',
number: true,
default: Config.NUM_BLOCKS_PER_ITERATION,
})
.option('executeBlocks', {
describe:
'Debug mode for reexecuting existing blocks (no services will be started), allowed input formats: 5,5-10',
string: true,
})
.option('accountCache', {
describe: 'Size for the account cache (max number of accounts)',
number: true,
default: Config.ACCOUNT_CACHE,
})
.option('storageCache', {
describe: 'Size for the storage cache (max number of contracts)',
number: true,
default: Config.STORAGE_CACHE,
})
.option('codeCache', {
describe: 'Size for the code cache (max number of contracts)',
number: true,
default: Config.CODE_CACHE,
})
.option('trieCache', {
describe: 'Size for the trie cache (max number of trie nodes)',
number: true,
default: Config.TRIE_CACHE,
})
.option('debugCode', {
describe: 'Generate code for local debugging (internal usage mostly)',
boolean: true,
default: Config.DEBUGCODE_DEFAULT,
})
.option('discDns', {
describe: 'Query EIP-1459 DNS TXT records for peer discovery',
boolean: true,
})
.option('discV4', {
describe: 'Use v4 ("findneighbour" node requests) for peer discovery',
boolean: true,
})
.option('mine', {
describe: 'Enable private custom network mining (beta)',
boolean: true,
})
.option('unlock', {
describe: `Path to file where private key (without 0x) is stored or comma separated list of accounts to unlock -
currently only the first account is used (for sealing PoA blocks and as the default coinbase).
You will be prompted for a 0x-prefixed private key if you pass a list of accounts
FOR YOUR SAFETY PLEASE DO NOT USE ANY ACCOUNTS HOLDING SUBSTANTIAL AMOUNTS OF ETH`,
string: true,
})
.option('dev', {
describe: 'Start an ephemeral PoA blockchain with a single miner and prefunded accounts',
choices: ['false', 'true', 'poa', 'pow'],
})
.option('minerCoinbase', {
describe:
'Address for mining rewards (etherbase). If not provided, defaults to the primary account',
string: true,
coerce: (coinbase) => Address.fromString(coinbase),
})
.option('saveReceipts', {
describe:
'Save tx receipts and logs in the meta db (warning: may use a large amount of storage). With `--rpc` allows querying via eth_getLogs (max 10000 logs per request) and eth_getTransactionReceipt (within `--txLookupLimit`)',
boolean: true,
default: true,
})
.option('snap', {
describe: 'Enable snap state sync (for testing and development purposes)',
boolean: true,
})
.option('prefixStorageTrieKeys', {
describe:
'Enable/Disable storage trie prefixes (specify `false` for backward compatibility with previous states synced without prefixes)',
boolean: true,
default: true,
deprecated:
'Support for `--prefixStorageTrieKeys=false` is temporary. Please sync new instances with `prefixStorageTrieKeys` enabled',
})
.options('useStringValueTrieDB', {
describe:
'Use string values in the trie DB. This is old behavior, new behavior uses Uint8Arrays in the DB (more performant)',
boolean: true,
default: false,
deprecated:
'Usage of old DBs which uses string-values is temporary. Please sync new instances without this option.',
})
.option('txLookupLimit', {
describe:
'Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain)',
number: true,
default: 2350000,
})
.option('startBlock', {
describe:
'Block number to start syncing from. Must be lower than the local chain tip. Note: this is destructive and removes blocks from the blockchain, please back up your datadir before using.',
number: true,
})
.option('startExecutionFrom', {
describe:
'Block number to start/restart execution from. For merkle based state, parent state should be present in the the db while in verkle stateless mode the chain should be synced till the block and witnesses available this block onwards',
number: true,
})
.option('startExecution', {
describe:
'Start execution of unexecuted blocks without waiting for the CL fcU, set to `true` if `startExecutionFrom` provided',
boolean: true,
})
.option('isSingleNode', {
describe:
'To run client in single node configuration without need to discover the sync height from peer. Particularly useful in test configurations. This flag is automically activated in the "dev" mode',
boolean: true,
})
.option('vmProfileBlocks', {
describe: 'Report the VM profile after running each block',
boolean: true,
default: false,
})
.option('vmProfileTxs', {
describe: 'Report the VM profile after running each tx',
boolean: true,
default: false,
})
.option('loadBlocksFromRlp', {
describe: 'path to a file of RLP encoded blocks',
string: true,
array: true,
})
.option('pruneEngineCache', {
describe: 'Enable/Disable pruning engine block cache (disable for testing against hive etc)',
boolean: true,
default: true,
})
.option('statelessVerkle', {
describe: 'Run verkle+ hardforks using stateless verkle stateManager (experimental)',
boolean: true,
default: true,
})
.option('engineNewpayloadMaxExecute', {
describe:
'Number of unexecuted blocks (including ancestors) that can be blockingly executed in engine`s new payload (if required and possible) to determine the validity of the block',
number: true,
})
.option('skipEngineExec', {
describe:
'Skip executing blocks in new payload calls in engine, alias for --engineNewpayloadMaxExecute=0 and overrides any engineNewpayloadMaxExecute if also provided',
boolean: true,
})
.option('ignoreStatelessInvalidExecs', {
describe:
'Ignore stateless execution failures and keep moving the vm execution along using execution witnesses available in block (verkle). Sets/overrides --statelessVerkle=true and --engineNewpayloadMaxExecute=0 to prevent engine newPayload direct block execution where block execution faliures may stall the CL client. Useful for debugging the verkle. The invalid blocks will be stored in dataDir/network/invalidPayloads which one may use later for debugging',
boolean: true,
hidden: true,
})
.option('initialVerkleStateRoot', {
describe:
'Provides an initial stateRoot to start the StatelessVerkleStateManager. This is required to bootstrap verkle witness proof verification, since they depend on the stateRoot of the parent block',
string: true,
coerce: (initialVerkleStateRoot: PrefixedHexString) => hexToBytes(initialVerkleStateRoot),
})
.option('useJsCrypto', {
describe: 'Use pure Javascript cryptography functions',
boolean: true,
default: false,
})
.completion()
// strict() ensures that yargs throws when an invalid arg is provided
.strict()
.check((argv, _options) => {
const usedPorts = new Set()
let collision = false
if (argv.ws === true) {
usedPorts.add(argv.wsPort)
if (!usedPorts.has(argv.wsEnginePort)) {
usedPorts.add(argv.wsEnginePort)
}
}
if (argv.rpc === true && usedPorts.has(argv.rpcPort)) collision = true
if (argv.rpcEngine === true && usedPorts.has(argv.rpcEnginePort)) collision = true
if (collision) throw new Error('cannot reuse ports between RPC instances')
return true
})
.parseSync()
/**
* Initializes and returns the databases needed for the client
*/
function initDBs(config: Config): {
chainDB: AbstractLevel<string | Uint8Array, string | Uint8Array, string | Uint8Array>
stateDB: AbstractLevel<string | Uint8Array, string | Uint8Array, string | Uint8Array>
metaDB: AbstractLevel<string | Uint8Array, string | Uint8Array, string | Uint8Array>
} {
// Chain DB
const chainDataDir = config.getDataDirectory(DataDirectory.Chain)
mkdirSync(chainDataDir, {
recursive: true,
})
const chainDB = new Level<string | Uint8Array, string | Uint8Array>(chainDataDir)
// State DB
const stateDataDir = config.getDataDirectory(DataDirectory.State)
mkdirSync(stateDataDir, {
recursive: true,
})
const stateDB = new Level<string | Uint8Array, string | Uint8Array>(stateDataDir)
// Meta DB (receipts, logs, indexes, skeleton chain)
const metaDataDir = config.getDataDirectory(DataDirectory.Meta)
mkdirSync(metaDataDir, {
recursive: true,
})
const metaDB = new Level<string | Uint8Array, string | Uint8Array>(metaDataDir)
return { chainDB, stateDB, metaDB }
}
/**
* Special block execution debug mode (does not change any state)
*/
async function executeBlocks(client: EthereumClient) {
let first = 0
let last = 0
let txHashes = []
try {
const blockRange = (args.executeBlocks as string).split('-').map((val) => {
const reNum = /([0-9]+)/.exec(val)
const num = reNum ? parseInt(reNum[1]) : 0
const reTxs = /[0-9]+\[(.*)\]/.exec(val)
const txs = reTxs ? reTxs[1].split(',') : []
return [num, txs]
})
first = blockRange[0][0] as number
last = blockRange.length === 2 ? (blockRange[1][0] as number) : first
txHashes = blockRange[0][1] as string[]
if ((blockRange[0][1] as string[]).length > 0 && blockRange.length === 2) {
throw new Error('wrong input')
}
} catch (e: any) {
client.config.logger.error(
'Wrong input format for block execution, allowed format types: 5, 5-10, 5[0xba4b5fd92a26badad3cad22eb6f7c7e745053739b5f5d1e8a3afb00f8fb2a280,[TX_HASH_2],...], 5[*] (all txs in verbose mode)'
)
process.exit()
}
const { execution } = client.services.find((s) => s.name === 'eth') as FullEthereumService
if (execution === undefined) throw new Error('executeBlocks requires execution')
await execution.executeBlocks(first, last, txHashes)
}
/**
* Starts the client on a specified block number.
* Note: this is destructive and removes blocks from the blockchain. Please back up your datadir.
*/
async function startBlock(client: EthereumClient) {
if (args.startBlock === undefined) return
const startBlock = BigInt(args.startBlock)
const height = client.chain.headers.height
if (height < startBlock) {
logger.error(`Cannot start chain higher than current height ${height}`)
process.exit()
}
try {
await client.chain.resetCanonicalHead(startBlock)
logger.info(`Chain height reset to ${client.chain.headers.height}`)
} catch (err: any) {
logger.error(`Error setting back chain in startBlock: ${err}`)
process.exit()
}
}
async function startExecutionFrom(client: EthereumClient) {
if (args.startExecutionFrom === undefined) return
const startExecutionFrom = BigInt(args.startExecutionFrom)
const height = client.chain.headers.height
if (height < startExecutionFrom) {
logger.error(`Cannot start merkle chain higher than current height ${height}`)
process.exit()
}
const startExecutionBlock = await client.chain.getBlock(startExecutionFrom)
const startExecutionParent = await client.chain.getBlock(startExecutionBlock.header.parentHash)
const startExecutionParentTd = await client.chain.getTd(
startExecutionParent.hash(),
startExecutionParent.header.number
)
const startExecutionHardfork = client.config.execCommon.getHardforkBy({
blockNumber: startExecutionBlock.header.number,
td: startExecutionParentTd,
timestamp: startExecutionBlock.header.timestamp,
})
if (
client.config.execCommon.hardforkGteHardfork(startExecutionHardfork, Hardfork.Osaka) &&
client.config.statelessVerkle
) {
// for stateless verkle sync execution witnesses are available and hence we can blindly set the vmHead
// to startExecutionParent's hash
try {
await client.chain.blockchain.setIteratorHead('vm', startExecutionParent.hash())
await client.chain.update(false)
logger.info(
`vmHead set to ${client.chain.headers.height} for starting stateless execution at hardfork=${startExecutionHardfork}`
)
} catch (err: any) {
logger.error(`Error setting vmHead for starting stateless execution: ${err}`)
process.exit()
}
} else {
// we need parent state availability to set the vmHead to the parent
logger.error(`Stateful execution reset not implemented at hardfork=${startExecutionHardfork}`)
process.exit()
}
}
/**
* Starts and returns the {@link EthereumClient}
*/
async function startClient(
config: Config,
genesisMeta: { genesisState?: GenesisState; genesisStateRoot?: Uint8Array } = {}
) {
config.logger.info(`Data directory: ${config.datadir}`)
if (config.lightserv) {
config.logger.info(`Serving light peer requests`)
}
const dbs = initDBs(config)
let blockchain
if (genesisMeta.genesisState !== undefined || genesisMeta.genesisStateRoot !== undefined) {
const validateConsensus = config.chainCommon.consensusAlgorithm() === ConsensusAlgorithm.Clique
blockchain = await Blockchain.create({
db: new LevelDB(dbs.chainDB),
...genesisMeta,
common: config.chainCommon,
hardforkByHeadBlockNumber: true,
validateConsensus,
validateBlocks: true,
genesisState: genesisMeta.genesisState,
genesisStateRoot: genesisMeta.genesisStateRoot,
})
config.chainCommon.setForkHashes(blockchain.genesisBlock.hash())
}
const client = await EthereumClient.create({
config,
blockchain,
...genesisMeta,
...dbs,
})
await client.open()
if (args.loadBlocksFromRlp !== undefined) {
// Specifically for Hive simulator, preload blocks provided in RLP format
const blocks: Block[] = []
for (const rlpBlock of args.loadBlocksFromRlp) {
const blockRlp = readFileSync(rlpBlock)
let buf = RLP.decode(blockRlp, true)
while (buf.data?.length > 0 || buf.remainder?.length > 0) {
try {
const block = Block.fromValuesArray(buf.data as BlockBytes, {
common: config.chainCommon,
setHardfork: true,
})
blocks.push(block)
buf = RLP.decode(buf.remainder, true)
config.logger.info(
`Preloading block hash=0x${short(bytesToHex(block.header.hash()))} number=${
block.header.number
}`
)
} catch (err: any) {
config.logger.info(
`Encountered error while while preloading chain data error=${err.message}`
)
break
}
}
}
if (blocks.length > 0) {
if (!client.chain.opened) {
await client.chain.open()
}
await client.chain.putBlocks(blocks, true)
}
}
if (typeof args.startBlock === 'number') {
await startBlock(client)
}
if (typeof args.startExecutionFrom === 'number') {
await startExecutionFrom(client)
}
// update client's sync status and start txpool if synchronized
client.config.updateSynchronizedState(client.chain.headers.latest)
if (client.config.synchronized === true) {
const fullService = client.services.find((s) => s.name === 'eth')
// The service might not be FullEthereumService even if we cast it as one,
// so txPool might not exist on it
;(fullService as FullEthereumService).txPool?.checkRunState()
}
if (args.executeBlocks !== undefined) {
// Special block execution debug mode (does not change any state)
await executeBlocks(client)
} else {
// Regular client start
await client.start()
}
if (args.loadBlocksFromRlp !== undefined && client.chain.opened) {
const service = client.service('eth') as FullEthereumService
await service.execution.open()
await service.execution.run()
}
return client
}
/**
* Returns a configured blockchain and common for devnet with a prefunded address
*/
async function setupDevnet(prefundAddress: Address) {
const addr = prefundAddress.toString().slice(2)
const consensusConfig =
args.dev === 'pow'
? { ethash: true }
: {
clique: {
period: 10,
epoch: 30000,
},
}
const defaultChainData = {
config: {
chainId: 123456,
homesteadBlock: 0,
eip150Block: 0,
eip150Hash: '0x0000000000000000000000000000000000000000000000000000000000000000',
eip155Block: 0,
eip158Block: 0,
byzantiumBlock: 0,
constantinopleBlock: 0,
petersburgBlock: 0,
istanbulBlock: 0,
berlinBlock: 0,
londonBlock: 0,
...consensusConfig,
},
nonce: '0x0',
timestamp: '0x614b3731',
gasLimit: '0x47b760',
difficulty: '0x1',
mixHash: '0x0000000000000000000000000000000000000000000000000000000000000000',
coinbase: '0x0000000000000000000000000000000000000000',
number: '0x0',
gasUsed: '0x0',
parentHash: '0x0000000000000000000000000000000000000000000000000000000000000000',
baseFeePerGas: 7,
}
const extraData =
args.dev === 'pow' ? '0x' + '0'.repeat(32) : '0x' + '0'.repeat(64) + addr + '0'.repeat(130)
const chainData = {
...defaultChainData,
extraData,
alloc: { [addr]: { balance: '0x10000000000000000000' } },
}
const common = Common.fromGethGenesis(chainData, { chain: 'devnet', hardfork: Hardfork.London })
const customGenesisState = parseGethGenesisState(chainData)
return { common, customGenesisState }
}
/**
* Accept account input from command line
*/
async function inputAccounts() {
const accounts: Account[] = []
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
})
// Hide key input
;(rl as any).input.on('keypress', function () {
// get the number of characters entered so far:
const len = (rl as any).line.length
// move cursor back to the beginning of the input:
readline.moveCursor((rl as any).output, -len, 0)
// clear everything to the right of the cursor:
readline.clearLine((rl as any).output, 1)
// replace the original input with asterisks:
for (let i = 0; i < len; i++) {
;(rl as any).output.write('*')
}
})
const question = (text: string) => {
return new Promise<string>((resolve) => {
rl.question(text, resolve)
})
}
try {
const addresses = args.unlock!.split(',')
const isFile = existsSync(path.resolve(addresses[0]))
if (!isFile) {
for (const addressString of addresses) {
const address = Address.fromString(addressString)
const inputKey = (await question(
`Please enter the 0x-prefixed private key to unlock ${address}:\n`
)) as PrefixedHexString
;(rl as any).history = (rl as any).history.slice(1)
const privKey = hexToBytes(inputKey)
const derivedAddress = Address.fromPrivateKey(privKey)
if (address.equals(derivedAddress)) {
accounts.push([address, privKey])
} else {
console.error(
`Private key does not match for ${address} (address derived: ${derivedAddress})`
)
process.exit()
}
}
} else {
const acc = readFileSync(path.resolve(args.unlock!), 'utf-8').replace(/(\r\n|\n|\r)/gm, '')
const privKey = hexToBytes(`0x${acc}`) // See docs: acc has to be non-zero prefixed in the file
const derivedAddress = Address.fromPrivateKey(privKey)
accounts.push([derivedAddress, privKey])
}
} catch (e: any) {
console.error(`Encountered error unlocking account:\n${e.message}`)
process.exit()
}
rl.close()
return accounts
}
/**
* Returns a randomly generated account
*/
function generateAccount(): Account {
const privKey = randomBytes(32)
const address = Address.fromPrivateKey(privKey)
console.log('='.repeat(50))
console.log('Account generated for mining blocks:')
console.log(`Address: ${address}`)
console.log(`Private key: ${bytesToHex(privKey)}`)
console.log('WARNING: Do not use this account for mainnet funds')
console.log('='.repeat(50))
return [address, privKey]
}
/**
* Shuts down an actively running client gracefully
* @param config Client config object
* @param clientStartPromise promise that returns a client and server object
*/
const stopClient = async (
config: Config,
clientStartPromise: Promise<{
client: EthereumClient
servers: (RPCServer | http.Server)[]
} | null>
) => {
config.logger.info('Caught interrupt signal. Obtaining client handle for clean shutdown...')
config.logger.info('(This might take a little longer if client not yet fully started)')
let timeoutHandle
if (clientStartPromise?.toString().includes('Promise') === true)
// Client hasn't finished starting up so setting timeout to terminate process if not already shutdown gracefully
timeoutHandle = setTimeout(() => {
config.logger.warn('Client has become unresponsive while starting up.')
config.logger.warn('Check logging output for potential errors. Exiting...')
process.exit(1)
}, 30000)
const clientHandle = await clientStartPromise
if (clientHandle !== null) {
config.logger.info('Shutting down the client and the servers...')
const { client, servers } = clientHandle
for (const s of servers) {
// @ts-expect-error jayson.Server type doesn't play well with ESM for some reason
s['http'] !== undefined ? (s as RPCServer).http().close() : (s as http.Server).close()
}
await client.stop()
config.logger.info('Exiting.')
} else {
config.logger.info('Client did not start properly, exiting ...')
}
clearTimeout(timeoutHandle)
process.exit()
}
/**
* Main entry point to start a client
*/
async function run() {
if (args.helpRpc === true) {
// Output RPC help and exit
return helprpc()
}
// TODO sharding: Just initialize kzg library now, in future it can be optimized to be
// loaded and initialized on the sharding hardfork activation
// Give network id precedence over network name
const chain = args.networkId ?? args.network ?? Chain.Mainnet
const cryptoFunctions: CustomCrypto = {}
const kzg = await loadKZG()
// Initialize WASM crypto if JS crypto is not specified
if (args.useJsCrypto === false) {
await waitReadyPolkadotSha256()
cryptoFunctions.keccak256 = keccak256WASM
cryptoFunctions.ecrecover = (
msgHash: Uint8Array,
v: bigint,
r: Uint8Array,
s: Uint8Array,
chainID?: bigint
) =>
secp256k1Expand(
secp256k1Recover(
msgHash,
concatBytes(setLengthLeft(r, 32), setLengthLeft(s, 32)),
Number(calculateSigRecovery(v, chainID))
)
).slice(1)
cryptoFunctions.sha256 = wasmSha256
cryptoFunctions.ecsign = (msg: Uint8Array, pk: Uint8Array, chainId?: bigint) => {
if (msg.length < 32) {
// WASM errors with `unreachable` if we try to pass in less than 32 bytes in the message
throw new Error('message length must be 32 bytes or greater')
}
const buf = secp256k1Sign(msg, pk)
const r = buf.slice(0, 32)
const s = buf.slice(32, 64)
const v =
chainId === undefined
? BigInt(buf[64] + 27)
: BigInt(buf[64] + 35) + BigInt(chainId) * BIGINT_2
return { r, s, v }
}
cryptoFunctions.ecdsaSign = (hash: Uint8Array, pk: Uint8Array) => {
const sig = secp256k1Sign(hash, pk)
return {
signature: sig.slice(0, 64),
recid: sig[64],
}
}
cryptoFunctions.ecdsaRecover = (sig: Uint8Array, recId: number, hash: Uint8Array) => {
return secp256k1Recover(hash, sig, recId)
}
} else {
cryptoFunctions.keccak256 = keccak256
cryptoFunctions.ecrecover = ecrecover
cryptoFunctions.sha256 = sha256
cryptoFunctions.ecsign = ecsign
cryptoFunctions.ecdsaSign = ecdsaSign
cryptoFunctions.ecdsaRecover = ecdsaRecover
}
cryptoFunctions.kzg = kzg
// Configure accounts for mining and prefunding in a local devnet
const accounts: Account[] = []
if (typeof args.unlock === 'string') {
accounts.push(...(await inputAccounts()))
}
let customGenesisState: GenesisState | undefined
let common = new Common({ chain, hardfork: Hardfork.Chainstart, customCrypto: cryptoFunctions })
if (args.dev === true || typeof args.dev === 'string') {
args.discDns = false
if (accounts.length === 0) {
// If generating new keys delete old chain data to prevent genesis block mismatch
rmSync(`${args.dataDir}/devnet`, { recursive: true, force: true })
// Create new account
accounts.push(generateAccount())
}
const prefundAddress = accounts[0][0]
;({ common, customGenesisState } = await setupDevnet(prefundAddress))
}
// Configure common based on args given
// Use custom chain parameters file if specified
if (typeof args.customChain === 'string') {
try {
const customChainParams = JSON.parse(readFileSync(args.customChain, 'utf-8'))
customGenesisState = JSON.parse(readFileSync(args.customGenesisState!, 'utf-8'))
common = new Common({
chain: customChainParams.name,
customChains: [customChainParams],
customCrypto: cryptoFunctions,
})
} catch (err: any) {
console.error(`invalid chain parameters: ${err.message}`)
process.exit()