Nomos blockchain node
Go to file
gusto b4b24e4678
Rust 1.79 stable (#661)
* Rust 1.79 clippy fix

* Rust 1.79 stable in ci and docker

* Allow unused_var in nomos tests

Clippy struggle to recognize the usage of enumeration variable inside one particular testcase.
2024-06-18 10:53:56 +03:00
.cargo fix link flgs (#144) 2023-05-08 17:28:10 +02:00
.github Use windows msvc (as rocksdb fails with gnu toolchain) (#621) 2024-03-22 10:06:37 +01:00
book Add mdBook skeleton (#640) 2024-04-24 23:18:51 +09:00
ci Rust 1.79 stable (#661) 2024-06-18 10:53:56 +03:00
consensus Switch from Carnot to Cryptarchia (#624) 2024-03-28 12:56:04 +01:00
ledger/cryptarchia-ledger Switch from Carnot to Cryptarchia (#624) 2024-03-28 12:56:04 +01:00
mixnet Remove unnecessary attributes and add doc comments for Mixnet (#618) 2024-03-21 23:06:32 +09:00
nodes/nomos-node Graylog service for the Testnet (#659) 2024-06-14 14:22:16 +03:00
nomos-cli DA Protocol V1 (#626) 2024-06-13 11:23:11 +03:00
nomos-core DA Protocol V1 (#626) 2024-06-13 11:23:11 +03:00
nomos-da DA Protocol V1 (#626) 2024-06-13 11:23:11 +03:00
nomos-libp2p Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
nomos-services Missing generic param to the mempool metrics (#662) 2024-06-17 16:30:07 +03:00
nomos-utils Mixnet v1 (#569) 2024-03-12 15:47:35 +09:00
testnet Rust 1.79 stable (#661) 2024-06-18 10:53:56 +03:00
tests Rust 1.79 stable (#661) 2024-06-18 10:53:56 +03: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 DA Protocol V1 (#626) 2024-06-13 11:23:11 +03:00
Dockerfile Rust 1.79 stable (#661) 2024-06-18 10:53:56 +03:00
README.md Fix typos (#503) 2023-11-03 09:29:40 +01:00
compose.static.yml Graylog service for the Testnet (#659) 2024-06-14 14:22:16 +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 Rust 1.79 stable (#661) 2024-06-18 10:53:56 +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