jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync project layout docs (#550)

Browse Source
This commit is contained in:
Sanket Shanbhag
2022-12-21 14:47:14 +05:30
committed by GitHub
parent b2abcddeda
commit d926c75da2
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/repo/layout.md
View File

@ -18,24 +18,31 @@ These crates define primitive types or algorithms such as RLP.
- [`common/rlp`](../../crates/common/rlp): An implementation of RLP, forked from an earlier Apache-licensed version of [`fastrlp`][fastrlp]
- [`common/rlp-derive`](../../crates/common/rlp-derive): Forked from an earlier Apache licenced version of the [`fastrlp-derive`][fastrlp-derive] crate, before it changed licence to GPL.
### Database
### Storage
These crates are related to the database.
- [`codecs`](../../crates/storage/codecs): Different storage codecs.
- [`libmdbx-rs`](../../crates/storage/libmdbx-rs): Rust bindings for [libmdbx](https://libmdbx.dqdkfa.ru). A fork of an earlier Apache-licensed version of [libmdbx-rs][libmdbx-rs].
- [`db`](../../crates/storage/db): Strongly typed database bindings to LibMDBX containing read/write access to Ethereum state and historical data (transactions, blocks etc.)
- [`storage/codecs`](../../crates/storage/codecs): Different storage codecs.
- [`storage/libmdbx-rs`](../../crates/storage/libmdbx-rs): Rust bindings for [libmdbx](https://libmdbx.dqdkfa.ru). A fork of an earlier Apache-licensed version of [libmdbx-rs][libmdbx-rs].
- [`storage/db`](../../crates/storage/db): Strongly typed Database abstractions (transactions, cursors, tables) over lower level database backends.
- Implemented backends: mdbx
- [`storage/provider`](../../crates/storage/provider): Traits which provide a higher level api over the database to access the Ethereum state and historical data (transactions, blocks etc.)
### Networking
These crates are related to networking (p2p and RPC), as well as networking protocols.
- [`net/common`](../../crates/net/common): Shared types used across multiple networking crates.
- Contains: Peer banlist.
#### P2P
- [`net/network`](../../crates/net/network): The main P2P networking crate, handling message egress, message ingress, peer management, and session management.
- [`net/eth-wire`](../../crates/net/eth-wire): Implements the `eth` wire protocol and the RLPx networking stack.
- [`net/discv4`](../../crates/net/discv4): An implementation of the [discv4][discv4] protocol
- [`net/ipc`](../../crates/net/ipc): IPC server and client implementation for [`jsonrpsee`][jsonrpsee].
- [`net/ecies`](../../crates/net/ecies): Implementation of the Elliptic Curve Integrated Encryption Scheme used in the RLPx handshake.
#### RPC
@ -47,8 +54,7 @@ These crates are related to networking (p2p and RPC), as well as networking prot
#### Downloaders
- [`net/bodies-downloaders`](../../crates/net/bodies-downloaders): Block body downloading strategies.
- [`net/headers-downloaders`](../../crates/net/headers-downloaders): Header downloading strategies.
- [`net/downloaders`](../../crates/net/downloaders/): Block body and header downloading strategies.
### Ethereum