merge: kiln v2 updates (#1750)

* update random to prevRandao
* improve optimistic sync todo note
* add engine_exchangeTransitionConfigurationV1
* remove kintusgi folder and add wip kiln folder
* update newPayload test (random -> prevRandao)
* update exchangeTransitionConfiguration
* add tests for exchangeTransitionConfigurationV1
* only parse jwtSecret if rpcEngine && rpcEngineAuth
* devnet5 instructions (#1766)
* client: increase json parser size (#1769)
* improve/clarify kiln readme
* touch ups
Co-authored-by: g11tech <76567250+g11tech@users.noreply.github.com>

Author: ryanio

packages/block/src/header.ts

@@ -66,12 +66,12 @@ export class BlockHeader {
   }
 
   /**
-   * EIP-4399: Post-PoS merge, `mixHash` supplanted as `random`
+   * EIP-4399: After merge to PoS, `mixHash` supplanted as `prevRandao`
    */
-  get random() {
+  get prevRandao() {
     if (!this._common.isActivatedEIP(4399)) {
       const msg = this._errorMsg(
-        'The random parameter can only be accessed when EIP-4399 is activated'
+        'The prevRandao parameter can only be accessed when EIP-4399 is activated'
       )
       throw new Error(msg)
     }

packages/block/test/mergeBlock.spec.ts

@@ -105,19 +105,19 @@ tape('[Header]: Casper PoS / The Merge Functionality', function (t) {
     st.end()
   })
 
-  t.test('EIP-4399: random should return mixHash value', function (st) {
+  t.test('EIP-4399: prevRando should return mixHash value', function (st) {
     const mixHash = Buffer.alloc(32, 3)
     let block = Block.fromBlockData({ header: { mixHash } }, { common })
-    st.ok(block.header.random.equals(mixHash), 'random should return mixHash value')
+    st.ok(block.header.prevRandao.equals(mixHash), 'prevRandao should return mixHash value')
 
     const commonLondon = common.copy()
     commonLondon.setHardfork(Hardfork.London)
     block = Block.fromBlockData({ header: { mixHash } }, { common: commonLondon })
     try {
-      block.header.random
+      block.header.prevRandao
       st.fail('should have thrown')
     } catch (e: any) {
-      st.pass('random should throw if EIP-4399 is not activated')
+      st.pass('prevRandao should throw if EIP-4399 is not activated')
     }
     st.end()
   })

packages/client/bin/startRpc.ts

@@ -108,7 +108,8 @@ export function startRPCServers(client: EthereumClient, args: RPCArgs) {
     rpcCors,
   } = args
   const manager = new RPCManager(client, config)
-  const jwtSecret = parseJwtSecret(config, jwtSecretPath)
+  const jwtSecret =
+    rpcEngine && rpcEngineAuth ? parseJwtSecret(config, jwtSecretPath) : Buffer.from([])
 
   if (rpc || ws) {
     const withEngineMethods = rpcEngine && rpcEnginePort === rpcport && rpcEngineAddr === rpcaddr
@@ -148,7 +149,7 @@ export function startRPCServers(client: EthereumClient, args: RPCArgs) {
         withEngineMiddleware: withEngineMethods && rpcEngineAuth ? { jwtSecret } : undefined,
       }
       if (rpcaddr === wsAddr && rpcport === wsPort) {
-        // We want to loadon the websocket upgrade request to the same server
+        // We want to load the websocket upgrade request to the same server
         Object.assign(opts, { httpServer: rpcHttpServer })
       }
 

packages/client/kintsugi/Dockerfile packages/client/kiln/Dockerfilepackages/client/kintsugi/Dockerfile renamed to packages/client/kiln/Dockerfile

@@ -2,7 +2,7 @@ FROM node:16-alpine as build
 WORKDIR /usr/app
 RUN apk update && apk add --no-cache bash git && rm -rf /var/cache/apk/*
 
-RUN git clone --depth 1 --branch merge-kintsugi https://github.com/ethereumjs/ethereumjs-monorepo.git
+RUN git clone --depth 1 --branch merge-kiln-v2 https://github.com/ethereumjs/ethereumjs-monorepo.git
 
 WORKDIR /usr/app/ethereumjs-monorepo
 RUN npm i

packages/client/kiln/README.md

@@ -0,0 +1,60 @@
+# kiln v2 instructions
+
+kiln v2 spec merge-devnet-5 has been bootstrapped.
+
+The config files can be downloaded from https://github.com/eth-clients/merge-testnets/tree/main/merge-devnet-5
+
+## Execution - EthereumJS Setup
+
+Please ensure you have Node 12.x+ installed.
+
+1. `git clone --depth 1 --branch merge-kiln-v2 https://github.com/ethereumjs/ethereumjs-monorepo.git`
+1. `cd ethereumjs-monorepo`
+1. `npm i`
+1. `cd packages/client`
+
+### Download the config
+
+1. `cd kiln`
+2. `git init && git remote add -f origin https://github.com/eth-clients/merge-testnets.git && git config core.sparseCheckout true && echo "merge-devnet-5/*" >> .git/info/sparse-checkout && git pull --depth=1 origin main`
+
+This will download the config files to `kiln/merge-devnet-5`.
+
+### Run client
+
+1. `npm run client:start -- --datadir kiln/datadir --gethGenesis kiln/merge-devnet-5/genesis.json --saveReceipts --rpc --ws --rpcEngine --rpcEnginePort=8545 --bootnodes=`
+
+Starting the client will write a `kiln/datadir/jwtsecret` file with a randomly generated secret to be used in conjunction with a CL client. To prevent the secret to be re-generated next time you restart the client, pass the file as an argument to read from via `--jwt-secret=kiln/datadir/jwtsecret`.
+
+#### Docker
+
+Or try it in Docker.
+
+In `packages/client/kiln` run:
+
+`docker-compose --file docker-compose.ethereumjs.yml up`
+
+## Consensus
+
+### Lodestar
+
+#### Beacon
+
+1. Use lodestar branch `master` and run `yarn && yarn build`
+2. Export path of the downloaded config dir `export CONFIG_PATH=/path/to/ethereumjs-monorepo/packages/client/kiln/merge-devnet-5`
+3. Export path of the written jwt secret file `export JWT_SECRET_PATH=/path/to/ethereumjs-monorepo/packages/client/kiln/datadir/jwtsecret`
+4. Run cmd: `./lodestar beacon --rootDir kiln/temp --paramsFile $CONFIG_PATH/config.yaml --genesisStateFile $CONFIG_PATH/genesis.ssz --bootnodesFile $CONFIG_PATH/boot_enr.yaml --network.connectToDiscv5Bootnodes --network.discv5.enabled true --eth1.enabled true --eth1.providerUrls=http://localhost:8545 --execution.urls=http://localhost:8545 --eth1.disableEth1DepositDataTracker true --jwt-secret $JWT_SECRET_PATH`
+
+#### Validator
+
+1. Run cmd: `./lodestar validator --rootDir=kiln/temp_validatordata --paramsFile=$CONFIG_PATH/config.yaml --keystoresDir=kiln/keystores --secretsDir=kiln/secrets`
+
+Also, one will need to remove `--eth1.disableEth1DepositDataTracker true` and instead provide `--eth1.depositContractDeployBlock <block number>` in the previous beacon start command. The block number can be extracted from `kiln/merge-devnet-5/deposit_contract_block.txt`
+
+### Lighthouse
+
+### Beacon
+
+1. Use lighthouse branch `unstable` and run `make`
+1. Make dir `lighthouse/kiln` and copy in from the downloaded config dir: `config.yaml`, `genesis.ssz`, `deploy_block.txt`, `deposit_contract.txt`, `deposit_contract_block.txt`
+1. Run cmd: `lighthouse --debug-level=info --datadir=kiln/datadir --testnet-dir=kiln beacon_node --disable-enr-auto-update --dummy-eth1 --boot-nodes="enr:" --merge --http-allow-sync-stalled --metrics --disable-packet-filter --execution-endpoints=http://127.0.0.1:8545 --terminal-total-difficulty-override=`