Commit Graph

136 Commits

Author SHA1 Message Date
Ștefan Talpalaru bdd56b626f
Merge pull request #1206 from status-im/readme
Update readme and manual
2020-06-24 01:04:25 +02:00
Zahary Karadjov 01ea66f24e Some documentation and better defaults 2020-06-22 17:30:04 +03:00
Ștefan Talpalaru 089b365c37
README: add comment 2020-06-19 18:12:27 +02:00
李婷婷 04e1a61f58 Merge branch 'devel' into readme 2020-06-19 22:11:12 +08:00
李婷婷 781f060595 update suggestions 2020-06-19 21:14:12 +08:00
Viktor Kirilov 72dfe7f578 - updated the validator shell script after the keystore changes
- better logging & retrying requests on the VC side if the BN fails for some reason
- VC now fetches the attestation duties 1 epoch in advance - in the future it will tell the BN to subscribe to the appropriate attestation topics in advance based on that info
- a bunch of other code cleanup & fixes such as better naming for consoles when using multitail, etc.

reviewed in PR #1184 - proper review of the API & VC are pending
2020-06-19 12:21:22 +03:00
Ștefan Talpalaru cd80fab5a9
add link to nimbus-build-system docs 2020-06-13 02:01:19 +02:00
Ștefan Talpalaru f5ec1bc5bb
support multiple local Witti nodes [skip ci] 2020-06-11 18:42:58 +02:00
Ștefan Talpalaru b45885b357
README: document Jenkins artifacts
and bring the ToC up to speed
2020-06-11 15:59:19 +02:00
Ștefan Talpalaru e2025c5752
Prometheus & Grafana refactoring
- moved "process_dashboard.nim" in "tools/"
- README: made Witti the documented testnet and added instructions for
  getting metrics out of the local node
- moved Prometheus config file generation in its own script
- the static Grafana dashboard definition now covers all nodes, using
  a variable; only the remote testnet dashboards need to be dynamically
  generated
