Reth #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

MatusKysel wants to merge 15 commits into main from reth

.env

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,4 +1,4 @@
  
    BSC_CLUSTER_SIZE=4 # 3f+1

    BSC_CLUSTER_SIZE=10

    CHAIN_ID=714

    KEYPASS="0123456789"

    INIT_HOLDER="0x04d63aBCd2b9b1baa327f2Dda0f873F197ccd186"

    @@ -11,8 +11,11 @@ FullImmutabilityThreshold=2048
  
    MinBlocksForBlobRequests=576

    DefaultExtraReserveForBlobRequests=32

    BreatheBlockInterval=1200

    useLatestBscClient=false

    useLatestBscClient=true

    EnableSentryNode=false

    EnableFullNode=false

    RegisterNodeID=false

    EnableEVNWhitelist=false

    RETH_BSC_BINARY_PATH="/Users/user/development/reth-bsc/target/debug/reth-bsc"

    RETH_NODE_COUNT=1

    BSC_SUBMIT_BUILT_PAYLOAD=true

README.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -40,6 +40,24 @@ go build @@
        - `.env`
     ```
+    **Reth-BSC Configuration:**
+    To use reth-bsc nodes instead of geth nodes for some validators, configure the following in `.env`:
+    ```bash
+    # Path to the reth-bsc binary
+    RETH_BSC_BINARY_PATH="/path/to/reth-bsc/target/debug/reth-bsc"
+    # Number of nodes to run with reth-bsc (starting from node0)
+    # For example: RETH_NODE_COUNT=2 will run node0 and node1 with reth-bsc, others with geth
+    RETH_NODE_COUNT=1
+    ```
+    Reth-BSC nodes are launched with BLS vote key CLI flags by default:
+    - `--bls.keystore-path` and `--bls.keystore-password` are auto-detected from each node’s `bls/keystore` and `${KEYPASS}`.
+    - To override, set either of the following envs before start (the script will pass them as CLI, which takes precedence over env inside reth):
+      - `BSC_BLS_PRIVATE_KEY` (dev only) → passes `--bls.private-key`
+      - `BSC_BLS_KEYSTORE_PATH` and `BSC_BLS_KEYSTORE_PASSWORD` → passes `--bls.keystore-path` and `--bls.keystore-password`
 . Setup all nodes.
     two different ways, choose as you like.
     ```bash
@@ Expand Down Expand Up / @@ -87,4 +105,4 @@ go build @@
     cd txblob
     go build
     ./txblob
-    ```
+    ```

bin/.gitkeep

This file was deleted.

