nimbus-eth2/beacon_chain/consensus_object_pools
Jacek Sieka 233d756518
Logging and startup improvements (#3038)
* Logging and startup improvements

Color support for released binaries!

* startup scripts no longer log to file by default - this only affects
source builds - released binaries don't support file logging
* add --log-stdout option to control logging to stdout (colors, json)
* detect tty:s vs redirected logs and log accordingly
* add option to disable log colors at runtime
* simplify several "common" logs, showing the most important information
earlier and more clearly
* remove line numbers / file information / tid - these take up space and
are of little use to end users
  * still enabled in debug builds and tools
* remove `testnet_servers_image` compile-time option
* server images, released binaries and compile-from-source now offer
the same behaviour and features
* fixes https://github.com/status-im/nimbus-eth2/issues/2326
* fixes https://github.com/status-im/nimbus-eth2/issues/1794
* remove instanteneous block speed from sync message, keeping only
average

before:

```
INF 2021-10-28 16:45:59.000+02:00 Slot start                                 topics="beacnde" tid=386429 file=nimbus_beacon_node.nim:884 lastSlot=2384027 wallSlot=2384028 delay=461us84ns peers=0 head=75a10ee5:3348 headEpoch=104 finalized=cd6804ba:3264 finalizedEpoch=102 sync="wwwwwwwwww:0:0.0000:0.0000:00h00m (3348)"
INF 2021-10-28 16:45:59.046+02:00 Slot end                                   topics="beacnde" tid=386429 file=nimbus_beacon_node.nim:821 slot=2384028 nextSlot=2384029 head=75a10ee5:3348 headEpoch=104 finalizedHead=cd6804ba:3264 finalizedEpoch=102 nextAttestationSlot=-1 nextProposalSlot=-1 nextActionWait=n/a
```

after:

```
INF 2021-10-28 22:43:23.033+02:00 Slot start                                 topics="beacnde" slot=2385815 epoch=74556 sync="DDPDDPUDDD:10:5.2258:01h19m (2361088)" peers=37 head=eacd2dae:2361096 finalized=73782:a4751487 delay=33ms687us715ns
INF 2021-10-28 22:43:23.291+02:00 Slot end                                   topics="beacnde" slot=2385815 nextActionWait=n/a nextAttestationSlot=-1 nextProposalSlot=-1 head=eacd2dae:2361096
```

* fix comment

* documentation updates

* mention `--log-file` may be deprecated in the future
* update various docs
2021-11-02 18:06:36 +01:00
..
README.md v1.1.3 spec refs URLs (#3036) 2021-10-27 18:40:17 +00:00
attestation_pool.nim import cleanup (#2997) 2021-10-19 16:09:26 +02:00
block_clearance.nim add drop and sync committee metrics 2021-10-20 18:20:12 +03:00
block_pools_types.nim Number of REST fixes. (#2961) 2021-10-06 15:43:03 +02:00
block_quarantine.nim implement forked merge state/block support (#2890) 2021-09-27 14:22:58 +00:00
blockchain_dag.nim Logging and startup improvements (#3038) 2021-11-02 18:06:36 +01:00
exit_pool.nim refactor executionPayload tests; reduce HashSet creation (#3003) 2021-10-20 13:36:38 +02:00
forkedbeaconstate_dbhelpers.nim clean up fork enum and field names 2021-10-19 11:06:38 +03:00
spec_cache.nim v1.1.3 spec refs URLs (#3036) 2021-10-27 18:40:17 +00:00
sync_committee_msg_pool.nim odds and ends (#3015) 2021-10-21 15:09:19 +02:00

README.md

Consensus object pools

This folder holds the various consensus object pools needed for a blockchain client.

Object in those pools have passed the "gossip validation" filter according to specs:

After "gossip validation" the consensus objects can be rebroadcasted as they are optimistically good, however for internal processing further verification is needed. For blocks, this means verifying state transition and all contained cryptographic signatures (instead of just the proposer signature). For other consensus objects, it is possible that gossip validation is a superset of consensus verification (TODO).

The pools presenet in this folder are:

  • block_pools:
    • block_quarantine: for seemingly valid blocks that are on a fork unknown to us.
    • block_clearance: to verify (state_transition + cryptography) candidate blocks.
    • blockchain_dag: an in-memory direct-acyclic graph of fully validated and verified blockchain candidates with the tail being the last finalized epoch. A block in the DAG MUST be in the fork choice and a block in the fork choice MUST be in the DAG (except for orphans following finalization). On finalization non-empty epoch blocks are stored in the beacon_chain_db.
  • attestation_pool: Handles the attestation received from gossip and collect them for fork choice.
  • exit_pool: Handle voluntary exits and forced exits (attester slashings and proposer slashings)