lighthouse/book/src
Paul Hauner cdec3cec18
Implement standard eth2.0 API (#1569)
- Resolves #1550
- Resolves #824
- Resolves #825
- Resolves #1131
- Resolves #1411
- Resolves #1256
- Resolve #1177

- Includes the `ShufflingId` struct initially defined in #1492. That PR is now closed and the changes are included here, with significant bug fixes.
- Implement the https://github.com/ethereum/eth2.0-APIs in a new `http_api` crate using `warp`. This replaces the `rest_api` crate.
- Add a new `common/eth2` crate which provides a wrapper around `reqwest`, providing the HTTP client that is used by the validator client and for testing. This replaces the `common/remote_beacon_node` crate.
- Create a `http_metrics` crate which is a dedicated server for Prometheus metrics (they are no longer served on the same port as the REST API). We now have flags for `--metrics`, `--metrics-address`, etc.
- Allow the `subnet_id` to be an optional parameter for `VerifiedUnaggregatedAttestation::verify`. This means it does not need to be provided unnecessarily by the validator client.
- Move `fn map_attestation_committee` in `mod beacon_chain::attestation_verification` to a new `fn with_committee_cache` on the `BeaconChain` so the same cache can be used for obtaining validator duties.
- Add some other helpers to `BeaconChain` to assist with common API duties (e.g., `block_root_at_slot`, `head_beacon_block_root`).
- Change the `NaiveAggregationPool` so it can index attestations by `hash_tree_root(attestation.data)`. This is a requirement of the API.
- Add functions to `BeaconChainHarness` to allow it to create slashings and exits.
- Allow for `eth1::Eth1NetworkId` to go to/from a `String`.
- Add functions to the `OperationPool` to allow getting all objects in the pool.
- Add function to `BeaconState` to check if a committee cache is initialized.
- Fix bug where `seconds_per_eth1_block` was not transferring over from `YamlConfig` to `ChainSpec`.
- Add the `deposit_contract_address` to `YamlConfig` and `ChainSpec`. We needed to be able to return it in an API response.
- Change some uses of serde `serialize_with` and `deserialize_with` to a single use of `with` (code quality).
- Impl `Display` and `FromStr` for several BLS fields.
- Check for clock discrepancy when VC polls BN for sync state (with +/- 1 slot tolerance). This is not intended to be comprehensive, it was just easy to do.

- See #1434 for a per-endpoint overview.
- Seeking clarity here: https://github.com/ethereum/eth2.0-APIs/issues/75

- [x] Add docs for prom port to close #1256
- [x] Follow up on this #1177
- [x] ~~Follow up with #1424~~ Will fix in future PR.
- [x] Follow up with #1411
- [x] ~~Follow up with  #1260~~ Will fix in future PR.
- [x] Add quotes to all integers.
- [x] Remove `rest_types`
- [x] Address missing beacon block error. (#1629)
- [x] ~~Add tests for lighthouse/peers endpoints~~ Wontfix
- [x] ~~Follow up with validator status proposal~~ Tracked in #1434
- [x] Unify graffiti structs
- [x] ~~Start server when waiting for genesis?~~ Will fix in future PR.
- [x] TODO in http_api tests
- [x] Move lighthouse endpoints off /eth/v1
- [x] Update docs to link to standard

- ~~Blocked on #1586~~

Co-authored-by: Michael Sproul <michael@sigmaprime.io>
2020-10-01 11:12:36 +10:00
..
css Make API friendly to block explorers (#702) 2019-12-19 11:45:28 +11:00
js Add support for multiple testnet flags (#1396) 2020-07-29 06:39:29 +00:00
advanced_database.md Document the freezer DB space-time trade-off (#808) 2020-01-20 10:01:58 +11:00
advanced_metrics.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
advanced.md Document the freezer DB space-time trade-off (#808) 2020-01-20 10:01:58 +11:00
api-bn.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
api-lighthouse.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
api-vc.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
api.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
become-a-validator-docker.md Book modifications to include testnet param (#1418) 2020-07-31 02:14:50 +00:00
become-a-validator-source.md Add --staking flag (#1641) 2020-09-23 01:19:58 +00:00
become-a-validator.md Book modifications to include testnet param (#1418) 2020-07-31 02:14:50 +00:00
cli.md Minor useability updates (#1005) 2020-04-15 17:46:03 +10:00
contributing.md Update CONTRIBUTING.md (#751) 2020-01-03 10:45:53 +11:00
cross-compiling.md Revert "Update BLST, add force-adx support (#1595)" (#1649) 2020-09-23 00:25:56 +00:00
docker.md Revert 1502 - Switching docker user to lighthouse (#1578) 2020-09-01 01:32:02 +00:00
faq.md Correct book links (#1338) 2020-07-07 17:28:59 +10:00
http.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
installation.md Update installation.md (#1467) 2020-08-06 04:29:21 +00:00
intro.md Remove references to rust-docs (#1601) 2020-09-10 00:24:41 +00:00
key-management.md Directory restructure (#1532) 2020-10-01 11:12:35 +10:00
key-recovery.md Mnemonic key recovery (#1579) 2020-09-08 12:17:51 +00:00
local-testnets.md Update local testnet scripts, fix eth1 sim (#1184) 2020-05-26 18:30:44 +10:00
pi.md Cross-compile to vendored x86_84, aarch64 (Raspberry Pi 4) (#1497) 2020-08-11 05:16:30 +00:00
setup.md Directory Restructure (#1163) 2020-05-18 21:24:23 +10:00
SUMMARY.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
validator-create.md Directory restructure (#1532) 2020-10-01 11:12:35 +10:00
validator-import-launchpad.md Add EF launchpad import (#1381) 2020-07-29 04:32:50 +00:00
validator-inclusion.md Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
validator-management.md Directory restructure (#1532) 2020-10-01 11:12:35 +10:00
wallet-create.md Minor documentation fixes (#1297) 2020-09-02 04:59:22 +00:00