bsc_cluster.sh

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -16,10 +16,73 @@ gcmode="full"
  
    sleepBeforeStart=15

    sleepAfterStart=10

    # stop geth client

    # Validation function for reth-bsc configuration

    function validate_reth_config() {

        # Check if RETH_NODE_COUNT is set and valid

        if [ -z "$RETH_NODE_COUNT" ]; then

            RETH_NODE_COUNT=0

            echo "RETH_NODE_COUNT not set, defaulting to 0 (all geth nodes)"

            return 0

        fi

        # Check if RETH_NODE_COUNT is not greater than total cluster size

        if [ $RETH_NODE_COUNT -gt $size ]; then

            echo "ERROR: RETH_NODE_COUNT ($RETH_NODE_COUNT) cannot be greater than BSC_CLUSTER_SIZE ($size)"

            echo "Please adjust RETH_NODE_COUNT in .env file to be <= $size"

            exit 1

        fi

        # Check if RETH_NODE_COUNT is negative

        if [ $RETH_NODE_COUNT -lt 0 ]; then

            echo "ERROR: RETH_NODE_COUNT ($RETH_NODE_COUNT) cannot be negative"

            echo "Please set RETH_NODE_COUNT to a value between 0 and $size in .env file"

            exit 1

        fi

        # If RETH_NODE_COUNT > 0, check if reth-bsc binary exists and is executable

        if [ $RETH_NODE_COUNT -gt 0 ]; then

            if [ -z "$RETH_BSC_BINARY_PATH" ]; then

                echo "ERROR: RETH_BSC_BINARY_PATH is not set in .env file"

                echo "Please set RETH_BSC_BINARY_PATH to the path of your reth-bsc binary"

                exit 1

            fi

            if [ ! -f "$RETH_BSC_BINARY_PATH" ]; then

                echo "ERROR: reth-bsc binary not found at: $RETH_BSC_BINARY_PATH"

                echo "Please check the RETH_BSC_BINARY_PATH in .env file and ensure the binary exists"

                exit 1

            fi

            if [ ! -x "$RETH_BSC_BINARY_PATH" ]; then

                echo "ERROR: reth-bsc binary is not executable: $RETH_BSC_BINARY_PATH"

                echo "Please make the binary executable with: chmod +x $RETH_BSC_BINARY_PATH"

                exit 1

            fi

            echo "✓ Validated: Will run $RETH_NODE_COUNT reth-bsc nodes (node0-node$((RETH_NODE_COUNT-1))) and $((size-RETH_NODE_COUNT)) geth nodes"

        else

            echo "✓ Validated: Will run all $size nodes with geth (no reth-bsc nodes)"

        fi

    }

    # stop geth client and reth-bsc

    function exit_previous() {

        ValIdx=$1

        ps -ef  | grep geth$ValIdx | grep config |awk '{print $2}' | xargs kill

        if [ ! -z $ValIdx ]; then

            if [ $ValIdx -lt $RETH_NODE_COUNT ]; then

                # Stop reth-bsc for reth nodes (first RETH_NODE_COUNT nodes)

                ps -ef | grep reth-bsc | grep -v grep | awk '{print $2}' | xargs -r kill

            else

                # Stop geth for other nodes

                ps -ef  | grep geth$ValIdx | grep config |awk '{print $2}' | xargs -r kill

            fi

        else

            # Stop all nodes

            ps -ef | grep reth-bsc | grep -v grep | awk '{print $2}' | xargs -r kill

            for ((i = 0; i < size; i++)); do

                ps -ef  | grep geth$i | grep config |awk '{print $2}' | xargs -r kill

            done

        fi

        sleep ${sleepBeforeStart}

    }

    @@ -169,6 +232,10 @@ function initNetwork() {
  
            initLog=${workspace}/.local/node${i}/init.log

            if  [ $i -eq 0 ] ; then

                ${workspace}/bin/geth --datadir ${workspace}/.local/node${i} init --state.scheme ${stateScheme} --db.engine ${dbEngine} ${workspace}/genesis/genesis.json  > "${initLog}" 2>&1

            elif  [ $i -lt $RETH_NODE_COUNT ] ; then

                # Skip geth init for reth-bsc nodes, just copy genesis and create a dummy init log

                cp ${workspace}/genesis/genesis.json ${workspace}/.local/node${i}/genesis.json

                echo "reth-bsc init: genesis.json copied for reth-bsc node${i}" > "${initLog}" 2>&1

            else

                ${workspace}/bin/geth --datadir ${workspace}/.local/node${i} init --state.scheme path --db.engine pebble ${workspace}/genesis/genesis.json  > "${initLog}" 2>&1

            fi

    @@ -190,6 +257,166 @@ function initNetwork() {
  
        fi

    }

    function start_reth_bsc() {

        local nodeIndex=$1

        local HTTPPort=$2

        local WSPort=$3

        local PassedForkTime=$4

        local LastHardforkTime=$5

        local rialtoHash=$6

        # Copy and modify genesis.json for reth-bsc with correct fork timing

        cp ${workspace}/genesis/genesis.json ${workspace}/.local/node${nodeIndex}/genesis.json

        # Modify fork times in genesis.json for reth-bsc: all forks at PassedForkTime except fermi at LastHardforkTime

        jq --arg passedTime "$PassedForkTime" --arg lastTime "$LastHardforkTime" '

            .config.shanghaiTime = ($passedTime | tonumber) |

            .config.keplerTime = ($passedTime | tonumber) |

            .config.feynmanTime = ($passedTime | tonumber) |

            .config.feynmanFixTime = ($passedTime | tonumber) |

            .config.cancunTime = ($passedTime | tonumber) |

            .config.haberTime = ($passedTime | tonumber) |

            .config.haberFixTime = ($passedTime | tonumber) |

            .config.lorentzTime = ($passedTime | tonumber) |

            .config.bohrTime = ($passedTime | tonumber) |

            .config.tychoTime = ($passedTime | tonumber) |

            .config.pragueTime = ($passedTime | tonumber) |

            .config.pascalTime = ($passedTime | tonumber) |

            .config.maxwellTime = ($passedTime | tonumber) |

            .config.fermiTime = ($lastTime | tonumber) |

            .config.osakaTime = ($lastTime | tonumber) |

            .config.mendelTime = ($lastTime | tonumber)

        ' ${workspace}/.local/node${nodeIndex}/genesis.json > ${workspace}/.local/node${nodeIndex}/genesis_reth.json

        if [ ${EnableSentryNode} = true ]; then

            cp ${workspace}/.local/node${nodeIndex}/genesis_reth.json ${workspace}/.local/sentry${nodeIndex}/genesis_reth.json

        fi

        # Get the first bootnode enode from BootstrapNodes configuration

        # Extract the complete first bootnode entry (including the full enode:// URL)

        bootnode_enode=$(grep -E "BootstrapNodes" ${workspace}/.local/node${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

        staic_enode=$(grep -E "StaticNodes" ${workspace}/.local/node${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

        # Extract discovery port from the current node's config.toml ListenAddr

        discovery_port=$(grep "ListenAddr" ${workspace}/.local/node${nodeIndex}/config.toml | sed 's/.*:\([0-9]*\).*/\1/')

        auth_port=$((8551+nodeIndex))

        # Detect keystore path dynamically

        keystore_path=$(find ${workspace}/.local/node${nodeIndex}/keystore -name "UTC--*" -type f | head -1)

        nodekey_path=$(find ${workspace}/.local/node${nodeIndex}/geth/nodekey -type f | head -1)

        peer_conf=()

        if [ -n "${bootnode_enode}" ]; then

            peer_conf+=(--bootnodes ${bootnode_enode})

        fi

        if [ -n "${staic_enode}" ]; then

            peer_conf+=(--trusted-peers ${staic_enode})

        fi

        # Determine BLS signer CLI args (prefer CLI over env)

        # Priority:

        # 1) BSC_BLS_PRIVATE_KEY -> use direct private key (dev only)

        # 2) BSC_BLS_KEYSTORE_PATH + BSC_BLS_KEYSTORE_PASSWORD -> use provided keystore

        # 3) Auto-detected keystore in node dir + KEYPASS from .env

        bls_keystore_path=$(find ${workspace}/.local/node${nodeIndex}/bls/keystore -name "*.json" -type f | head -1)

        bls_cli_args=()

        if [ -n "${BSC_BLS_PRIVATE_KEY}" ]; then

            bls_cli_args+=(--bls.private-key "${BSC_BLS_PRIVATE_KEY}")

        elif [ -n "${BSC_BLS_KEYSTORE_PATH}" ] && [ -n "${BSC_BLS_KEYSTORE_PASSWORD}" ]; then

            bls_cli_args+=(--bls.keystore-path "${BSC_BLS_KEYSTORE_PATH}" --bls.keystore-password "${BSC_BLS_KEYSTORE_PASSWORD}")

        else

            if [ -z "${bls_keystore_path}" ]; then

                echo "WARNING: No BLS keystore found for node${nodeIndex}; reth-bsc may fall back to env if configured" >&2

            fi

            bls_cli_args+=(--bls.keystore-path "${bls_keystore_path}" --bls.keystore-password "${KEYPASS}")

        fi

        evn_conf=()

        if [ ${EnableSentryNode} = true ]; then

            evn_conf+=(--evn.enabled)

            add_nodeid=$(grep -E "EVNNodeIDsToAdd" ${workspace}/.local/node${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

            if [ -n "${add_nodeid}" ]; then

                evn_conf+=(--evn.add-nodeid ${add_nodeid})

            fi

            remove_nodeid=$(grep -E "EVNNodeIDsToRemove" ${workspace}/.local/node${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

            if [ -n "${remove_nodeid}" ]; then

                evn_conf+=(--evn.remove-nodeid ${remove_nodeid})

            fi

        fi

        echo "node${nodeIndex}, nodekey_path: ${nodekey_path}, peer_conf: ${peer_conf[@]}, evn_conf: ${evn_conf[@]}"

        # Run reth-bsc node

        nohup env RUST_LOG=debug BREATHE_BLOCK_INTERVAL=${BreatheBlockInterval} BSC_SUBMIT_BUILT_PAYLOAD=${BSC_SUBMIT_BUILT_PAYLOAD} ${RETH_BSC_BINARY_PATH} node \

            --chain ${workspace}/.local/node${nodeIndex}/genesis_reth.json \

            --datadir ${workspace}/.local/node${nodeIndex} \

            --genesis-hash ${rialtoHash} \

            --disable-discovery \

            --http \

            --http.addr 0.0.0.0 \

            --http.port ${HTTPPort} \

            --p2p-secret-key ${nodekey_path} \

            --ws \

            --ws.addr 0.0.0.0 \

            --ws.port $((${WSPort})) \

            --discovery.addr 0.0.0.0 \

            --discovery.port ${discovery_port} \

            --authrpc.port ${auth_port} \

            --port ${discovery_port} \

            ${peer_conf[@]} \

            ${evn_conf[@]} \

            --mining.enabled \

            --mining.min-gas-tip 1000000000 \

            --mining.keystore-path ${keystore_path} \

            --mining.keystore-password ${KEYPASS} "${bls_cli_args[@]}" \

            --log.stdout.format log-fmt --engine.persistence-threshold 10 --engine.memory-block-buffer-target 128 \

            >> ${workspace}/.local/node${nodeIndex}/reth.log 2>&1 &

        if [ ${EnableSentryNode} = true ]; then

            discovery_port=$(grep "ListenAddr" ${workspace}/.local/sentry${nodeIndex}/config.toml | sed 's/.*:\([0-9]*\).*/\1/')

            nodekey_path=$(find ${workspace}/.local/sentry${i}/geth/nodekey -type f | head -1)

            bootnode_enode=$(grep -E "BootstrapNodes" ${workspace}/.local/sentry${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

            staic_enode=$(grep -E "StaticNodes" ${workspace}/.local/sentry${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

            peer_conf=()

            if [ -n "${bootnode_enode}" ]; then

                peer_conf+=(--bootnodes ${bootnode_enode})

            fi

            if [ -n "${staic_enode}" ]; then

                peer_conf+=(--trusted-peers ${staic_enode})

            fi

            evn_conf=()

            evn_conf+=(--evn.enabled)

            whitelist_nodeid=$(grep -E "EVNNodeIdsWhitelist" ${workspace}/.local/sentry${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

            if [ -n "${whitelist_nodeid}" ]; then

                evn_conf+=(--evn.whitelist-nodeids ${whitelist_nodeid})

            fi

            proxyed_val=$(grep -E "ProxyedValidatorAddresses" ${workspace}/.local/sentry${nodeIndex}/config.toml | grep -o '\[".*"\]' | sed 's/\["//;s/"\]//;s/", "/,/g')

            if [ -n "${proxyed_val}" ]; then

                evn_conf+=(--evn.proxyed-validator ${proxyed_val})

            fi

            echo "sentry${nodeIndex}, nodekey_path: ${nodekey_path}, peer_conf: ${peer_conf[@]}, evn_conf: ${evn_conf[@]}"

            nohup env RUST_LOG=debug BREATHE_BLOCK_INTERVAL=${BreatheBlockInterval} ${RETH_BSC_BINARY_PATH} node \

                --chain ${workspace}/.local/sentry${nodeIndex}/genesis_reth.json \

                --datadir ${workspace}/.local/sentry${nodeIndex} \

                --genesis-hash ${rialtoHash} \

                --disable-discovery \

                --http \

                --http.addr 0.0.0.0 \

                --http.port $((HTTPPort+1)) \

                --p2p-secret-key ${nodekey_path} \

                --ws \

                --ws.addr 0.0.0.0 \

                --ws.port $((WSPort+1)) \

                --discovery.addr 0.0.0.0 \

                --discovery.port ${discovery_port} \

                --authrpc.port $((auth_port+1)) \

                --port ${discovery_port} \

                ${peer_conf[@]} \

                ${evn_conf[@]} \

                --log.stdout.format log-fmt \

                >> ${workspace}/.local/sentry${nodeIndex}/reth.log 2>&1 &

        fi

    }

    function start_node() {

        local type=$1       # node | sentry | full

        local idx=$2        # index (validator/sentry)，full default 0

    @@ -232,35 +459,42 @@ function native_start() {
  
        LastHardforkTime=$(expr ${PassedForkTime} + ${LAST_FORK_MORE_DELAY})

        rialtoHash=`cat ${workspace}/.local/node0/init.log|grep "database=chaindata"|awk -F"=" '{print $NF}'|awk -F'"' '{print $1}'`

        for ((i=0; i<size; i++)); do

        ValIdx=$1

        for ((i = 0; i < size; i++)); do

            sleep 2

            datadir="${workspace}/.local/node${i}"

            # optional: ValIdx filtering

            if [ ! -z "$1" ] && [ $i -ne $1 ]; then

            if [ ! -z "$ValIdx" ] && [ $i -ne $ValIdx ]; then

                continue

            fi

            # get validator address

            cons_addr="0x$(jq -r .address ${datadir}/keystore/*)"

            cp ${workspace}/bin/geth ${datadir}/geth${i}

            base=$((8545 + i*2))

            start_node "node" $i $datadir "${datadir}/geth${i}" "${cons_addr}" \

                $base $base $((6060+i*2)) $((7060+i*2))

        done

            HTTPPort=$((8545 + i*2))

            WSPort=${HTTPPort}

            MetricsPort=$((6060 + i*2))

            PProfPort=$((7060 + i*2))

        if [ ${EnableSentryNode} = true ]; then

            sleep 10

            for ((i=0; i<size; i++)); do

                datadir="${workspace}/.local/sentry${i}"

            # Handle reth-bsc for first RETH_NODE_COUNT nodes, geth for others

            if [ $i -lt $RETH_NODE_COUNT ]; then

                # TODO: there are not supported flags, may support later

                # --override.breatheblockinterval --override.minforblobrequest --MetricsPort

                start_reth_bsc $i $HTTPPort $WSPort $PassedForkTime $LastHardforkTime $rialtoHash

            else

                cp ${workspace}/bin/geth ${datadir}/geth${i}

                start_node "node" $i $datadir "${datadir}/geth${i}" "${cons_addr}" \

                    $HTTPPort $WSPort $MetricsPort $PProfPort

                base=$((8545 + i*2))

                start_node "sentry" $i $datadir "${datadir}/geth${i}" "" \

                    $((base+1)) $((base+1)) $((6060+i*2+1)) $((7060+i*2+1))

            done

        fi

                if [ ${EnableSentryNode} = true ]; then

                    sentry_datadir="${workspace}/.local/sentry${i}"

                    cp ${workspace}/bin/geth ${sentry_datadir}/geth${i}

                    start_node "sentry" $i $sentry_datadir "${sentry_datadir}/geth${i}" "" \

                        $((HTTPPort+1)) $((WSPort+1)) $((MetricsPort+1)) $((PProfPort+1))

                fi

            fi

        done

        if [ ${EnableFullNode} = true ]; then

            datadir="${workspace}/.local/fullnode0"

    @@ -286,6 +520,7 @@ CMD=$1
  
    ValidatorIdx=$2

    case ${CMD} in

    reset)

        validate_reth_config

        exit_previous

        create_validator

        prepare_bsc_client

    @@ -296,12 +531,15 @@ reset)
  
        register_stakehub

        ;;

    stop)

        validate_reth_config

        exit_previous $ValidatorIdx

        ;;

    start)

        validate_reth_config

        native_start $ValidatorIdx

        ;;

    restart)

        validate_reth_config

        exit_previous $ValidatorIdx

        native_start $ValidatorIdx

        ;;

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reth #114

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Reth #114

Are you sure you want to change the base?

Uh oh!

Reth #114

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!