Skip to content

Commit 0c877f2

Browse files
bhartnettbhartnett
authored
Update Nimbus README (#3339)
1 parent 98d8b78 commit 0c877f2

File tree

3 files changed

+21
-32
lines changed

3 files changed

+21
-32
lines changed

‎Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,11 +291,11 @@ portal-test-reproducibility:
291291
# Portal tests
292292
all_history_network_custom_chain_tests: | build deps
293293
echo -e $(BUILD_MSG) "build/$@" && \
294-
$(ENV_SCRIPT) nim c -r $(NIM_PARAMS) -d:chronicles_log_level=ERROR -d:mergeBlockNumber:38130 -d:nimbus_db_backend=sqlite -o:build/$@ "portal/tests/history_network_tests/$@.nim"
294+
$(ENV_SCRIPT) nim c -r $(NIM_PARAMS) -d:chronicles_log_level=ERROR -d:mergeBlockNumber:38130 -o:build/$@ "portal/tests/history_network_tests/$@.nim"
295295

296296
all_portal_tests: | build deps
297297
echo -e $(BUILD_MSG) "build/$@" && \
298-
$(ENV_SCRIPT) nim c -r $(NIM_PARAMS) -d:chronicles_log_level=ERROR -d:nimbus_db_backend=sqlite -o:build/$@ "portal/tests/$@.nim"
298+
$(ENV_SCRIPT) nim c -r $(NIM_PARAMS) -d:chronicles_log_level=ERROR -o:build/$@ "portal/tests/$@.nim"
299299

300300
# builds and runs the Portal test suite
301301
portal-test: | all_portal_tests all_history_network_custom_chain_tests

‎README.md‎

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ All consensus-layer client development is happening in parallel in the
2222

2323
## Development Updates
2424

25-
Monthly development updates are shared
26-
[here](https://hackmd.io/jRpxY4WBQJ-hnsKaPDYqTw).
27-
2825
For more detailed write-ups on the development progress, follow the
2926
[Nimbus blog](https://blog.nimbus.team/).
3027

@@ -53,18 +50,18 @@ nix-shell default.nix
5350
# You'll run `make update` after each `git pull`, in the future, to keep those submodules up to date.
5451
# Assuming you have 4 CPU cores available, you can ask Make to run 4 parallel jobs, with "-j4".
5552

56-
make -j4 nimbus
53+
make -j4 nimbus_execution_client
5754

5855
# See available command line options
59-
build/nimbus --help
56+
build/nimbus_execution_client --help
6057

6158
# Start syncing with mainnet
62-
build/nimbus
59+
build/nimbus_execution_client
6360

6461
# Update to latest version
6562
git pull && make update
6663
# Build the newly downloaded version
67-
make -j4 nimbus
64+
make -j4 nimbus_execution_client
6865

6966
# Run tests
7067
make test
@@ -112,7 +109,7 @@ ln -s mingw32-make.exe make.exe
112109
You can now follow those instructions in the previous section. For example:
113110

114111
```bash
115-
make nimbus # build the Nimbus execution client binary
112+
make nimbus_execution_client # build the Nimbus execution client binary
116113
make test # run the test suite
117114
# etc.
118115
```
@@ -144,9 +141,9 @@ cd status
144141
# Raspberry pi doesn't include /usr/local/lib in library search path - need to add
145142
export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
146143

147-
git clone https://github.com/status-im/nimbus.git
144+
git clone https://github.com/status-im/nimbus-eth1.git
148145

149-
cd nimbus
146+
cd nimbus-eth1
150147

151148
# Follow instructions above!
152149
```
@@ -168,15 +165,15 @@ Note, the Ubuntu PRoot is known to contain all Nimbus prerequisites compiled on
168165
apt install git make gcc
169166

170167
# Clone repo and build Nimbus just like above
171-
git clone https://github.com/status-im/nimbus.git
168+
git clone https://github.com/status-im/nimbus-eth1.git
172169

173-
cd nimbus
170+
cd nimbus_execution_client
174171

175-
make
172+
make update
176173

177-
make nimbus
174+
make nimbus_execution_client
178175

179-
build/nimbus
176+
build/nimbus_execution_client
180177
```
181178
### <a name="make-xvars"></a>Experimental make variables
182179

@@ -201,12 +198,6 @@ has the same effect as &lt;variable&gt;=1 (ditto for other numbers.)
201198

202199
Interesting Make variables and targets are documented in the [nimbus-build-system](https://github.com/status-im/nimbus-build-system) repo.
203200

204-
- you can switch the DB backend with a Nim compiler define:
205-
`-d:nimbus_db_backend=...` where the (case-insensitive) value is one of
206-
"rocksdb" (the default), "sqlite", "lmdb"
207-
208-
- the Premix debugging tools are [documented separately](premix/readme.md)
209-
210201
- you can control the Makefile's verbosity with the V variable (defaults to 0):
211202

212203
```bash
@@ -217,8 +208,8 @@ make V=2 test # even more verbose
217208
- same for the [Chronicles log level](https://github.com/status-im/nim-chronicles#chronicles_log_level):
218209

219210
```bash
220-
make LOG_LEVEL=DEBUG nimbus # this is the default
221-
make LOG_LEVEL=TRACE nimbus # log everything
211+
make LOG_LEVEL=DEBUG nimbus_execution_client # this is the default
212+
make LOG_LEVEL=TRACE nimbus_execution_client # log everything
222213
```
223214

224215
- pass arbitrary parameters to the Nim compiler:
@@ -315,7 +306,7 @@ Install Prometheus and Grafana. On Gentoo, it's `emerge prometheus grafana-bin`.
315306

316307
```bash
317308
# build Nimbus execution client
318-
make nimbus
309+
make nimbus_execution_client
319310
# the Prometheus daemon will create its data dir in the current dir, so give it its own directory
320311
mkdir ../my_metrics
321312
# copy the basic config file over there
@@ -349,7 +340,7 @@ to the combined view. To edit a panel, click on its title and select "Edit".
349340

350341
### Troubleshooting
351342

352-
Report any errors you encounter, please, if not [already documented](https://github.com/status-im/nimbus/issues)!
343+
Report any errors you encounter, please, if not [already documented](https://github.com/status-im/nimbus-eth1/issues)!
353344

354345
* Turn it off and on again:
355346

‎nimbus.nimble‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,11 @@ task nimbus_portal_client, "Build nimbus_portal_client":
102102
buildBinary "nimbus_portal_client", "portal/client/", "-d:chronicles_log_level=TRACE"
103103

104104
task portal_test, "Run Portal tests":
105-
# Need the nimbus_db_backend in state network tests as we need a Hexary to
106-
# start from, even though it only uses the MemoryDb.
107-
test "portal/tests/history_network_tests/", "all_history_network_custom_chain_tests", "-d:chronicles_log_level=ERROR -d:nimbus_db_backend=sqlite"
105+
test "portal/tests/history_network_tests/", "all_history_network_custom_chain_tests", "-d:chronicles_log_level=ERROR"
108106
# Seperate build for these tests as they are run with a low `mergeBlockNumber`
109107
# to make the tests faster. Using the real mainnet merge block number is not
110108
# realistic for these tests.
111-
test "portal/tests", "all_portal_tests", "-d:chronicles_log_level=ERROR -d:nimbus_db_backend=sqlite -d:mergeBlockNumber:38130"
109+
test "portal/tests", "all_portal_tests", "-d:chronicles_log_level=ERROR -d:mergeBlockNumber:38130"
112110

113111
task utp_test_app, "Build uTP test app":
114112
buildBinary "utp_test_app", "portal/tools/utp_testing/", "-d:chronicles_log_level=TRACE"
@@ -125,7 +123,7 @@ task nimbus_verified_proxy, "Build Nimbus verified proxy":
125123
buildBinary "nimbus_verified_proxy", "nimbus_verified_proxy/", "-d:chronicles_log_level=TRACE"
126124

127125
task nimbus_verified_proxy_test, "Run Nimbus verified proxy tests":
128-
test "nimbus_verified_proxy/tests", "all_proxy_tests", "-d:chronicles_log_level=ERROR -d:nimbus_db_backend=sqlite"
126+
test "nimbus_verified_proxy/tests", "all_proxy_tests", "-d:chronicles_log_level=ERROR"
129127

130128
task build_fuzzers, "Build fuzzer test cases":
131129
# This file is there to be able to quickly build the fuzzer test cases in

0 commit comments

Comments
 (0)