- "launch_local_testnet.sh" no longer needs a "--grafana" option
2020-06-10 19:55:26 +02:00
Dustin Brody 50dbf5b91a poke to try azure again 2020-06-09 18:39:05 +00:00
Ștefan Talpalaru 22bd8951fd
README: we need CMake on macOS 2020-06-03 22:08:25 +02:00
Jakub Sokołowski 39aac348b3
fix use of legacy get.status.im domain
Signed-off-by: Jakub Sokołowski <jakub@status.im>
2020-06-02 22:32:07 +02:00
tersec 8432932c11
update to spec v0.11.2 to keep compatible with Schlesi (#1036)
* update to spec v0.11.2 to keep compatible with Schlesi

* update spec/state_transition_epoch spec references to v0.11.2

* bump other spec refs
2020-05-18 23:05:27 +00: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
tersec 57aba5d3a6
Switch block pool caches from BeaconChainDB to TableRefs (#945)
* refactor blook pool caches to directly use TableRef to avoid SSZ decoding, which was consuming 20% of profile on mainnet eth2_network_simulation

* use table's hasKeyOrPut

* bump eth2 spec reference to v0.11.1

* cache whole StateData objects and switch from expensive clear() to cheaper new object instantiation for caching

* remove scaffolding and stop re-assigning to part of StateData object

* 80-character lines
2020-04-29 16:58:44 +02:00
tersec 7bc18423fa
detect improper 0-length lists of variable-sized objects in SSZ reading (#928)
* detect improper 0-length lists of variable-sized objects in SSZ reading
2020-04-23 19:39:23 +00:00
Ștefan Talpalaru 1babc00255
new initial submodule update strategy (#904)
* new initial submodule update strategy

* Azure: fix command order
2020-04-19 01:25:21 +02:00
Zahary Karadjov 12207eba07 Remove all mentions of Go from the README 2020-03-23 14:59:33 +02:00
Ștefan Talpalaru 47df900958
document `-d:insecure` for Prometheus support 2020-02-27 17:50:36 +01:00
acolytec3 fb771d52f0 Add android build prereqs 2020-02-21 19:43:00 +00:00
Ștefan Talpalaru ad36808b7d
Make: add USE_LIBBACKTRACE flag 2020-02-20 17:41:10 +01:00
Jacek Sieka 2a67ac3c05 trie -> kv store
* simplify data storage to key-value, tries are not relevant for NBC
* locked-down version of lmdb dependency
* easier to build / maintain on various platforms
2020-01-20 13:39:37 +00:00
Jacek Sieka 0d1727e2cb
Update README.md 2020-01-01 12:34:30 +01:00
Jacek Sieka 1fef4090b5
Update README.md
Need git on bare ubuntu
2019-12-31 15:31:59 +01:00
Jacek Sieka 265b9aaf39
Update README.md
it's `build-essential` on debian
2019-12-31 13:37:25 +01:00
Dustin Brody 46de726e3d mark all compatible 0.9.3 functions and data structures as 0.9.4 2019-12-20 17:24:42 +00:00
Dustin Brody 27bf8908a9 mark a couple dozen functions and data structures as 0.9.3; fix TRACE-level compiling; stop downloading 0.9.2 test vectors; update cosmetic/display spec versions in test suite 2019-12-17 16:51:46 +00:00
Jacek Sieka 8c104a0b94 inspector: add readme entry, decoding option 2019-12-16 16:08:30 +02:00
Mamy Ratsimbazafy 52cdb73e96
Fix instr when cloning from scratch (#621)
* Fix build instruction (make update deps is not enough on first install)

* use underline instead of bold

* Alternative fix

* Makefile: fix the default target on fresh clone

* fix ANSI escape code bleeding into my shell prompt
2019-12-03 19:52:54 +01:00
Zahary Karadjov ee2448b221 Simple validator onboarding
On your very first connection to each testnet, you'll be asked to
become a validator. Please consult our private repo for a Goerli
Eth1 private key that you can use for deposits.

Other changes:

* Added a simple wrapper ./connect-to-testnet script calling the
  nims file in the correct environment. No extension was used to
  make the command the same on Unix and Windows.

* Bumped a number of modules with fixes from this week

* `make testnet0` and `make testnet1` will no longer delete your
  existing database. This is considered a more appropriate behavior
  for testing forward sync.
2019-12-03 02:23:17 +02:00
zah 94f9658e7b Update README.md 2019-12-02 22:21:45 +02:00
Mamy Ratsimbazafy 68caaa4e39 Update README.md
Co-Authored-By: Jacek Sieka <jacek@status.im>
2019-12-02 22:21:45 +02:00
Mamy André-Ratsimbazafy 0d0e5ea080 add back archlinux instruction (note that pakku is broken and unmaintained) 2019-12-02 22:21:45 +02:00
Mamy André-Ratsimbazafy dcab811197 build instructions where missing make x2 2019-12-02 22:21:45 +02:00
Mamy Ratsimbazafy e7b0c8d8dd [Ready] README polish (#602)
* README polish

* Update README.md

Co-Authored-By: Jacek Sieka <jacek@status.im>

* Update README.md

Co-Authored-By: Jacek Sieka <jacek@status.im>

* Update README.md

Co-Authored-By: kdeme <kim.demey@gmail.com>

* Address comments
2019-11-29 15:39:46 +00:00
Dustin Brody edfd65fd5d stop download 0.9.1 test vectors; finish 0.9.2 update, primarily via fixing preset constants; remove a couple 0.19.6 shims 2019-11-22 16:41:43 +00:00
Dustin Brody f5b8931fad switch assert(...) to doAssert(...) and minor cleanup 2019-11-22 16:39:05 +00:00
Dustin Brody c0f009908c
re-enable test_interop based on zcli with 0.9.1 specs and update initialize_beacon_state_from_eth1(...) to 0.9.1 (#569)
* re-enable test_interop based on zcli with 0.9.1 specs and update initialize_beacon_state_from_eth1(...) to 0.9.1

* switch many procs to funcs

* fix import os.nim instead; ospaths is deprecated [Deprecated] warnings
2019-11-21 09:15:10 +00:00
Zahary Karadjov f5e9b9a922 Allow running local nodes without attached validators
The number of user nodes is now specified with `USER_NODES`.

To make the instructions more stable, the "numeric id" of the user
nodes will be starting from 0 (so you can always use `run_node.sh 0`
to start a user node).

If you specify a node index above the total number of nodes, you'll
launch a node without any validators attached (this is useful for
testing the sync for example).
2019-11-11 23:29:36 +00:00
Dustin Brody f02aa20873
innocuous phrasing change to trigger CI build 2019-11-09 18:52:48 +01:00
Zahary Karadjov 6ceb75c6b3
Add README instructions for connecting to testnets 2019-10-29 01:25:43 +02:00
Mamy Ratsimbazafy f7dea04ed6 Add detailed Rpi instructions (#506) 2019-10-28 11:55:29 +00:00
Jacek Sieka 8af2e03677
Update README.md 2019-10-25 13:49:31 +02:00
Ștefan Talpalaru 3a2fc249a2
simulation: metric visualisation 2019-10-23 20:57:59 +02:00
Jacek Sieka f41fa704d5
Update readme instructions to use specific node/validator counts (fixes #483) 2019-10-23 15:22:35 +02:00
Jacek Sieka ee52e86781
readme: simplify prerequisites section 2019-10-22 14:03:48 +02:00
Ștefan Talpalaru 5f02f42658
fix typo [skip ci] 2019-09-29 16:22:18 +02:00
Ștefan Talpalaru 1664565934
replace the AppVeyor badge with the Azure one [skip ci] 2019-09-29 16:19:58 +02:00
Jacek Sieka e984ecb64f
fix readme 2019-09-28 21:18:30 +02:00
Ștefan Talpalaru 1f05e1cdb2
README: minimum Git version [skip ci] 2019-09-12 18:33:23 +02:00
mratsim f4a3e47a61 Update interop instructions [skip ci] 2019-09-10 21:05:58 -04:00
Mamy Ratsimbazafy 68354829e3
Add go compiler as prerequisit [skip ci] (#430) 2019-09-10 16:41:24 -04:00
Mamy Ratsimbazafy d17d7dba0e
add note to skip LFS (#383)
* add note to skip LFS

* Addtional note in the interop folder readme
2019-09-04 23:38:01 +02:00
Ștefan Talpalaru b12bc346f4
it's "libpcre3-dev" in Ubuntu too 2019-09-04 13:30:39 +02:00
Ștefan Talpalaru 343f1a95a0
Nimbus -> nim-beacon-chain 2019-09-04 13:25:25 +02:00
Ștefan Talpalaru 59014cbc52
document requirements and the build process
fixes #376
2019-09-04 13:14:09 +02:00
Ștefan Talpalaru 69ac78b2e0 new build system and submodules
- better p2pd building, with CI caching
2019-08-23 14:36:29 +03:00
Bruno Škvorc b6e2d4f30a
Update README.md 2019-07-12 10:18:07 +02:00
Christian Iacullo 5d22f5e730 Beacon node simulation README fix (#312) 2019-07-04 13:57:17 +00:00
Ștefan Talpalaru cf2b9e5a84
README.md: fix eth2_network_simulation instructions 2019-04-01 22:30:37 +02:00
Bruno Škvorc d3f13d01e7
Update README.md 2019-03-30 01:13:45 +01:00
Bruno Škvorc 75f9388c19
Update README.md 2019-03-30 01:11:43 +01:00
Ștefan Talpalaru 3b2b65a21e
README.md: we default to V=0 now 2019-03-29 19:10:16 +01:00
Ștefan Talpalaru 226a390c66
README.md: add `make update` even if it's not required the first time
so we don't have a different set of instructions for subsequent updates
2019-03-29 03:36:04 +01:00
Ștefan Talpalaru f8fbe0ff3b Makefile that only works in a Git submodule (#210)
- updated README.md
- beacon_chain.nimble: accept compilation flags as params
- nim.cfg: enable `--opt:speed` at the top level
- simulation scripts: allow overriding GIT_ROOT and do some refactoring
2019-03-28 09:18:59 -06:00
Mamy Ratsimbazafy 96f26296f6
Remove status test-vector section in README 2019-03-27 18:12:12 +01:00
Bruno Škvorc e13dcb1b7a
Update README.md 2019-03-25 10:41:56 +01:00
Andrea Franz 6e845c9344
fix typo on rm command 2019-03-15 19:18:53 +01:00
Andrea Franz 6086aa4fe4
Update README.md 2019-03-15 18:19:36 +01:00
Andrea Franz a79a929fc8
add `make deps` step in the docs 2019-03-15 18:19:01 +01:00
Jacek Sieka 2177bccb34
Update readme 2019-03-15 08:12:30 -06:00
Jacek Sieka 9e9271774f
Update README 2019-03-14 14:32:02 -06:00
Jacek Sieka a8b7307e81
update readme 2019-03-14 14:28:36 -06:00
Jacek Sieka b777e43e56
Update README.md 2019-03-08 12:06:21 -06:00
Jacek Sieka 4d55cf8eea beacon node sim: various improvements (fixes #111) (#156)
* allow running more or fewer validators
* use deterministic key generation for tests to avoid exhausting system
RNG
* update README with simulator docs
* write the data of each validator to separate file, instead of a big
chainstart.json (makes it easier to run different validator counts)
2019-03-07 13:59:28 +00:00
Ștefan Talpalaru 8859a4b56c simulation: optional multitail support (#128)
demo: https://asciinema.org/a/228550
2019-02-19 20:22:25 -06:00
Bruno Škvorc 0ceafc92c5
Update README.md 2019-02-14 12:32:05 +01:00
Bruno Škvorc 98177dace3
Update README.md 2019-01-02 14:55:29 +01:00
Bruno Skvorc 408baf87e6 Updated readme 2018-12-27 15:22:58 +01:00
mratsim 68875d15e4 Move test vectors generators out of repo 2018-12-13 14:05:40 +01:00
Bruno Škvorc 0d775eefcb
Update README.md 2018-12-02 11:11:12 +01:00
Zahary Karadjov 4920c0a357 work-in-progress beacon node skeleton (not compiling at the moment) 2018-11-28 22:55:04 +02:00
Jacek Sieka 3b54cd3f96
readme: update license 2018-09-05 12:46:09 -06:00
mratsim f203859316 Use Ethereum Foundation naming convention (snake_case + MACRO_CASE) 2018-08-17 18:21:10 +02:00
mratsim a5ae8ef0aa initial commit 2018-07-20 15:46:03 +02:00