82 Commits

Author SHA1 Message Date
Chris Hobcroft
5bb4954ce3 Rename eth2.0-deposit-cli to staking-deposit-cli, fixed typo (#3891) 2022-04-06 17:37:49 +05:30
Lion - dapplion
c5997e07d6 Implement standard keymanager API (#3522)
* Add keymanager backend

* Add keymanager server

* Add private local signer

* Fix comment typo

* Update test types

* Update package.json and license

* Hooking up the keymanager server - still manually registering a dummy api that returns static data

* Revert "Hooking up the keymanager server - still manually registering a dummy api that returns static data"

This reverts commit c3c220e4cf9455387cc665ef8dba5e319dbc2d95.

* using 9657 as default port for key manager server. Also not overriding defaults with undefined

* starting keymanager server also in dev

* First stab at implementing deleting keys from persistant storage

* updating parsing of slashing data to make POST request work

* leaving some todo

* switching deleting file to async. Still need to take care of logging in case deleting fails

* first dash at persisting keys for later restarts

* Adding (local signer for now) and removing of signer in ValidatorStore.

* deleting and adding working again with remote signer merged in

* fix lint errors

* fix lint errors

* fix lint errors - finally

* temp

* Moving keymanager to its own package to make the validator package nodejs agnostic

* track test file

* removing some outdated TODOs

* adding the generic server test for keymanager api

* removing an unused function and two empty test files

* keeping inline with existing pattern of using _config when config is not used

* Added first test for KeymanagerApi#listKeys

* Added test for KeymanagerApi#importKeystores

* Added test for KeymanagerApi#deleteKeystores

* move lock file to utils

* making sure keystore are added and deleted in all scenarios

* temp making some assertion less strict

* adding back matchers in the test

* removing e2e test in script since none yet

* On delete remove key from internal list of keys known my the keymanager

* first shot at adding bearer authentication for keymanager server

* Using async pattern again so as to fix test that only fails on ci

* log location of keymanager's bearer token on startup

* Undoing the addition of lockfile to lodestar-util as it is a package that should be filesystem/nodejs agnostic

* importing lockfile in test

* Stubbing out the keystore. All tests should now pass on CI

* remove duplicated start of validator

* When using dev command, make it actually possible to not run a validator with a beacon node

* Passing in the directory where the keymanager's bearer token will be stored

* Properly setting the path to keystore file to be deleted

* adding methods to remove signer from various duties, exposing and calling in keymanager.

* Added tests for BlockDutiesService#remove

* fix linting errors

* Added tests for AttestationDutiesService#remove

* Added tests for SyncCommitteeDutiesService#remove

* Added test to directly test IndicesService

* update test to confirm unremoved pubkey is not affected by the remove call

* Added the scaffolding to run e2e test that makes use of the keymanager

* shut down node and validators in keymanager e2e test

* Making sure by default bearer authentication is used for keymanager api

* Adding e2e for keymanager api

* adding some eslint ignore comments

* Fix linting errors

* Processing some todos

* Process left TODOs

* log a warning if kemanager started without auth

* fix compilation error when running sim:singleThread test

* import all modules from same package in same line

* fix compilation error due to import

* Added logger to KeymanagerApi

* Fixed compilation error in key managers e2e test due to changes that added logger to KeymanagerApi

* removing TODO after deciding to action needed

* removing download-spec-tests from keymanager-server script

* test request is denied if no auth for keymanager

* trying closing keymanager before beacon node

* setting port right

* Some improvement to the keymanager e2e test

* Added signing to e2e test for key manager

* Added support for interactions with remote signer validators. Removed some unit tests in place of e2e

* optimise imports

* optimize some tests assertion

* minor correction to capitalisation

* register callback to delete locks in same loop that adds to signers

* fix compilation error

* adding lockfile as dependency following alphabetical order

* Improving the registering of shutdown callbacks

* moving keymanager options out of beacon node options

* having back default value for startValidators flag

* Removed unnecessary comment

* removed the parse-numbers setting

* Switching to making imported keystore path deterministic by pubkey

* Using Array constructor with length is more efficient

* Move some keystore test utility function to a seperate file

* Removed some more suppress comments

* Removed unnecessary dependency

* using 5062 as default port for keymanager

* Improve keymanager and keymanager e2e tests

* Removed unnecessary test utility function

* Removed the use of mapvalues

* Not exposing duties

* Minor comment improvement

* Have slashing protection be part of validator and use that in the key manager

* Remove getSignerLocal

* switch use of forEach for for-of

* revert changes to local.md

* optimise import order

* Moved typing info for lockfile to devDependencies

* Some renaming

* replace join with path.join for clarity

* setting derivation path

* Introduced a utility for keystore file, that is used both in importing and deleting keys

* having duties service classes back to private

* re-adding test:unit

* switching to using path.join

* Introduced a more robust cleanup for lightclient.test.ts

* import optimisation

* putting all closing of nodes/validators into afterEach call

* temp skip keymanager e2e test

* switching node port back to 9596. It should not be any problem as long as all tests shuts down node properly

* switch test port to 19596 see if this fixes tests

* Immediately register clean up for servers

* Temp skip a failing test

* Using tmp dir for keeping bearer token for test cases where keymanager needs bearer token

* move the lockfile to keymanager

* Added tests to cover bearer token authentication flow

* Setting derivationPath back to empty string. Implementing getting derivationPath would be done later

* Fix type error

Co-authored-by: Cayman <caymannava@gmail.com>
Co-authored-by: Dadepo Aderemi <dadepo@gmail.com>
2022-04-01 19:35:40 +05:30
Phil Ngo
6bd0310a96 Removing eth2 mentions in documentation and fix links (#3848)
* Remove architecture.md from docs

* Update mkdocs.yml to remove architecture.md

* Remove architecture link from readme

* Remove architecture.md links from depgraph.md

* Remove architecture overview from readme

* Remove eth2 terminology on contributing.md

* remove eth2 references from docs
2022-03-13 17:31:26 -05:00
g11tech
27c5d6bb8b Group and refactor the wss options (#3750)
* Grouping and refactoring the wss options

* rename the group and options

* weak subjectivity usage doc

* reverting change in the args name so that the change is not breaking
2022-02-17 09:48:06 +05:30
g11tech
1c86d16113 Cleanup discontinued pyrmont network (#3740) 2022-02-10 13:57:20 -06:00
Lion - dapplion
9a58ce3c8b Run prettier on entire repo (#3720) 2022-02-07 09:57:26 -06:00
dadepo
fd65bc9b2a Merge pull request #3672 from ChainSafe/dadepo/connect-to-network-discv5-bootEnrs-on-start-up
Connect to network discv5 boot enrs on start up
2022-02-04 18:59:26 +01:00
Dadepo Aderemi
ad28754cf3 Updated documentation to include the needed network.connectToDiscv5Bootnodes cli flag 2022-02-04 12:21:36 +01:00
Dadepo Aderemi
dcacf7f894 Removed cli flags not needed when using dev command in the example 2022-02-04 09:26:02 +01:00
Dadepo Aderemi
6e79bc50c9 updated the documentation to include setting enr.ip for first node 2022-02-02 23:44:08 +01:00
Phil Ngo
0fea7126d8 Remove out of date architecture.md (#3675)
* Remove architecture.md from docs

* Update mkdocs.yml to remove architecture.md

* Remove architecture link from readme

* Remove architecture.md links from depgraph.md

* Remove architecture overview from readme
2022-01-28 09:50:55 +05:30
Dadepo Aderemi
a8efda70ab Ensure the values passed via network.discv5.bootEnrs are connected to on startup. Updated the documentation of the dev command 2022-01-27 16:15:33 +01:00
Phil Ngo
58efb95f69 Create RELEASE.md (#3587)
* Create RELEASE.md

* add lodestar-releases flow png to docs/images

* Updates to RELEASE.md

* Update RELEASE.md

* Update explicit package.json bump and beta format

Co-authored-by: Lion - dapplion <35266934+dapplion@users.noreply.github.com>
2022-01-25 16:27:53 +01:00
dadepo
240085facb Updated outdated portion of the documentation regarding starting a beacon chain (#3557) 2021-12-29 19:27:27 +01:00
Enrique Ortiz
eba2f2a589 Docs: fix typo (#3518)
Just found a small typo while going through the docs. :)
2021-12-16 10:52:42 +01:00
Filipe Medeiros
0c9c43c995 fix: docs using old syntax (#3340) 2021-10-08 06:58:37 -05:00
Lion - dapplion
cd6e6a4f3b Remove postinstall script (#3027) 2021-08-26 19:52:32 -05:00
Lion - dapplion
3a3ae0bd6b Add dark mode to docs and a stroke to logo (#2894) 2021-07-27 09:40:48 -05:00
Cayman
1e3b144b17 Update docs / READMEs (#2829) 2021-07-12 08:48:26 -05:00
dapplion
50afaffa78 Fix package rename 2021-03-24 10:48:13 +01:00
dapplion
677b2fd434 Run prettier on all files 2021-03-07 12:50:58 +01:00
Cayman
7b8482ba30 Merge pull request #1984 from ChainSafe/P0/design
chainsafe docs dependency graph visual update and explainer section
2021-01-25 13:50:22 -05:00
3xtr4t3rr3str14l
760d7075fa package structure elaboration 2021-01-21 13:57:45 -06:00
3xtr4t3rr3str14l
d1c5bda5fd dependency graph visual update and explainer section 2021-01-20 19:08:32 -06:00
3xtr4t3rr3str14l
33905d97cc dark and light theme compatible mermaid chart styling 2021-01-20 15:26:23 -06:00
Marin Petrunić
298354baa7 Merge pull request #1959 from ChainSafe/P0/netname
--testnet -> --network
2021-01-20 09:16:12 +01:00
3xtr4t3rr3str14l
9a0a8d7e8c remove dead testnet mentions 2021-01-19 15:13:51 -06:00
3xtr4t3rr3str14l
8c66e3a3d1 Merge branch 'P0/netname' into P0/deadnets 2021-01-19 13:41:29 -06:00
3xtr4t3rr3str14l
ffcdaad5ad testnet-->network in docs and docker-compose 2021-01-18 12:53:22 -06:00
3xtr4t3rr3str14l
d2619704fa add mkdocs-mermaid2-plugin to docs deploy requirements 2021-01-18 12:36:34 -06:00
3xtr4t3rr3str14l
72a0ea7dfc link update 2021-01-13 14:25:46 -06:00
3xtr4t3rr3str14l
4253565c31 event listener updates 2021-01-13 14:19:34 -06:00
3xtr4t3rr3str14l
2e1eb63c12 review changes 2021-01-13 14:19:26 -06:00
3xtr4t3rr3str14l
a0b5d79d3f add links to architecture data items 2021-01-06 13:11:42 -06:00
3xtr4t3rr3str14l
53f008687d moving doc data around 2021-01-05 23:14:01 -06:00
3xtr4t3rr3str14l
8f938c8640 beacon node module links 2021-01-05 21:04:06 -06:00
3xtr4t3rr3str14l
08f8e396f6 diagram readability 2021-01-05 20:51:41 -06:00
3xtr4t3rr3str14l
7512d983c0 events update and urls 2021-01-05 20:33:18 -06:00
3xtr4t3rr3str14l
b55fefa306 events.md update 2021-01-04 16:26:54 -06:00
3xtr4t3rr3str14l
c32f8b503c architecture.md formatting 2021-01-04 14:39:23 -06:00
3xtr4t3rr3str14l
cea6608e11 events.md 2021-01-04 12:50:10 -06:00
3xtr4t3rr3str14l
65b9e0fa77 RL -> TD 2021-01-04 12:50:01 -06:00
3xtr4t3rr3str14l
e3000fe3b2 add design section to lodestar documentation 2020-12-21 19:12:35 -06:00
3xtr4t3rr3str14l
a2af180a57 cleaning up some of the formatting of user docs 2020-12-17 18:22:42 -06:00
3xtr4t3rr3str14l
57073c8bb0 Merge branch 'P0/user-docs' of https://github.com/ChainSafe/lodestar into P0/user-docs 2020-12-16 15:21:14 -06:00
3xtr4t3rr3str14l
ce62221984 typo 2020-12-16 15:19:43 -06:00
3xtr4t3rr3str14l
6a49805475 Update docs/usage/index.md typo
Co-authored-by: Marin Petrunić <mpetrunic@users.noreply.github.com>
2020-12-16 14:46:52 -06:00
3xtr4t3rr3str14l
c84db447f1 refresh user guide docs 2020-12-15 16:33:55 -06:00
dapplion
92d1489677 Run lodestar with node directly not yarn 2020-10-05 22:52:07 +02:00
3xtr4t3rr3str14l
2abfa3cc63 minor docs tweaks 2020-08-17 15:13:48 -05:00