Nomos blockchain node
Go to file
Giacomo Pasini b7865b27ec
fix coverage workflow (#736)
* fix coverage workflow

* fix action

* do not run tests

* build binaries

* clean before tests

* only compile tests

* clean dir

* remove intermediate artficats
2024-09-13 15:05:50 +02:00
.cargo fix link flgs (#144) 2023-05-08 17:28:10 +02:00
.github fix coverage workflow (#736) 2024-09-13 15:05:50 +02:00
book Add mdBook skeleton (#640) 2024-04-24 23:18:51 +09:00
ci CI: Rust 1.80 (#684) 2024-07-31 15:40:32 +03:00
cl/cl Add PoL (#718) 2024-09-03 14:38:00 +02:00
consensus chore: cryptarchia unit tests update (#657) 2024-06-27 19:22:54 +02:00
ledger/cryptarchia-ledger Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02:00
mixnet Remove unnecessary attributes and add doc comments for Mixnet (#618) 2024-03-21 23:06:32 +09:00
nodes/nomos-node Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02:00
nomos-cli DA: Nomos Cli dispersal tests (#711) 2024-08-30 13:02:02 +03:00
nomos-core Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02:00
nomos-da Column index in the sample requests (#731) 2024-09-06 18:39:50 +03:00
nomos-libp2p Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02:00
nomos-services Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02:00
nomos-utils Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
proof_of_leadership Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02:00
testnet CI: Rust 1.80 (#684) 2024-07-31 15:40:32 +03:00
tests Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02: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 Graylog service for the Testnet (#659) 2024-06-14 14:22:16 +03:00
.gitignore Store logs from failed CI as artifacts (#508) 2023-11-07 09:38:10 +09:00
Cargo.toml Integrate PoL into consensus (#721) 2024-09-11 01:59:09 +02:00
Dockerfile CI: Rust 1.80 (#684) 2024-07-31 15:40:32 +03:00
README.md Fix typos (#503) 2023-11-03 09:29:40 +01:00
compose.static.yml fix missing build settings for libp2p nodes (#668) 2024-06-28 11:13:48 +03: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 CI: Rust 1.80 (#684) 2024-07-31 15:40:32 +03: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