Skip to content

Commit

Permalink
docs: update for new devp2p simulator
Browse files Browse the repository at this point in the history
  • Loading branch information
fjl committed Feb 10, 2022
1 parent de47408 commit 98767c8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ Ethereum client implementations. You can find the latest test results at
This is an overview of some of the simulators which are currently implemented and running
continuously on the production hive instance:

- `devp2p/eth`, `devp2p/discv4`: These simulators run the 'eth' peer-to-peer protocol
tests and Discovery v4 protocol tests. The test suites themselves are maintained in the
go-ethereum repository. In their hive adaptation, the simulator launches the client with
a known test chain, obtains its peer-to-peer endpoint (the `enode://` URL) and sends
protocol messages to it. The client's responses are analyzed by the test suite to ensure
that they conform to the respective protocol specification.
- `devp2p`: This simulator runs 'eth', 'snap' and 'discv4' peer-to-peer protocol tests.
The test suites themselves are maintained in the go-ethereum repository. In their hive
adaptation, the simulator launches the client with a known test chain, obtains its
peer-to-peer endpoint (the `enode://` URL) and sends protocol messages to it. The
client's responses are analyzed by the test suite to ensure that they conform to the
respective protocol specification.

- `ethereum/sync`: This simulator attempts to synchronize the blockchain among all
clients. For each enabled client implementation, it creates one instance of the client
Expand Down
6 changes: 3 additions & 3 deletions docs/simulators.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,9 @@ The simulator needs to have a Dockerfile in order to run.

As can be seen in the client test `Files:` part, the simulation requires a `genesis.json`
file that specifies the genesis state of the client. An example of `genesis.json` can be
found in the `simulators/devp2p/eth/init/` directory. You can copy an existing genesis
block or create your own. Make sure to add all support files to container in the
Dockerfile. The Dockerfile might look like this:
found in the `simulators/devp2p/init/` directory. You can copy an existing genesis block
or create your own. Make sure to add all support files to container in the Dockerfile. The
Dockerfile might look like this:

FROM golang:1-alpine AS builder
RUN apk --no-cache add gcc musl-dev linux-headers
Expand Down

0 comments on commit 98767c8

Please sign in to comment.