Skip to content

Commit

Permalink
Update outdated parts of README (ethereum#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
avalonche committed Feb 6, 2023
1 parent 4516e7d commit 6ba82c8
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Official Golang execution layer implementation of the Ethereum protocol.

Builder API implementing [builder spec](https://github.com/ethereum/builder-specs), making geth into a standalone block builder.

Run on your favorite network, including Mainnet, Goerli, Sepolia and local devnet.
Run on your favorite network, including Mainnet, Goerli, Sepolia and local devnet. Instructions for running a pos local devnet can be found [here](https://github.com/avalonche/eth-pos-devnet).

Requires forkchoice update to be sent for block building, on public testnets run beacon node modified to send forkchoice update on every slot [example modified beacon client (lighthouse)](https://github.com/flashbots/lighthouse)
You will need to run a modified beacon node that sends a custom rpc call to trigger block building. You can use the modified [prysm fork](https://github.com/flashbots/prysm) for this.

For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth).

Expand Down Expand Up @@ -133,17 +133,11 @@ Ropsten test network is based on the Ethash proof-of-work consensus algorithm. A
it has certain extra overhead and is more susceptible to reorganization attacks due to the
network's low difficulty/security.

* Builder polls relay for the proposer registrations for the next epoch

Builder has two hooks into geth:
* On forkchoice update, changing the payload attributes feeRecipient to the one registered for next slot's validator
* On new sealed block, consuming the block as the next slot's proposed payload and submits it to the relay

Local relay is enabled by default and overwrites remote relay data. This is only meant for the testnets!
* Builder polls relay for the proposer registrations for the next epoch when block building is triggered
* If both local relay and remote relay are enabled, local relay will overwrite remote relay data. This is only meant for the testnets!

## Limitations

* Blocks are only built on forkchoice update call from beacon node
* Does not accept external blocks
* Does not have payload cache, only the latest block is available

Expand Down

0 comments on commit 6ba82c8

Please sign in to comment.