Nomos blockchain node
Go to file
Al Liu ba90ed1b55
Nomos http API (#476)
* Info api

* Da blob api (#487)

* Add storage api for new http backend (#488)

* Mempool add APIs (#489)
2023-11-01 17:14:58 +08:00
.cargo
.github
ci CI: Integration tests report (#484) 2023-10-27 20:54:56 +03:00
consensus-engine Nomos http API (#476) 2023-11-01 17:14:58 +08:00
mixnet
nodes Nomos http API (#476) 2023-11-01 17:14:58 +08:00
nomos-cli Add DA utilities to nomos-cli (#493) 2023-10-30 16:19:25 +01:00
nomos-core Remove block contents from mempool (#485) 2023-10-30 12:38:04 +01:00
nomos-da Nomos http API (#476) 2023-11-01 17:14:58 +08:00
nomos-libp2p Revert: Stop using msg hash as a libp2p msg ID 2023-10-31 19:56:36 +09:00
nomos-services Nomos http API (#476) 2023-11-01 17:14:58 +08:00
nomos-utils Humanize array ser/deser (#468) 2023-10-26 23:16:10 +08:00
simulations Fix typos (#481) 2023-10-31 14:38:42 +01:00
testnet Docker compose consensus layer config (#482) 2023-10-30 16:51:40 +02:00
tests Fix typos (#481) 2023-10-31 14:38:42 +01:00
.codecov.yml
.dockerignore
.env.example Configure supermajority threshold via envvars (#471) 2023-10-30 10:38:57 +02:00
.gitignore
Cargo.toml Metrics api (#466) 2023-10-31 17:20:04 +08:00
Dockerfile
README.md
compose.yml Docker compose consensus layer config (#482) 2023-10-30 16:51:40 +02:00
rustfmt.toml
shell.nix
sim_config.json.example

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