Fix typos in READMEs
This commit is contained in:
parent
6fac35a7c5
commit
8842adb53b
24
README.md
24
README.md
@ -31,15 +31,15 @@ If you'd like some background on Sigma Prime, please see the [Lighthouse Update
|
|||||||
|
|
||||||
### Directory Structure
|
### Directory Structure
|
||||||
|
|
||||||
- [`/beacon_node`](beacon_node/): the "Beacon Node" binary and crates exclusively
|
- [`beacon_node/`](beacon_node/): the "Beacon Node" binary and crates exclusively
|
||||||
associated with it.
|
associated with it.
|
||||||
- [`/docs`](docs/): documentation related to the repository. This include contributor
|
- [`docs/`](docs/): documentation related to the repository. This include contributor
|
||||||
guides, etc. Code documentation is produced with `cargo doc`.
|
guides, etc. (Code documentation is produced with `cargo doc`).
|
||||||
- [`/eth2`](eth2/): Crates containing common logic across the Lighthouse project. For
|
- [`eth2/`](eth2/): Crates containing common logic across the Lighthouse project. For
|
||||||
example; Ethereum 2.0 types (`BeaconBlock`, `BeaconState`, etc) and
|
example; Ethereum 2.0 types ([`BeaconBlock`](eth2/types/src/beacon_block.rs), [`BeaconState`](eth2/types/src/beacon_state.rs), etc) and
|
||||||
SimpleSerialize (SSZ).
|
SimpleSerialize (SSZ).
|
||||||
- [`/protos`](protos/): protobuf/gRPC definitions common across the Lighthouse project.
|
- [`protos/`](protos/): protobuf/gRPC definitions common across the Lighthouse project.
|
||||||
- [`/validator_client`](validator_client/): the "Validator Client" binary and crates exclusively
|
- [`validator_client/`](validator_client/): the "Validator Client" binary and crates exclusively
|
||||||
associated with it.
|
associated with it.
|
||||||
|
|
||||||
### Components
|
### Components
|
||||||
@ -92,16 +92,6 @@ In addition to these components we are also working on database schemas, RPC
|
|||||||
frameworks, specification development, database optimizations (e.g.,
|
frameworks, specification development, database optimizations (e.g.,
|
||||||
bloom-filters), and tons of other interesting stuff (at least we think so).
|
bloom-filters), and tons of other interesting stuff (at least we think so).
|
||||||
|
|
||||||
### Directory Structure
|
|
||||||
|
|
||||||
Here we provide an overview of the directory structure:
|
|
||||||
|
|
||||||
- `beacon_chain/`: contains logic derived directly from the specification.
|
|
||||||
E.g., shuffling algorithms, state transition logic and structs, block
|
|
||||||
validation, BLS crypto, etc.
|
|
||||||
- `lighthouse/`: contains logic specific to this client implementation. E.g.,
|
|
||||||
CLI parsing, RPC end-points, databases, etc.
|
|
||||||
|
|
||||||
### Running
|
### Running
|
||||||
|
|
||||||
**NOTE: The cryptography libraries used in this implementation are
|
**NOTE: The cryptography libraries used in this implementation are
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# eth2
|
# Ethereum 2.0 Common Crates
|
||||||
|
|
||||||
Rust crates containing logic common across the Lighthouse project.
|
Rust crates containing logic common across the Lighthouse project.
|
||||||
|
|
||||||
@ -13,25 +13,22 @@ Rust crates containing logic common across the Lighthouse project.
|
|||||||
- [`types/`](types/): Defines base Ethereum 2.0 types (e.g., `BeaconBlock`,
|
- [`types/`](types/): Defines base Ethereum 2.0 types (e.g., `BeaconBlock`,
|
||||||
`BeaconState`, etc).
|
`BeaconState`, etc).
|
||||||
- [`utils/`](utils/):
|
- [`utils/`](utils/):
|
||||||
- [`bls`](utils/bls/): A wrapper around some external BLS encryption library.
|
- [`bls`](utils/bls/): A wrapper around an external BLS encryption library.
|
||||||
- [`boolean-bitfield`](utils/boolean-bitfield/): Provides an expandable Vec
|
- [`boolean-bitfield`](utils/boolean-bitfield/): Provides an expandable Vec
|
||||||
of bools, specifically for use in Eth2.
|
of bools, specifically for use in Eth2.
|
||||||
- [`fisher-yates-shuffle`](utils/fisher-yates-shuffle/): shuffles a list
|
- [`fisher-yates-shuffle`](utils/fisher-yates-shuffle/): shuffles a list
|
||||||
pseudo-randomly.
|
pseudo-randomly.
|
||||||
- [`hashing`](utils/hashing/): Provides unified hashing methods, provided
|
- [`hashing`](utils/hashing/): A wrapper around external hashing libraries.
|
||||||
be some external library.
|
|
||||||
- [`honey-badger-split`](utils/honey-badger-split/): Splits a list in `n`
|
- [`honey-badger-split`](utils/honey-badger-split/): Splits a list in `n`
|
||||||
parts without giving AF about the length of the list, `n` or anything
|
parts without giving AF about the length of the list, `n` or anything
|
||||||
else.
|
else.
|
||||||
- [`int-to-bytes`](utils/int-to-bytes/): Simple library which converts ints
|
- [`int-to-bytes`](utils/int-to-bytes/): Simple library which converts ints
|
||||||
into byte-strings of various lengths.
|
into byte-strings of various lengths.
|
||||||
- [`slot_clock`](utils/slot_clock/): translates the system time into Beacon
|
- [`slot_clock`](utils/slot_clock/): translates the system time into Beacon
|
||||||
- Chain "slots". Also
|
Chain "slots". (Also provides another slot clock that's useful during
|
||||||
provides another slot clock that's useful during testing.
|
testing.)
|
||||||
- [`ssz`](utils/ssz/): an implementation of the SimpleSerialize
|
- [`ssz`](utils/ssz/): an implementation of the SimpleSerialize
|
||||||
- serialization/deserialization
|
serialization/deserialization protocol used by Eth 2.0.
|
||||||
protocol used by
|
|
||||||
Eth 2.0.
|
|
||||||
- [`ssz_derive`](utils/ssz_derive/): provides procedural macros for
|
- [`ssz_derive`](utils/ssz_derive/): provides procedural macros for
|
||||||
deriving SSZ `Encodable`, `Decodable` and `TreeHash` methods.
|
deriving SSZ `Encodable`, `Decodable` and `TreeHash` methods.
|
||||||
- [`swap_or_not_shuffle`](utils/swap_or_not_shuffle/): a list-shuffling
|
- [`swap_or_not_shuffle`](utils/swap_or_not_shuffle/): a list-shuffling
|
||||||
|
Loading…
Reference in New Issue
Block a user