Nomos blockchain node
Go to file
Al Liu 47487f0be7
Fix clippy (#620)
2024-03-21 16:46:16 +01:00
.cargo fix link flgs (#144) 2023-05-08 17:28:10 +02:00
.github Replace mixnet backend with mixnet addon (#615) 2024-03-19 19:15:09 +09:00
ci Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
consensus Add cryptarchia consensus service (#612) 2024-03-15 15:53:51 +01:00
ledger/cryptarchia-ledger add cryptarchia leadership (#613) 2024-03-18 16:04:16 +01:00
mixnet Remove unnecessary attributes and add doc comments for Mixnet (#618) 2024-03-21 23:06:32 +09:00
nodes/nomos-node Use rocksdb as storage backend (#585) 2024-03-21 12:23:26 +01:00
nomos-cli Replace mixnet backend with mixnet addon (#615) 2024-03-19 19:15:09 +09:00
nomos-core Fix clippy (#620) 2024-03-21 16:46:16 +01:00
nomos-da Update code related to rust-kzg according to its latest ver (#538) 2023-11-28 17:55:55 +09:00
nomos-libp2p Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
nomos-metrics Prometheus metrics service (#522) 2024-01-12 16:15:12 +02:00
nomos-services Use rocksdb as storage backend (#585) 2024-03-21 12:23:26 +01:00
nomos-utils Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
simulations Refactor block (#609) 2024-03-13 18:46:10 +01:00
testnet Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
tests Replace mixnet backend with mixnet addon (#615) 2024-03-19 19:15:09 +09:00
.codecov.yml Disable codecov annotations (#409) 2023-09-15 15:11:50 +03:00
.dockerignore Docker image for nomos node (#60) 2023-02-01 10:37:15 +02:00
.env.example Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
.env.testnet Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
.gitignore Store logs from failed CI as artifacts (#508) 2023-11-07 09:38:10 +09:00
Cargo.toml Add cryptarchia consensus service (#612) 2024-03-15 15:53:51 +01:00
Dockerfile Bump rust (#602) 2024-03-01 13:28:05 +02:00
README.md Fix typos (#503) 2023-11-03 09:29:40 +01:00
compose.static.yml Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
compose.yml Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
rustfmt.toml add rustfmt.toml (#118) 2023-04-19 15:59:51 +08:00
shell.nix Bump rust (#602) 2024-03-01 13:28:05 +02:00
sim_config.json.example Simulation initialization (#122) 2023-05-08 13:06:39 +03:00

README.md

nomos-node

Nomos blockchain node mvp

Project structure

  • nomos-core: Nomos core is the collection of essential structures for the Nomos mvp and experimental nodes.
  • nomos-services: Nomos services is the collection of components that are used as building blocks of the Nomos node prototype and the experimental nodes.
    • consensus
    • log
    • http
    • mempool
    • network
    • metrics
  • nodes: Nomos nodes is the collection of nodes that are used to run the Nomos mvp and experimental nodes.
    • nomos-node: main implementation of the Nomos mvp node.
    • mockpool-node: node with single mempool service, used to measure transaction dissemination.

Services

The Nomos node uses Overwatch as its main internal framework. This means that services request communication channels to other services to interchange information through a specified messaging API.

Service architecture

Most of the services are implemented with the same idea behind. There is a front layer responsible for handling the Overwatch service and a back layer that implements the actual service logic.

This allows us to easily replace components as needed in a type level system. In any case, a node can be setup in a declarative way composing the types. For example:

...
#[derive(Services)]
struct MockPoolNode {
    logging: ServiceHandle<Logger>,
    network: ServiceHandle<NetworkService<Waku>>,
    mockpool: ServiceHandle<MempoolService<WakuAdapter<Tx>, MockPool<TxId, Tx>>>,
    http: ServiceHandle<HttpService<AxumBackend>>,
    bridges: ServiceHandle<HttpBridgeService>,
}

Docker

To build and run a docker container with Nomos node run:

docker build -t nomos .
docker run nomos /etc/nomos/config.yml

To run a node with a different configuration run:

docker run -v /path/to/config.yml:/etc/nomos/config.yml nomos /etc/nomos/config.yml