Nomos blockchain node
Go to file
Al Liu e24e0a357b
Merge branch 'master' into overwatch-error
2023-11-09 14:17:13 +08:00
.cargo fix link flgs (#144) 2023-05-08 17:28:10 +02:00
.github Store logs from failed CI as artifacts (#508) 2023-11-07 09:38:10 +09:00
ci CI: Integration tests report (#484) 2023-10-27 20:54:56 +03:00
consensus-engine Split long consensus response in separate APIs (#502) 2023-11-06 12:43:48 +01:00
mixnet Mixnet client address config 2023-10-18 16:14:24 +03:00
nodes fix fmt 2023-11-09 14:15:43 +08:00
nomos-cli fix comments 2023-11-09 13:49:09 +08:00
nomos-core Do not skip Block::id during ser/de (#505) 2023-11-03 10:14:26 +01:00
nomos-da New http api to nomos-node integration (#490) 2023-11-08 16:55:47 +08:00
nomos-libp2p Revert: Stop using msg hash as a libp2p msg ID 2023-10-31 19:56:36 +09:00
nomos-services Merge branch 'master' into overwatch-error 2023-11-09 14:17:13 +08:00
nomos-utils do not use prefix in serialization (#514) 2023-11-07 15:24:49 +01:00
simulations Fix typos (#481) 2023-10-31 14:38:42 +01:00
testnet Da voter config for docker compose (#513) 2023-11-07 13:52:27 +02:00
tests update overwatch version 2023-11-08 17:03:07 +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
.gitignore Store logs from failed CI as artifacts (#508) 2023-11-07 09:38:10 +09:00
Cargo.toml Metrics api (#466) 2023-10-31 17:20:04 +08:00
Dockerfile Update libp2p node config 2023-10-17 14:46:41 +03:00
README.md Fix typos (#503) 2023-11-03 09:29:40 +01:00
compose.static.yml Da voter config for docker compose (#513) 2023-11-07 13:52:27 +02: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 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 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