Nomos blockchain node
Go to file
Al Liu 50cb9930ae
Update overlay.rs
2024-03-21 11:02:32 +08:00
.cargo try to fix blocking test 2024-03-04 21:11:42 +08:00
.github Use 2x timeout for integration tests in Codecov CI (#533) 2023-11-28 09:02:24 +09:00
ci try to fix blocking test 2024-03-04 21:11:42 +08:00
consensus Update overlay.rs 2024-03-21 11:02:32 +08:00
mixnet fix: typos in the docs (#527) 2023-11-13 11:49:37 +09:00
nodes Fix clippy 2024-03-21 11:01:00 +08:00
nomos-cli Fix clippy 2024-03-21 11:01:00 +08:00
nomos-core consensus-engine to carnot-engine. (#551) 2024-01-04 15:09:43 +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 Revert: Stop using msg hash as a libp2p msg ID 2023-10-31 19:56:36 +09:00
nomos-metrics Prometheus metrics service (#522) 2024-01-12 16:15:12 +02:00
nomos-services explorer tests 2024-03-11 18:14:51 +08:00
nomos-utils do not use prefix in serialization (#514) 2023-11-07 15:24:49 +01:00
simulations bump rayon version to make ra work (#557) 2024-01-15 12:21:33 +08:00
testnet try to fix blocking test 2024-03-04 21:11:42 +08:00
tests Remove unused println 2024-03-21 10:00:22 +08: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 Configure supermajority threshold via envvars (#471) 2023-10-30 10:38:57 +02:00
.env.testnet Update testnet related configuration (#524) 2023-11-10 16:19:52 +02:00
.gitignore Store logs from failed CI as artifacts (#508) 2023-11-07 09:38:10 +09:00
Cargo.toml merge 2024-03-04 21:16:38 +08: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 try to fix blocking test 2024-03-04 21:11:42 +08:00
compose.yml Docker compose consensus layer config (#482) 2023-10-30 16:51:40 +02:00
rustfmt.toml add rustfmt.toml (#118) 2023-04-19 15:59:51 +08:00
shell.nix try to fix blocking test 2024-03-04 21:11:42 +08: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