Nomos blockchain node
Go to file
Daniel Sanchez e5ec2b7739
Update resolver version in workspace (#337)
* Update resolver version in workspace

* Clippy happy
2023-08-29 15:45:48 +02:00
.cargo fix link flgs (#144) 2023-05-08 17:28:10 +02:00
.github/workflows Update and rename main.yml to master.yml (#194) 2023-06-15 12:48:36 +03:00
ci Add missing build and test flags (#301) 2023-08-10 14:20:19 +03:00
consensus-engine Using CSV format by default for simulations (#304) 2023-08-21 12:02:10 +08:00
nodes/nomos-node Add libp2p backend to nomos-node (#285) 2023-08-09 07:42:08 +02:00
nomos-core fix waku feature gate (#260) 2023-07-14 15:59:16 +08:00
nomos-da-core Fix kzg bench (#336) 2023-08-29 13:27:52 +02:00
nomos-libp2p Small fixes for libp2p network backend (#280) 2023-08-07 06:00:41 +02:00
nomos-services Update resolver version in workspace (#337) 2023-08-29 15:45:48 +02:00
simulations Using CSV format by default for simulations (#304) 2023-08-21 12:02:10 +08:00
tests Revert/improve `get_available_port()` in tests (#334) 2023-08-29 20:25:05 +09:00
.DS_Store Add generic block (#93) 2023-03-14 09:55:08 -07:00
.dockerignore Docker image for nomos node (#60) 2023-02-01 10:37:15 +02:00
.gitignore Simulation initialization (#122) 2023-05-08 13:06:39 +03:00
Cargo.toml Update resolver version in workspace (#337) 2023-08-29 15:45:48 +02:00
Dockerfile Changed mockpool-node to nomos-node in Dockerfile (#212) 2023-06-21 12:02:56 +02:00
README.md Update README.md (#120) 2023-04-24 11:05:00 +02:00
rustfmt.toml add rustfmt.toml (#118) 2023-04-19 15:59:51 +08:00
shell.nix build: bump Rust to 1.70.0 to resolve clippy errors (#201) 2023-06-20 00:03:54 +09: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 implement 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