Commit Graph

452 Commits

Author SHA1 Message Date
Jacek Sieka c3a0e4ec16
API doc fixes
`getSpecPreset` was removed pre-1.0.0 and has never worked - debug calls
were renamed around 1.1.0.
2021-08-16 18:41:13 +02:00
0xmiel 01f78fb93e
update links to joe's guides (#2775) 2021-08-11 15:29:49 +02:00
0xmiel fe96c3e993
add page on security audit (#2774)
* add page on security audit

* incorporate feedback
2021-08-11 15:16:02 +02:00
Jacek Sieka 3d7bee8502
REST API client, JSON-RPC cleanups (#2756)
This refactoring puts the JSON-RPC and REST APIs on more equal footing
by renaming and moving things around, creating a separation between
client and server, and documenting what they are - the aim is to have a
simple-to-use base to start from when developing API clients, as well as
make it easier to navigate the code when looking for the legacy JSON-RPC
interface vs the new REST API.

* move REST client, serialization and supporting types to spec/eth2_apis
* REST stuff now starts with `rest_`, JSON-RPC stuff starts with `rpc_`,
more or less
* simplify imports such that there's a simple module to import for both
server and client
* map REST type and proc names to yaml spec more closely - in
particular, reuse operation and type names in `rest_types` to make
comparisons against spec more easy
* cleaner separation between client and server modules - modules common
between server and client such as `rest_types` and serialization move to
the spec folder - this allows the client to be built with less knowledge
about server internals
2021-08-03 17:17:11 +02:00
zah d9f2a91374
Remove the obsolete testnet0/1 scripts (#2727)
Also fixes `make eth2_network_simulation`
2021-07-16 13:02:27 +03:00
0xmiel bb0a086be3
book updates (#2721)
* cp

* rename API to JSON-RPC API

* rename api to json-rpc api, add rest api page

* remove extra emacs generated file

* remove extra emacs generated file
2021-07-14 13:14:39 +02:00
zah eb2dc5cbbb
Implement the new Altair req/resp protocols (#2676)
* Implement the new Altair req/resp protocols

Also fixes the altair message-id computation by providing the correct
forkdigest prefix in `isAltairTopic`.

Co-authored-by: Tanguy Cizain <tanguycizain@gmail.com>
2021-07-07 12:09:47 +03:00
0xmiel 3c7d10cd2a
misc book updates (#2702) 2021-07-05 16:17:35 +02:00
Ștefan Talpalaru c0bbdb0f9f
bin dist related docs (#2684)
* bin dist related docs

* Update docker/README.md

Co-authored-by: 0xmiel <sacha@status.im>

* Update docker/README.md

Co-authored-by: 0xmiel <sacha@status.im>

* Update docker/README.md

Co-authored-by: 0xmiel <sacha@status.im>

* Update docs/the_nimbus_book/src/binaries.md

Co-authored-by: 0xmiel <sacha@status.im>

* Update docs/the_nimbus_book/src/distribution_internals.md

Co-authored-by: 0xmiel <sacha@status.im>

* Update docs/the_nimbus_book/src/distribution_internals.md

Co-authored-by: 0xmiel <sacha@status.im>

* Update docs/the_nimbus_book/src/binaries.md

Co-authored-by: 0xmiel <sacha@status.im>

Co-authored-by: 0xmiel <sacha@status.im>
2021-07-05 12:31:25 +02:00
0xmiel 72544f06c0
Update FAQ + minor edits (#2678) 2021-06-25 11:52:06 +02:00
0xmiel 42738848f3
Update keep-updated.md
fix typo
2021-06-22 12:05:57 +02:00
0xmiel fed0a1dc00
update keep updated page (#2665) 2021-06-21 22:50:26 +02:00
0xmiel 96c489bb3d
Faq update + misc edits (#2653)
* update faq with permissions help, link in migration guide and importing keys

* add link to Git for Windows

* update windows install
2021-06-16 11:55:58 +02:00
0xmiel f2588be9ab
update faq and add example to systemd (#2645) 2021-06-11 13:56:15 +02:00
0xmiel 042600a134
Document ncli_db validatorPerf (#2638)
* add work done so far on ncli_db

* remove file

* Monitor attestation performance: tidy up

* remove test.csv

* tersec's feedback
2021-06-11 11:27:09 +02:00
0xmiel 09a459b1d7
Book updates end may (#2629)
* break up long commands, geth > infura

* fill out profitability page

* fill in 'increase privacy'

* update systemd

* add tersec's restarting loop

* update privacy page

* consolidate eth1 instructions

* tidy up eth1.md

* fill out health.md

* rm contribute-network.md from toc

* edit eth1.md

* incorporate review feedback modulo profits.md

* update health.md

* remove script to monitor logs
2021-06-03 14:43:20 +02:00
tersec ea9ceb693a
update ChainDAG.effective_balance() to use StateData; rm ChainDAG.getBlockByPreciseSlot() (#2622)
* update ChainDAG.effective_balance() to use StateData; rm unused ChainDAG.getBlockByPreciseSlot()

* update get_effective_balances to avoid god object; avoid most memory allocation in Altair epoch reward and penalty processing
2021-06-01 12:40:13 +00:00
Johann Bauer c01357c47f
Book: Add instructions on how to download precompiled release (#2600) 2021-05-26 10:43:06 +02:00
0xmiel b7db2f0a29
Book edits (#2597)
* simplify beacon node quickstart

* remove extra emacs generated file

* focus sync info around slot start message

* sync edits

* log rotate edits + clarifications

* remove validator keys folder
2021-05-24 16:03:45 +02:00
yslcrypto 038102cb92 update toc 2021-05-22 11:24:03 +02:00
yslcrypto b400243bda refocus guide around prater 2021-05-22 11:13:27 +02:00
yslcrypto 7088ed8f89 update book toc 2021-05-21 14:54:36 +02:00
0xmiel 4131e0941f
Book updates may 21 (#2590)
* update deposit page

* edit keys.md

* edit connect-eth2.md

* remove extra emacs generated file

* update run a validator guide

* update system requirements

* update start-syncing.md
2021-05-21 14:49:12 +02:00
Johann Bauer 14c258db8b
Fix typo in book (#2580) 2021-05-20 12:41:33 +02:00
yslcrypto 5bf5804bc1 update faq 2021-05-19 16:29:57 +02:00
yslcrypto 8ca2329a20 minor restructure 2021-05-19 16:26:39 +02:00
yslcrypto 62a98e9c6d minor restructure 2021-05-19 16:21:05 +02:00
TennisBowling d27c7b1f53
Add clarity to docs surrounding command line arguments, suggest data-dir when syncing, and polishing up for mainnet (#2527)
* mainnet

* add clarity to command line rules

* add datadir suggestion when syncing

* remind to pass with all calls

* noCommand added into troubleshooting

* review

Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>

* review

Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>

* review

Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>

* review

Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>

* typo

* /lib/systemd/system/ lets you enable on startup

Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>
Co-authored-by: Jacek Sieka <arnetheduck@gmail.com>
Co-authored-by: 0xmiel <sacha@status.im>
2021-05-19 16:17:07 +02:00
0xmiel 199ebc995b
restructure, merge, simplify (#2581) 2021-05-19 16:12:25 +02:00
yslcrypto 07533f41ba update binaries page 2021-05-19 12:04:10 +02:00
yslcrypto ed2e1e1c6b update docker page 2021-05-19 11:58:48 +02:00
0xmiel 3fe589a511
Update migration-options.md 2021-05-18 20:18:17 +02:00
0xmiel 80e11ac002
Update migration-options.md 2021-05-18 20:17:41 +02:00
0xmiel 5eba5b530d
Update migration-options.md 2021-05-18 20:15:39 +02:00
0xmiel 2d3b9e4c07
Update migration-options.md
Edits
2021-05-18 18:53:59 +02:00
0xmiel faf07737de
Sacha book updates (ready for review) (#2552)
* add doppelganger detection explanation to FAQ and link to Joe's guide from our Pi guide

* Edit CLI options page

* cp

* merge with ith unstable

* prysm migration guide: add steps until import slashing db

* update systemd

* update troubleshooting

* update pi guide

* metrics: replace winners with community

* update migration guide

* cp

* progress with guides, various edits
2021-05-18 18:42:51 +02:00
tersec 290b889ce6
non-intrusive, novel portions of merge (#2535) 2021-05-04 11:54:19 +00:00
yslcrypto 4cdbc17e39 remove references to devel 2021-04-28 16:06:00 +02:00
0xmiel 7af4f7c665
Guide updates (#2525)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* update binaries page

* rm extra emacs generated files

* remove extra emacs generated file

* fix windows typ

* fix eth1 title

* page on adding additional validator
2021-04-28 15:55:43 +02:00
Sacha Saint-Leger 7e31798649
Nimbus guide simplifications (#2516)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* simplify web3 provider instructions

* add donation address
2021-04-22 13:12:24 +02:00
Sacha Saint-Leger bf3305fa65
Nimbus guide: add database backup page (#2505)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* add page on backing up database
2021-04-14 17:00:47 +02:00
Sacha Saint-Leger f0f6b6869f
Nimbus guide: updates for new release (#2504)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* backupadd  web3 provider pader page

* add checksums page

* update grafana: dashboard challenge recommendations
2021-04-14 16:48:11 +02:00
Mamy Ratsimbazafy b6a3c892d7
Cpu architecture optimization documentation (#2483)
* x86 features

* Update docs/cpu_features.md [skip CI]

Co-authored-by: tersec <tersec@users.noreply.github.com>

* Update docs/cpu_features.md [skip CI]

Co-authored-by: tersec <tersec@users.noreply.github.com>

* less space [skip CI]

* Add ARMv8 [skip ci]

Co-authored-by: tersec <tersec@users.noreply.github.com>
2021-04-08 15:48:43 +02:00
Jacek Sieka f821bc878e
Remove `-d:insecure` compile option (#2468)
With metrics running on top of chronos, the metrics server no longer
needs to be compiled in conditionally - it remains disabled by default.
2021-04-01 14:44:11 +02:00
Jacek Sieka 8f441588cd
Add a few help defaults, format all of them the same (#2284) (#2467)
No support in confutils, so so this code simply hardcodes it
2021-04-01 12:28:57 +00:00
Sacha Saint-Leger 981e25a99b
Nimbus book: update homepage (#2466)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* Update homepage
2021-03-31 14:18:20 +02:00
Sacha Saint-Leger 0355c27194
Nimbus book: add Prater page (#2465)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* add prater testnet page
2021-03-31 13:59:12 +02:00
Zahary Karadjov 1af07ad124
Simple RPC for modifying the Graffiti bytes 2021-03-26 19:42:20 +02:00
Sacha Saint-Leger 5362d966ad
Nimbus guide: Rocket Pool edits (#2446)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* update joe's guide

* incorporate pineapple's feedback
2021-03-22 17:57:22 +01:00
Ștefan Talpalaru b2c4441834
book: document "logrotate" (#2390)
* book: document "logrotate"

* Update docs/the_nimbus_book/src/log-rotate.md

Co-authored-by: Sacha Saint-Leger <sacha@status.im>

* Update docs/the_nimbus_book/src/log-rotate.md

Co-authored-by: Sacha Saint-Leger <sacha@status.im>

* Update docs/the_nimbus_book/src/log-rotate.md

Co-authored-by: Sacha Saint-Leger <sacha@status.im>

* Update docs/the_nimbus_book/src/log-rotate.md

Co-authored-by: Sacha Saint-Leger <sacha@status.im>

* Update docs/the_nimbus_book/src/log-rotate.md

Co-authored-by: Sacha Saint-Leger <sacha@status.im>

* rewording

* Update docs/the_nimbus_book/src/log-rotate.md

Co-authored-by: Sacha Saint-Leger <sacha@status.im>

Co-authored-by: Sacha Saint-Leger <sacha@status.im>
2021-03-22 16:40:26 +01:00
Mentor Palokaj 895fe4baf1
Make it clear that the default port for ETH2 is 9000 udp/tcp (#2421)
* Add default port info

* Add default port info

* Edit CLI and docs to reflect 9000 port

* Apply suggestions from code review

Co-authored-by: Jacek Sieka <arnetheduck@gmail.com>
2021-03-22 08:22:56 +01:00
Sacha Saint-Leger 756c82671d
Update rp-quick-start.md 2021-03-17 17:12:32 +01:00
Sacha Saint-Leger b9f3fc4ceb
Rocket Pool guide (#2425)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* Rocket Pool guide
2021-03-17 15:33:28 +01:00
Jacek Sieka aabdd34704
e2store: add era format (#2382)
Era files contain 8192 blocks and a state corresponding to the length of
the array holding block roots in the state, meaning that each block is
verifiable using the pubkeys and block roots from the state. Of course,
one would need to know the root of the state as well, which is available
in the first block of the _next_ file - or known from outside.

This PR also adds an implementation to write e2s, e2i and era files, as
well as a python script to inspect them.

All in all, the format is very similar to what goes on in the network
requests meaning it can trivially serve as a backing format for serving
said requests.

Mainnet, up to the first 671k slots, take up 3.5gb - in each era file,
the BeaconState contributes about 9mb at current validator set sizes, up
from ~3mb in the early blocks, for a grand total of ~558mb for the 82 eras
tested - this overhead could potentially be calculated but one would lose
the ability to verify individual blocks (eras could still be verified using
historical roots).

```
-rw-rw-r--. 1 arnetheduck arnetheduck   16  5 mar 11.47 ethereum2-mainnet-00000000-00000001.e2i
-rw-rw-r--. 1 arnetheduck arnetheduck 1,8M  5 mar 11.47 ethereum2-mainnet-00000000-00000001.e2s
-rw-rw-r--. 1 arnetheduck arnetheduck  65K  5 mar 11.47 ethereum2-mainnet-00000001-00000001.e2i
-rw-rw-r--. 1 arnetheduck arnetheduck  18M  5 mar 11.47 ethereum2-mainnet-00000001-00000001.e2s
...
-rw-rw-r--. 1 arnetheduck arnetheduck  65K  5 mar 11.52 ethereum2-mainnet-00000051-00000001.e2i
-rw-rw-r--. 1 arnetheduck arnetheduck  68M  5 mar 11.52 ethereum2-mainnet-00000051-00000001.e2s
-rw-rw-r--. 1 arnetheduck arnetheduck  61K  5 mar 11.11 ethereum2-mainnet-00000052-00000001.e2i
-rw-rw-r--. 1 arnetheduck arnetheduck  62M  5 mar 11.11 ethereum2-mainnet-00000052-00000001.e2s
```
2021-03-15 11:31:39 +01:00
tersec dfc3322fe2
last few v1.0.0 spec refs to v1.0.1 (#2404) 2021-03-13 20:51:39 +00:00
Jacek Sieka 74a75d05a0
update doc links 2021-03-10 09:47:42 +01:00
Afr Schoe c6f94ce165
docs: add link to keep-updated in build, fix #2379 (#2380) 2021-03-05 09:53:55 +01:00
Mamy Ratsimbazafy 5d7f9c3a04
Consensus object pools [reorg 4/5] (#2374)
* Add documentation

* make test doesn't try to build the beacon node :/
2021-03-04 10:13:44 +01:00
Mamy Ratsimbazafy 3276dfc683
Consolidate modules by areas [part 1] (#2365)
* Move sync in subfolder

* move validator related thingies in validators

* fix binary builds

* update bounds comment [skip ci]
2021-03-02 11:27:45 +01:00
tersec 28e9568d3c
update docs to use v1.0.1 spec ref URLs (#2368) 2021-03-02 09:32:07 +01:00
Mamy Ratsimbazafy 8dcea299d0
Migrate audit tasks from Notion (#2363) 2021-03-01 11:22:35 +01:00
Mamy Ratsimbazafy 08f063aba9
[RFC - Doc] State of Nimbus block & attestation flows (#2351)
* Expand documentation on block flow [skip ci]

* address review comments [skip ci]

* Update with GossipFlow out [skip ci]

* LocalBlockProposer -> LocalValidatorDuties +  WeakSubjectivitySync

* First outline of attestation flow

* finish up prose
2021-03-01 11:22:16 +01:00
Sacha Saint-Leger 37838db82e
docs readme update (#2346)
* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* update docs readme
2021-02-19 15:59:40 +01:00
Sacha Saint-Leger 3d25f0db01
book updates (#2345)
* edit log rotation page

* update command line options

* add github edit button
2021-02-19 12:17:48 +01:00
Jacek Sieka ff94e1a212
Document log rotation (#2327)
* Document log rotation

* phrasing updates

Co-authored-by: Dustin Brody <tersec@users.noreply.github.com>
2021-02-18 07:57:41 +01:00
Ștefan Talpalaru 4bb90351f6
books: sanity checks and docs (#2320) 2021-02-15 08:33:49 +01:00
Sacha Saint-Leger 855c3e849d
update intro and binary distribution edits (#2306)
* update intro and binary distribution edits

* stefan's suggestions
2021-02-10 17:29:48 +01:00
yslcrypto 237453ec45 fix api error 2021-02-08 15:00:21 +01:00
Ștefan Talpalaru 979bb39b41 docs: binary distribution internals 2021-02-08 14:53:12 +02:00
yslcrypto 6528707e44 add local simulations to the for developers page 2021-01-27 20:38:16 +01:00
yslcrypto fa07c0f0a1 link to quickstart guide in intro 2021-01-27 19:32:04 +01:00
yslcrypto 3016815860 update quickstart 2021-01-27 19:26:08 +01:00
Ștefan Talpalaru 20435880db CI: build and publish a Docker image for end-users
Also disable the log file and log colours for distribution binaries, to
avoid duplicate logs.
2021-01-26 18:52:59 +02:00
Mamy Ratsimbazafy 70a03658e3
Block validation flow v2 + Batch (serial) sig verification (#2250)
* bump nim-blscurve

* Outline the block validation flow

* introduce the SigVerified types, pass the tests

* Split clearance/quarantine to prepare for batch crypto verif

* Add a batch signature collector

* Make clearance use SigVerified block and split verification between crypto and state transition

* Always use signedBeaconBlock for the onBlockAdded callback

* RANDAO signing_root is the epoch instead of the full block

* Support skipping BLS for testing

* Fix compilation of the validator client

* Try to fix strange errors MacOS and Jenkins (Clang, unknown type name br_hmac_drbg_context in stdlib_assertions.nim.c)

* address https://github.com/status-im/nimbus-eth2/pull/2250#discussion_r561819858

* address https://github.com/status-im/nimbus-eth2/pull/2250#discussion_r561828025

* onBlockAdded callback should use TrustedSignedBeaconBlock https://github.com/status-im/nimbus-eth2/pull/2250#discussion_r561837261

* address https://github.com/status-im/nimbus-eth2/pull/2250#discussion_r561828946

* Use the application RNG: https://github.com/status-im/nimbus-eth2/pull/2250#discussion_r561815336

* Improve codegen of conversion zero-cost)

* Quick fixes with loadWithCache after #2259 (TODO: graceful error since pubkey validations is now done first in signatures_batch)

* Graceful handle rogue pubkeys and signatures now that those are lazy-loaded
2021-01-25 20:45:48 +02:00
Jakub Sokołowski 095b191aee
add cname file to docs to fix domain issues (#2260)
mdbook has an option called `cname`:
https://rust-lang.github.io/mdBook/format/config.html#html-renderer-options

But it appears to be only included starting from `0.4.3`:
https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-043

Which means this will be more robust, if uglier.

Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-01-22 17:57:55 +01:00
yslcrypto 173a2fe018 update intro and metrics tutorial 2021-01-22 16:53:49 +01:00
Sacha Saint-Leger 67cce36f06
fix metrics guide (#2234) 2021-01-13 14:21:00 +01:00
Sacha Saint-Leger 37c3c3877c
add troubleshooting section on time (#2232) 2021-01-13 11:41:47 +01:00
Nikola Ristić 3a59b76a01
Update broken repo link (#2208) 2020-12-30 09:55:20 +01:00
Sacha Saint-Leger be74df70e0
Update systemd page: change metrics default and add note (#2204)
* change default and add note on metrics to systemd page

* add link to metrics guide from systemd page
2020-12-21 17:59:20 +01:00
Sacha Saint-Leger a1ba188de3
Update systemd page and delete old files (#2200)
* remove old pages

* update systemd file and move it to how-to's
2020-12-21 10:04:46 +01:00
Jacek Sieka 3d87bc0033 Branch guide
* update developer resources to include new branch structure
(https://github.com/status-im/nimbus-eth2/issues/2163)
* remove some information duplicated between readme and developer
handbook
2020-12-18 19:32:27 +02:00
Sacha Saint-Leger 9df437541d
Book updates (#2183)
* remove eth2stats from systemd guide

* Make clear that eth2stats is not recommended for mainnet

* edits
2020-12-15 12:31:23 +01:00
Sacha Saint-Leger 14c5d6db1e
Update Pi guide: systemd advice (#2181) 2020-12-14 12:51:16 +01:00
Ștefan Talpalaru e59437c5e2
new Make target: "benchmarks" (#2174)
It runs some benchmarks, collects the output and generates HTML charts.
2020-12-11 12:12:43 +01:00
yslcrypto e361221d72 remove mention of genesis 2020-12-10 13:09:38 +01:00
yslcrypto 8ad3b3f551 rm empty file 2020-12-09 13:10:52 +01:00
yslcrypto e11c27b1ab update toc 2020-12-09 13:10:15 +01:00
Sacha Saint-Leger f785466638
add design goals page (#2166) 2020-12-09 12:59:42 +01:00
yslcrypto d0c743e6c4 Quickstart guide + updates 2020-12-07 16:38:34 +01:00
Eugene Kabanov 46c2740097
Documentation for Validators API. (#2147)
* Recover proper validator API call and remove incorrect one.
Add more examples to API documentation.
2020-12-07 14:51:14 +02:00
yslcrypto eff98e6550 Update toc and title 2020-12-07 11:05:49 +01:00
yslcrypto e73f3e77b8 Edit generate keys page 2020-12-07 11:01:48 +01:00
yslcrypto 34eb5d33c8 Edit Recover keys 2020-12-07 00:47:26 +01:00
yslcrypto 14ddf68402 Edit key recovery page 2020-12-07 00:26:56 +01:00
Sacha Saint-Leger c26b06dd12
Add page on recovering key(s) (#2153)
* Add page on recovering key

* rm extra file
2020-12-07 00:15:19 +01:00
yslcrypto 508ea91998 Remove incorrectly commented out css lines 2020-12-03 14:38:52 +01:00
yslcrypto 2d6c80da2d fix typo in SUMMARY.MD 2020-12-03 14:06:36 +01:00
yslcrypto b4defc9b4a add placeholders 2020-12-03 04:00:14 +01:00
yslcrypto 9c568748a5 fix toc bug 2020-12-03 03:37:44 +01:00
yslcrypto 7f77fa29bc Restructure 2020-12-03 03:29:33 +01:00
yslcrypto ba215706fa Edits 2020-12-03 03:07:56 +01:00
yslcrypto eddb4fe250 style edits 2020-12-03 02:50:11 +01:00
yslcrypto 32cb93221d Style edits 2020-12-03 02:10:31 +01:00
yslcrypto 926205c32e Intro edit 2020-12-03 01:32:43 +01:00
Ștefan Talpalaru ad54e9d3bf
Prometheus/Grafana changes (#2092)
- grafana/prometheus.yml.example
- drop the custom label
- raise the minimum supported Grafana version to 7.2
- increase scrape_interval
- add validator reward rate panel (Zahary's)
2020-12-02 21:47:00 +01:00
yslcrypto 28ef298199 Fix Raspberry Pi OS image 2020-12-02 15:43:50 +01:00
Sacha Saint-Leger 3eab1f77aa
Book update post launch (#2131)
* fix systemd guide typo

* Update update flow

* update Pi guide: sync speed estimates

* FAQ: wait two epochs to prevent slashing

* Add to syncing logs

* Pi guide: add link to USB3.0 issue and link to recommended workaround

* Pi guide edits
2020-12-01 23:39:53 +01:00
Sacha Saint-Leger d83cf6e8a4
add email notifications page (#2117) 2020-11-30 20:04:12 +01:00
Sacha Saint-Leger ad498e0c11
Add link to RPC calls to Sync explainer (#2116) 2020-11-30 19:15:48 +01:00
Sacha Saint-Leger 98e83dbf51
Add IP address check to checklist (#2113) 2020-11-30 17:26:31 +01:00
Sacha Saint-Leger e4971b3baf
Grafana + Prometheus edits (#2112) 2020-11-30 15:33:21 +01:00
Sacha Saint-Leger fff8ffd2d9
Reinstate + update grafana tutorial (#2111) 2020-11-30 15:15:09 +01:00
yslcrypto 48646af5b5 Pi recommendations: edits 2020-11-30 12:10:36 +01:00
yslcrypto b9ed48d42b Pi guide: mainnet advice update 2020-11-30 12:05:02 +01:00
Sacha Saint-Leger 74da6181ee
Updates (#2108) 2020-11-30 02:13:47 +01:00
yslcrypto b839f7d4a0 add pi mainnet advice 2020-11-29 23:33:39 +01:00
Jacek Sieka a2364ce1bc
add getGossipSubPeers RPC (#2107) 2020-11-29 20:07:20 +01:00
cheatfate 7731109320 Remove getSpecPreset() because of crash and add missing calls into api.md 2020-11-29 11:01:55 +02:00
Sacha Saint-Leger 599e56c820
Update pi guide: ssd step (#2102)
* update pi guide: ssd step

* fix link error
2020-11-28 21:30:38 +01:00
Eugene Kabanov d7dc11d96d
Review and fix RPC API documentation file. (#2098) 2020-11-28 16:28:25 +01:00
yslcrypto d98f3ab948 Update Pi guide 2020-11-27 20:25:12 +01:00
Sacha Saint-Leger cb682c8b9a
update link to Somer's guide (#2086) 2020-11-26 14:43:43 +01:00
Sacha Saint-Leger f552ca1731
Nimbus book: Update binaries page (#2076)
* update binary

* add boot from SSD placeholder guide
2020-11-25 01:56:30 +01:00
Sacha Saint-Leger 36bc614c11
Update Pi Guide: 64 bit OS (#2075)
* Update Pi Guide: 64 bit OS

* remove ssh file
2020-11-25 01:33:17 +01:00
yslcrypto 6de42a6341 Nimbus book: update volumes 1 + 2 for mainnet 2020-11-24 15:00:35 +01:00
yslcrypto 6312839e83 Fix metrics command 2020-11-23 19:44:31 +01:00
yslcrypto 91d7f3c318 Update sync 2020-11-23 19:32:32 +01:00
yslcrypto 8c9540350e Update pi guide: SSD requirement 2020-11-21 00:57:59 +01:00
Sacha Saint-Leger 54778e9dc5
Nimbus book: systemd edits (#2059) 2020-11-20 23:25:51 +01:00
Zahary Karadjov 43dda632b4 Rework the systemd page to propose separate unit files for NBC and Eth2Stats 2020-11-20 20:58:08 +02:00
Zahary Karadjov 316a19af5f Address review comments 2020-11-20 17:13:51 +02:00
yslcrypto 6568e428b1 add pyrmont site to eth2-stats.md 2020-11-20 08:50:09 +01:00
yslcrypto 746279164f Minor intro edits 2020-11-19 23:17:22 +01:00
Sacha Saint-Leger bc2416d168
update eth2stats guide (#2046) 2020-11-19 23:10:05 +01:00
Sacha Saint-Leger 2256a9ba68
Add geth fully synced check (#2045) 2020-11-19 21:55:33 +01:00
Sacha Saint-Leger 096c4ac542
volume 1 edits (#2044) 2020-11-19 21:43:11 +01:00
Sacha Saint-Leger c55c0917a8
Pyrmont book edits + Infura guide rewrite (#2039)
* Volume 1 edits

* More volume 1 edits

* replace medalla with pyrmont
2020-11-18 12:20:54 +01:00
Zahary Karadjov 6b6e9b4d77
v0.6.4 Script and instructions for joining Pyrmont; WIP page in the book 2020-11-18 00:27:22 +02:00
yslcrypto 7ba541a564 add quotation marks to validator keys command + windows pwd equivalent 2020-11-16 18:40:02 +01:00
Sacha Saint-Leger 7473d83ea3
Nimbus book: Add system requirements page (#2024)
* Add system requirements page

* recommended

* add pi tip

* integrate dustin's comments
2020-11-16 17:05:00 +01:00
Jacek Sieka 5b011b65ae add rpc call to get chronos futures at runtime 2020-11-16 12:31:39 +02:00
Sacha Saint-Leger b2e0221f2d
add mainnet preparation guide (#2022) 2020-11-16 11:22:29 +01:00
Sacha Saint-Leger 3903b2cda8
replace imbus_beacon_node_spec_0_12_3 with medalla-build (#2018) 2020-11-14 12:16:03 +01:00
Sacha Saint-Leger e2e1f97aea
Book pi edits (#2015)
* Calculate how much time syncing takes, and show it at statusbar.

* Pi edits

* add 64-bit check to pi guide

* minor edit

Co-authored-by: cheatfate <eugene.kabanov@status.im>
2020-11-14 12:01:19 +01:00
Jacek Sieka ab8f8ccaba
clean up dependencies (#2008)
* clean up dependencies

* use non-prce-mode for metrics
* clean up obsolete snappy and gflags deps from manuals

* conditional pcre
2020-11-13 16:00:45 +01:00
Jacek Sieka 332e248d91
rpc: setLogLevel (#1991)
* rpc: setLogLevel

also change default rpc port to match makefile and manual

* set topic-level formats too

and make feature less secret
2020-11-12 11:46:02 +01:00
yslcrypto 2c892ca8a9 update binaries link 2020-11-10 12:42:54 +01:00
yslcrypto 3df5ab9e22 add page on binaries 2020-11-10 12:38:58 +01:00
yslcrypto f5ba1377e2 change medalla keys directory back 2020-11-10 11:17:56 +01:00
yslcrypto efc1f8074e update graffiti page 2020-11-10 10:13:11 +01:00
yslcrypto da94711fa0 toc edits 2020-11-10 10:09:06 +01:00
yslcrypto bdd90c0d84 fix medalla import keys command 2020-11-10 10:00:27 +01:00
Sacha Saint-Leger 64838720d5
Book edits (for release) (#1987)
* book edits

* fix typo

* update toc

* typo fix

* remove medalla guide (archived

* remove old systemd guide
2020-11-10 09:38:44 +01:00
tersec a010ef2061
update tests from v1.0.0-rc.0 to v1.0.0 (#1976) 2020-11-09 17:44:18 +00:00
yslcrypto 7e61c6833a nimbus book: add command line options section and page 2020-11-09 15:13:54 +01:00
yslcrypto 019f815ee5 Nimbus book: fix link + grammar 2020-11-09 11:52:11 +01:00
Zahary Karadjov e9b9cd75ee Rename binaries; Mimic the original repo layout in the distribution 2020-11-09 11:38:52 +02:00
yslcrypto 11ab3a2f4f book edits 2020-11-07 19:33:16 +01:00
yslcrypto ad07e1daae Book updates: volume 1 2020-11-07 16:52:40 +01:00
yslcrypto a815075115 book edits up to page 9 2020-11-07 15:14:08 +01:00
Jacek Sieka d2476b643a
bump version (#1964)
* bump version

* update version format to "standard" style

* remove zinken/attacknet (both networks deprecated)

* add mainnet warning
2020-11-07 08:45:55 +01:00
yslcrypto bd169732c8 add living entity note 2020-11-06 16:55:17 +01:00
yslcrypto d63aeb0f8e sync page: make it clear that mainnet hasn't launched yet 2020-11-06 12:27:30 +01:00
yslcrypto 24d6618ceb remove guide on creating deposits/keys using nimbus, edit toc 2020-11-05 19:24:38 +01:00
Sacha Saint-Leger d84cc14e40
update book for mainnet (#1959) 2020-11-05 16:35:41 +01:00
Zahary Karadjov 6ee80651c7 Rename mainchain_monitor to eth1_monitor 2020-11-03 23:23:10 +02:00
Zahary Karadjov 14b2d4324d openarray -> openArray 2020-11-03 23:23:10 +02:00
yslcrypto eef31e53cb Nimbus book: eth2stats guide 2020-11-02 19:10:31 +01:00
yslcrypto e7943b088b Nimbus book: sync before deposit 2020-11-02 17:30:25 +01:00
Sacha Saint-Leger 8b90a34914
Book overhaul: modularity + raspberry pi guide (#1908)
* add first draft of Pi guide

* pi guide -- edits

* restructure book

* edits

* edits

* deposit page: edits cp

* deposit page edits

* edits

* remove extra emacs files

* remove extra emacs files

* edit toc

* remove outdated overview

* intro edits

* add a note on verifying your validator has successfully attached

* add permissions page placeholder to toc
2020-10-26 18:12:37 +01:00
tersec c446eb7cff
update v1.0.0-rc.0 preset spec references (#1891)
* update ve1.0.0-rc.0 preset spec references

* remove runtime preset ETH1_FOLLOW_DISTANCE from preset files; remove two CI build items to try to keep Travis from timing out
2020-10-19 13:53:23 +00:00
Viktor Kirilov 4e73d10f86
removed 2 buggy RPC API endpoints - there are 2 well functioning ones in validator_api.nim anyway (#1867) 2020-10-15 14:26:59 +02:00
tersec 1d5352aa5d
switch docs/ nim-beacon-chain references to nimbus-eth2 (#1842) 2020-10-08 18:57:07 +00:00
yslcrypto 2f4ba1b6da zinken updates 2020-10-07 23:25:47 +02:00
Zahary Karadjov b46c8410a6 Retire Spadina and prepare for the Zinken network 2020-10-07 18:12:21 +03:00
Mamy Ratsimbazafy 6b9090398e
[JSON-RPC] Prevent silent uint conversion (#1819)
* Prevent silent uint conversion

* bump json-rpc
2020-10-07 15:02:54 +02:00
Sacha Saint-Leger ca2eee3995
Infura guide, book updates (#1792)
* add Infura guide, update book

* remove extra emacs generated file

* troubleshooting: add section on running multiple nodes on same computer

* integrate arnetheduck's feedback
2020-10-02 14:52:38 +02:00
Mamy Ratsimbazafy 0280d6c73e
Revisiting log levels (#1788)
* Update log level - https://github.com/status-im/nim-beacon-chain/issues/1779 https://github.com/status-im/nim-beacon-chain/issues/1785

* Address review comments

* Document the logging strategy [skip ci]
2020-10-01 20:56:42 +02:00
tersec 7eaaab908c
fix output of proposer slashing test fixture (#1780)
* fix output of proposer slashing test fixture

* run make test

* a few more v0.12.3 spec refs
2020-09-30 13:12:03 +00:00
Sacha Saint-Leger eb9faf84f3
Update spadina.md
Fix Geth instructions link
2020-09-28 23:52:59 +02:00
Kim De Mey f6b8e26567
Fix typos [skip ci] (#1771) 2020-09-28 20:43:09 +02:00
yslcrypto b72ebbc168 spadina page: integrate feedback 2020-09-28 16:46:43 +02:00
yslcrypto 2045da3997 use permalinks when referring to makefile 2020-09-28 13:51:59 +02:00
yslcrypto 61568e4335 add spadina page and update book 2020-09-27 18:53:48 +02:00
yslcrypto 2bc26940d4 update introduction 2020-09-23 15:50:19 +02:00
yslcrypto a84a65bcbe grammar fix 2020-09-23 15:38:35 +02:00
yslcrypto 9613af3391 nimbus book, metric page: integrate feedback 2020-09-23 15:33:20 +02:00
yslcrypto 72c0a3a763 metrics and pretty pictures 2020-09-23 14:26:42 +02:00
Zahary Karadjov 10cfd1ec37 Adds the Spedina testnet; Upgrades the spec presets to spec v0.12.3
Other changes:

* Removed all references to Altona
* Refactored the Makefile to avoid code duplication
2020-09-22 18:51:51 +03:00
Sacha Saint-Leger f8733a4fb6
Update faq.md (#1717)
* Update faq.md

* Update docs/the_nimbus_book/src/faq.md

Co-authored-by: Jacek Sieka <jacek@status.im>

Co-authored-by: Jacek Sieka <jacek@status.im>
2020-09-21 22:11:56 +02:00
Sacha Saint-Leger 3c6f6115eb
Update medalla-troubleshooting.md (#1705)
add section addressing `address already in use error`. we already sort of cover this in the guide, but i think it makes sense to have it explicitly mentioned here.
2020-09-21 15:21:36 +02:00
Mamy André-Ratsimbazafy c1413899f5
Merge remote-tracking branch 'origin/master' into devel 2020-09-21 09:34:51 +02:00
yslcrypto 13edb40f46 link to ubuntu guide 2020-09-20 13:49:05 +02:00
Jacek Sieka 000a0ecc52
initial e2store file format description (#1355)
This is one way we could organize the flat file storage for blocks - the
alternative would be to not do `type` in the file itself, but have a
single type per file which arguably is simpler but may become annoying.

Another potential restriction would be to require that blocks are
ordered - with this format, it's a little bit more involved to recreate
an index file, and it's easy to accidentally build in assumptions about
the block order in the main data file.
2020-09-17 23:23:54 +02:00
Sacha Saint-Leger e4b4b29320
Update medalla.md (#1685)
minor edits + clarifications
2020-09-17 20:25:21 +02:00
Sacha Saint-Leger 4c0bdffd4c
Update medalla.md (#1681)
explain syncv2 string and terminal status bar
2020-09-17 18:39:49 +02:00
Sacha Saint-Leger 6bde3b85a7
Book edits: master is now the preferred branch (#1675)
* Update medalla.md

remove `cd devel`

* Update medalla-troubleshooting.md

edits to make clear that master is now the recommended branch
2020-09-17 00:26:51 +02:00
Sacha Saint-Leger 942743a356 update medalla guide: advanced options (WIP) (#1623)
* update medalla guide: advanced options

* minor edits
2020-09-16 19:21:59 +02:00
Sacha Saint-Leger 1be5832f9a Update medalla-troubleshooting.md (#1635) 2020-09-16 19:21:59 +02:00
Sacha Saint-Leger 9a99c9b60e Update medalla-troubleshooting.md (#1633)
Add database pruning subsection
2020-09-16 19:21:59 +02:00
Sacha Saint-Leger 67ba595ce4 fix low peer count command typo (#1619) 2020-09-16 19:21:59 +02:00
Viktor Kirilov bb83817c2a use a separate process for the private keys (Off by default) - there is a new signing_process binary which loads all validators of the beacon node and the BN dictates through stdin of the signing process what to be signed and when and reads from stdout of the process 2020-09-16 19:21:59 +02:00
Sacha Saint-Leger 24dae4b04f update troubleshooting medalla (#1578) 2020-09-16 19:21:59 +02:00
Sacha Saint-Leger 425823ea54 Medalla guide updates + troubleshooting page (#1571)
* book updates

* troubleshooting: introduce devel branch, and link to discord

* add disclaimer and recommendation to fall back to master

* minor edits
2020-09-16 19:21:59 +02:00
Sacha Saint-Leger 9ac48dddca important book updates (#1561)
* book updates

* save progress

* save progress

* work on deposit data section + edits

* title edit

* minor edits

* edits and clarifications

* add images, launchpad steps, and a note on expected wait time

* add images + edits

* restructure, simplify, edits

* faq corrections

* rework intro: cp

* update intro and faq

* add note on requestiong goerli eth

* typo fix

* add numbers to steps in walletstore guide"

* chapter 8 title: replace Nimbus with NBC

* Update docs/the_nimbus_book/src/medalla.md

Co-authored-by: Jacek Sieka <jacek@status.im>

Co-authored-by: Jacek Sieka <jacek@status.im>
2020-09-16 19:21:59 +02:00
Sacha Saint-Leger ca2e7e2239
update medalla guide: advanced options (WIP) (#1623)
* update medalla guide: advanced options

* minor edits
2020-09-13 23:58:19 +02:00
Sacha Saint-Leger 7d00ca2e86
Update medalla-troubleshooting.md (#1635) 2020-09-13 11:17:27 +02:00
Sacha Saint-Leger e6c82d1815
Update medalla-troubleshooting.md (#1633)
Add database pruning subsection
2020-09-13 10:29:05 +02:00
Sacha Saint-Leger 697bd23c9b
fix low peer count command typo (#1619) 2020-09-10 12:05:14 +02:00
Viktor Kirilov d9f9949ef0 use a separate process for the private keys (Off by default) - there is a new signing_process binary which loads all validators of the beacon node and the BN dictates through stdin of the signing process what to be signed and when and reads from stdout of the process 2020-09-02 12:47:00 +03:00
Sacha Saint-Leger b457da37f2
update troubleshooting medalla (#1578) 2020-08-27 22:24:00 +02:00
Sacha Saint-Leger 950da7a9ca
Medalla guide updates + troubleshooting page (#1571)
* book updates

* troubleshooting: introduce devel branch, and link to discord

* add disclaimer and recommendation to fall back to master

* minor edits
2020-08-26 19:27:07 +02:00
Sacha Saint-Leger 0edacfef40
important book updates (#1561)
* book updates

* save progress

* save progress

* work on deposit data section + edits

* title edit

* minor edits

* edits and clarifications

* add images, launchpad steps, and a note on expected wait time

* add images + edits

* restructure, simplify, edits

* faq corrections

* rework intro: cp

* update intro and faq

* add note on requestiong goerli eth

* typo fix

* add numbers to steps in walletstore guide"

* chapter 8 title: replace Nimbus with NBC

* Update docs/the_nimbus_book/src/medalla.md

Co-authored-by: Jacek Sieka <jacek@status.im>

Co-authored-by: Jacek Sieka <jacek@status.im>
2020-08-24 14:29:19 +02:00
Michael Bradley 20554ab8ac
docs: fix consistently use /tmp/${NODE_NAME} path (#1503) 2020-08-13 19:35:36 +02:00
Sacha Saint-Leger 098b73d75b
book edits (#1500)
Co-authored-by: Jacek Sieka <jacek@status.im>
Co-authored-by: zah <zahary@gmail.com>
2020-08-13 13:16:59 +02:00
yslcrypto 0ca0425df7 update installation page 2020-08-10 12:10:36 +02:00
yslcrypto 220d40b806 introduction edits 2020-08-10 11:46:08 +02:00
Ștefan Talpalaru 8890d014be
book: remove redundant section [skip ci] (#1459) 2020-08-06 19:36:39 +02:00
yslcrypto d11f0ad86e tips on how to graffiti and run multiple clients 2020-08-06 14:49:40 +03:00
yslcrypto dea2722fc2 book updates 2020-08-06 13:17:45 +03:00
Sacha Saint-Leger a7b6b72c1d
book updates (#1422) 2020-08-04 00:15:49 +02:00
Zahary Karadjov d58668157a Use consistent naming for the synonyms 'deposits-dir' and 'validators-dir' 2020-08-02 23:00:43 +03:00
tersec d97cc35d30
switch 14 v0.12.1 spec refs to v0.12.2 spec refs (#1395) 2020-07-29 12:47:03 +00:00
tersec b45de824a4
convert 22 v0.12.1 spec refs to v0.12.2 and remove 1 unnecessary spec ref (#1384) 2020-07-28 14:55:46 +00:00
Viktor Kirilov 1482b0430d - work towards more REST API endpoints being implemented
- testnets can now be launched with a separate validator client - make altona SCRIPT_PARAMS="--separateVC"
- reverted the ctrl+C signal handler code reuse - not necessary for the VC anyway (default is good enough)
- added a bit more logging in the VC
- removed unnecessary code in the VC - connect() just parses the address & port...
- fixed a couple more VC issues - when fetching the duties for an epoch fails on the BN side ==> the VC shouldn't be left in a broken state
- documented the currently supported json-rpc endpoints
- added more checks on the BN side for the API - bounds-checking the requests & also checking if the BN itself is synced
- other cleanup

currently a local sim doesn't finalize, but participation in the altona network with a separate VC is painless and works just as well as with in-process validators in a BN
2020-07-08 13:29:03 +03:00
Mamy Ratsimbazafy 0f55ab13e8
The Auditors Handbook (#1280) - first pass
* initial auditor handbook commit

* Move in publishable state

* otu of-line comment to avoid mdbook bug

* Fix links

* Add threat model

* Update: move rocksdb and protobuf, placeholder for areas of focus
2020-07-07 10:44:21 +02:00
Sacha Saint-Leger e5eee67426
Book edits: Become a validator page (#1283)
* become a validator: updates and edits

* rm extra book directory

* minor edit
2020-07-07 10:43:40 +02:00
Jacek Sieka 2b9df8a602
readme: add cmake on mac 2020-07-06 13:47:26 +02:00
Jacek Sieka c2c078a208
add chat links to manual 2020-07-06 10:24:55 +02:00
Jacek Sieka f06cc34406
book updates 2020-07-03 18:03:06 +02:00
Mamy Ratsimbazafy 0b3a468883
Move the nimbus books in a subfolder to allow for more books (#1263) 2020-07-01 10:37:04 +02:00
Jacek Sieka e898525b16
More version in --version and less version in --help (#1260)
Long version and copyright banners is probably not what the user is
after when typing `--help`
2020-06-30 14:23:52 +02:00
Jacek Sieka d952b323a0
doc updates 2020-06-29 14:04:01 +02:00
Jacek Sieka f1570cd4c3
Update manual for altona (#1251) 2020-06-29 12:26:37 +02:00
Ștefan Talpalaru 18c355ce37
Update docs/src/advanced.md
Co-authored-by: Jacek Sieka <jacek@status.im>
2020-06-24 01:03:59 +02:00
李婷婷 1dab3538ff fix comments 2020-06-20 10:37:51 +08:00
李婷婷 b3193e0659 fix comments 2020-06-19 23:51:11 +08:00
李婷婷 aee81a58d4 fix the comments 2020-06-19 23:30:05 +08:00
李婷婷 68d7c6d311 add cli 2020-06-19 23:24:06 +08:00
李婷婷 f94878ff0e update readme 2020-06-19 22:03:17 +08:00
李婷婷 92ca4c9481 update contribute guide 2020-06-19 21:55:11 +08:00
李婷婷 781f060595 update suggestions 2020-06-19 21:14:12 +08:00
李婷婷 0f48c9f40f update url 2020-06-12 10:39:56 +08:00
李婷婷 231503f6ec update the structure and add FAQ 2020-06-12 10:35:43 +08:00
李婷婷 3bad3d991d add testnet0 state 2020-06-10 23:57:03 +08:00
李婷婷 9c1da836f7 fix all comments 2020-06-10 00:50:10 +08:00
李婷婷 77364548e2 rebase from devel 2020-06-10 00:29:29 +08:00
Ștefan Talpalaru fa7d64c291
Makefile fix 2020-05-02 16:46:24 +02:00
Ștefan Talpalaru 43679bd04f
Makefile: add "publish-book" target
See https://github.com/rust-lang/mdBook/blob/master/book-example/src/continuous-integration.md#deploying-to-github-pages-manually
2020-05-02 16:30:34 +02:00