History

Pawan Dhananjay cbe4880490 Fix deneb doppelganger tests (#4124 ) * Temp hack to compile * Fix doppelganger tests * Kill in groups instead of storing pid * Install geth in CI * Install geth first * Fix eth1_block_hash * Fix directory paths and block hash * Fix workflow for local testnets; reset genesis.json after running script * Disable capella and deneb forks for doppelganger tests * oops not capella * Spin up a spare bn for the doppelganger validator * testing * Revert "testing" This reverts commit 14eb178bca5b7d27b9cd9b665b5cd2c916f50901. * Modify beacon_node script to take trusted peers * Set doppelganger bn as a trusted peer * Update var * update another * Fix port * Add a flag to disable peer scoring * Disable peer scoring in local testnet bn script * Revert trusted peers hack * fmt * Fix proposer boost score		2023-04-26 13:26:00 -04:00
..
beacon_node.sh	Fix deneb doppelganger tests (#4124 )	2023-04-26 13:26:00 -04:00
bootnode.sh	Fix errors from local testnet scripts on MacOS (#2919 )	2022-01-26 23:14:20 +00:00
clean.sh	Use #!/usr/bin/env everywhere for local testnets (#3606 )	2022-09-29 06:13:30 +00:00
dump_logs.sh	Use #!/usr/bin/env everywhere for local testnets (#3606 )	2022-09-29 06:13:30 +00:00
el_bootnode.sh	Fix deneb doppelganger tests (#4124 )	2023-04-26 13:26:00 -04:00
ganache_test_node.sh	Unify execution layer endpoints (#3214 )	2022-06-29 09:07:09 +00:00
genesis.json	update trusted setup and eth1 balance allocations in testnet genesis	2022-12-09 15:21:10 -05:00
geth.sh	Fix auth port	2022-12-13 15:14:07 +05:30
kill_processes.sh	Working post bellatrix local testnet	2022-12-02 19:50:45 +05:30
README.md	update README of local_testnet (#4114 )	2023-03-30 10:14:07 +00:00
reset_genesis_time.sh	Fix errors from local testnet scripts on MacOS (#2919 )	2022-01-26 23:14:20 +00:00
setup.sh	Fix deneb doppelganger tests (#4124 )	2023-04-26 13:26:00 -04:00
start_local_testnet.sh	Merge commit 'c5383e393acee152e92641ce4699d05913953e70' into eip4844	2023-04-04 11:56:01 -05:00
stop_local_testnet.sh	Fix errors from local testnet scripts on MacOS (#2919 )	2022-01-26 23:14:20 +00:00
validator_client.sh	Working post bellatrix local testnet	2022-12-02 19:50:45 +05:30
vars.env	Fix deneb doppelganger tests (#4124 )	2023-04-26 13:26:00 -04:00

README.md

Simple Local Testnet

These scripts allow for running a small local testnet with multiple beacon nodes and validator clients. This setup can be useful for testing and development.

Requirements

The scripts require lcli and lighthouse to be installed on PATH. From the root of this repository, run:

make
make install-lcli

Starting the testnet

Modify vars.env as desired.

Start a local eth1 ganache server plus boot node along with BN_COUNT number of beacon nodes and VC_COUNT validator clients.

The start_local_testnet.sh script takes four options -v VC_COUNT, -d DEBUG_LEVEL, -p to enable builder proposals and -h for help. The options may be in any order or absent in which case they take the default value specified.

VC_COUNT: the number of validator clients to create, default: BN_COUNT
DEBUG_LEVEL: one of { error, warn, info, debug, trace }, default: info

./start_local_testnet.sh

Stopping the testnet

This is not necessary before start_local_testnet.sh as it invokes stop_local_testnet.sh automatically.

./stop_local_testnet.sh

Manual creation of local testnet

These scripts are used by ./start_local_testnet.sh and may be used to manually

Start a local eth1 ganache server

./ganache_test_node.sh

Assuming you are happy with the configuration in vars.env, deploy the deposit contract, make deposits, create the testnet directory, genesis state and validator keys with:

./setup.sh

Generate bootnode enr and start a discv5 bootnode so that multiple beacon nodes can find each other

./bootnode.sh

Start a beacon node:

./beacon_node.sh <DATADIR> <NETWORK-PORT> <HTTP-PORT> <OPTIONAL-DEBUG-LEVEL>

e.g.

./beacon_node.sh $HOME/.lighthouse/local-testnet/node_1 9000 8000

In a new terminal, start the validator client which will attach to the first beacon node:

./validator_client.sh <DATADIR> <BEACON-NODE-HTTP> <OPTIONAL-DEBUG-LEVEL>

e.g. to attach to the above created beacon node

./validator_client.sh $HOME/.lighthouse/local-testnet/node_1 http://localhost:8000

You can create additional beacon node and validator client instances with appropriate parameters.

Additional Info

Adjusting number and distribution of validators

The VALIDATOR_COUNT parameter is used to specify the number of insecure validator keystores to generate and make deposits for. The BN_COUNT parameter is used to adjust the division of these generated keys among separate validator client instances. For e.g. for VALIDATOR_COUNT=80 and BN_COUNT=4, the validator keys are distributed over 4 datadirs with 20 keystores per datadir. The datadirs are located in $DATADIR/node_{i} which can be passed to separate validator client instances using the --datadir parameter.

Starting fresh

Delete the current testnet and all related files using. Generally not necessary as start_local_test.sh does this each time it starts.

./clean.sh

Updating the genesis time of the beacon state

If it's been a while since you ran ./setup then the genesis time of the genesis state will be far in the future, causing lots of skip slots.

Update the genesis time to now using:

./reset_genesis_time.sh

Note: you probably want to just rerun ./start_local_testnet.sh to start over but this is another option.