Skip to content

Commit fdc372f

Browse files
authored
feat(docs): mention database compatibility in README.md (#6875)
1 parent e0fc334 commit fdc372f

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# reth
1+
# reth
22

33
[![CI status](https://github.com/paradigmxyz/reth/workflows/ci/badge.svg)][gh-ci]
44
[![cargo-deny status](https://github.com/paradigmxyz/reth/workflows/deny/badge.svg)][gh-deny]
@@ -14,7 +14,7 @@
1414
| [Developer Docs](./docs)
1515
| [Crate Docs](https://paradigmxyz.github.io/reth/docs)
1616

17-
*The project is still work in progress, see the [disclaimer below](#status).*
17+
_The project is still work in progress, see the [disclaimer below](#status)._
1818

1919
[codecov]: https://app.codecov.io/gh/paradigmxyz/reth
2020
[gh-ci]: https://github.com/paradigmxyz/reth/actions/workflows/ci.yml
@@ -50,6 +50,14 @@ We will be updating the documentation with the completion status of each compone
5050

5151
We appreciate your patience until we get there. Until then, we are happy to answer all questions in the Telegram link above.
5252

53+
### Database compatibility
54+
55+
Reth [v0.2.0-beta.1](https://github.com/paradigmxyz/reth/releases/tag/v0.2.0-beta.1) includes
56+
a [set of breaking database changes](https://github.com/paradigmxyz/reth/pull/5191) that makes it impossible to use database files produced by earlier versions.
57+
58+
If you had a database produced by alpha versions of Reth, you need to drop it with `reth db drop`
59+
(using the same arguments such as `--config` or `--datadir` that you passed to `reth node`), and resync using the same `reth node` command you've used before.
60+
5361
## For Users
5462

5563
See the [Reth Book](https://paradigmxyz.github.io/reth) for instructions on how to install and run Reth.
@@ -105,15 +113,15 @@ cargo test --workspace --features geth-tests
105113
# With Ethereum Foundation tests
106114
#
107115
# Note: Requires cloning https://github.com/ethereum/tests
108-
#
116+
#
109117
# cd testing/ef-tests && git clone https://github.com/ethereum/tests ethereum-tests
110118
cargo test -p ef-tests --features ef-tests
111119
```
112120

113121
We recommend using [`cargo nextest`](https://nexte.st/) to speed up testing. With nextest installed, simply substitute `cargo test` with `cargo nextest run`.
114122

115123
> **Note**
116-
>
124+
>
117125
> Some tests use random number generators to generate test data. If you want to use a deterministic seed, you can set the `SEED` environment variable.
118126
119127
## Getting Help
@@ -135,9 +143,10 @@ See [`SECURITY.md`](./SECURITY.md).
135143
Reth is a new implementation of the Ethereum protocol. In the process of developing the node we investigated the design decisions other nodes have made to understand what is done well, what is not, and where we can improve the status quo.
136144

137145
None of this would have been possible without them, so big shoutout to the teams below:
138-
* [Geth](https://github.com/ethereum/go-ethereum/): We would like to express our heartfelt gratitude to the go-ethereum team for their outstanding contributions to Ethereum over the years. Their tireless efforts and dedication have helped to shape the Ethereum ecosystem and make it the vibrant and innovative community it is today. Thank you for your hard work and commitment to the project.
139-
* [Erigon](https://github.com/ledgerwatch/erigon) (fka Turbo-Geth): Erigon pioneered the ["Staged Sync" architecture](https://erigon.substack.com/p/erigon-stage-sync-and-control-flows) that Reth is using, as well as [introduced MDBX](https://github.com/ledgerwatch/erigon/wiki/Choice-of-storage-engine) as the database of choice. We thank Erigon for pushing the state of the art research on the performance limits of Ethereum nodes.
140-
* [Akula](https://github.com/akula-bft/akula/): Reth uses forks of the Apache versions of Akula's [MDBX Bindings](https://github.com/paradigmxyz/reth/pull/132), [FastRLP](https://github.com/paradigmxyz/reth/pull/63) and [ECIES](https://github.com/paradigmxyz/reth/pull/80) . Given that these packages were already released under the Apache License, and they implement standardized solutions, we decided not to reimplement them to iterate faster. We thank the Akula team for their contributions to the Rust Ethereum ecosystem and for publishing these packages.
146+
147+
- [Geth](https://github.com/ethereum/go-ethereum/): We would like to express our heartfelt gratitude to the go-ethereum team for their outstanding contributions to Ethereum over the years. Their tireless efforts and dedication have helped to shape the Ethereum ecosystem and make it the vibrant and innovative community it is today. Thank you for your hard work and commitment to the project.
148+
- [Erigon](https://github.com/ledgerwatch/erigon) (fka Turbo-Geth): Erigon pioneered the ["Staged Sync" architecture](https://erigon.substack.com/p/erigon-stage-sync-and-control-flows) that Reth is using, as well as [introduced MDBX](https://github.com/ledgerwatch/erigon/wiki/Choice-of-storage-engine) as the database of choice. We thank Erigon for pushing the state of the art research on the performance limits of Ethereum nodes.
149+
- [Akula](https://github.com/akula-bft/akula/): Reth uses forks of the Apache versions of Akula's [MDBX Bindings](https://github.com/paradigmxyz/reth/pull/132), [FastRLP](https://github.com/paradigmxyz/reth/pull/63) and [ECIES](https://github.com/paradigmxyz/reth/pull/80) . Given that these packages were already released under the Apache License, and they implement standardized solutions, we decided not to reimplement them to iterate faster. We thank the Akula team for their contributions to the Rust Ethereum ecosystem and for publishing these packages.
141150

142151
[book]: https://paradigmxyz.github.io/reth/
143152
[tg-url]: https://t.me/paradigm_reth

0 commit comments

Comments
 (0)