Clean Up Client Project, Update Docs, Eliminate Unnecessary Items #399
Conversation
Codecov Report
@@ Coverage Diff @@
## master #399 +/- ##
==========================================
- Coverage 53.56% 53.29% -0.27%
==========================================
Files 31 31
Lines 2500 2501 +1
==========================================
- Hits 1339 1333 -6
- Misses 999 1000 +1
- Partials 162 168 +6
Continue to review full report at Codecov.
|
README.md
Outdated
| ``` | ||
|
|
||
| This will extract 1000ETH from your account balance and insert you into the SMC's attesters. Then, the program will listen for incoming block headers and notify you when you have been selected as to vote on proposals for a certain shard in a given period. Once you are selected, your sharding node will download collation information to check for data availability on vote on proposals that have been submitted via the `addHeader` function on the SMC. | ||
| Now, deposit ETH to become a validator in the contract. TODO: Add instructions for this. |
There was a problem hiding this comment.
Here is the instruction. Add a link to this markdown https://github.com/prysmaticlabs/prysm/blob/master/beacon-chain/VALIDATOR_REGISTER.md
| @@ -110,7 +103,7 @@ func (s *ShardEthereum) Start() { | |||
| } | |||
| } | |||
| debug.Exit() // Ensure trace and CPU profile data are flushed. | |||
| panic("Panic closing the sharding node") | |||
| panic("Panic closing the sharding client") | |||
There was a problem hiding this comment.
I wonder if it's better to call it beacon node client than sharding client? Up to you!
There was a problem hiding this comment.
Might be too confusing with the beacon-chain project. This will eventually become a sharding client though, so I think it's alright.
README.md
Outdated
| --datadir /path/to/your/datadir \ | ||
| --password /path/to/your/password.txt \ | ||
| --networkid 12345 | ||
| ./bazel-bin/beacon-chain/YOUR-ARCHITECTURE/beacon-chain --web3provider ws://127.0.0.1:8546 --datadir /path/to/your/datadir --rpc-port 5000 --simulator --verbosity debug |
There was a problem hiding this comment.
Can you change this to use bazel run and format it so that there is 1 flag per line? It helps for readability.
The concern about multiple bazel runs at the same time is no longer an issue.
README.md
Outdated
| --password /path/to/your/password.txt \ | ||
| --shardid 0 \ | ||
| --networkid 12345 | ||
| ./bazel-bin/client/YOUR-ARCHITECTURE/client --beacon-rpc-provider http://localhost:4000 --verbosity debug |
Hi all,
This is the final PR in the series for #315. We are finally tidying up everything within client and aligning the docs to match our latest work, the beacon spec, and ensure we have no remnants of deprecated items.