Nomos blockchain node
Go to file
Al Liu 6dee12704d
Change simulation `Node` trait `current_view` method return `View` (#259)
2023-07-20 17:31:55 +08: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 Updated integration tests cases, increased nightly iteration count (#263) 2023-07-17 21:16:05 +03:00
consensus-engine Tree settings for sim overlay (#257) 2023-07-18 14:44:23 +03:00
nodes/nomos-node feat: add `nomos-libp2p` crate (for nomos-network backend) (#237) 2023-07-11 10:33:57 +02:00
nomos-core fix waku feature gate (#260) 2023-07-14 15:59:16 +08:00
nomos-libp2p feat: add `nomos-libp2p` crate (for nomos-network backend) (#237) 2023-07-11 10:33:57 +02:00
nomos-services fix waku feature gate (#260) 2023-07-14 15:59:16 +08:00
simulations Change simulation `Node` trait `current_view` method return `View` (#259) 2023-07-20 17:31:55 +08:00
tests Tree settings for sim overlay (#257) 2023-07-18 14:44:23 +03: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 feat: add `nomos-libp2p` crate (for nomos-network backend) (#237) 2023-07-11 10:33:57 +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