Nomos blockchain node
Go to file
gusto 4981c724af
Http status codes (#88)
* Include status codes in http error responses

* Mockpool bridges error handling

* Last TX in milliseconds in mempool metrics

* u64 for last tx metrics
2023-03-06 15:19:27 +02:00
.cargo Waku cached streams consensus adapter (#70) 2023-02-15 16:49:49 +01:00
.github/workflows Autoauthor action (#51) 2023-01-18 17:10:13 +02:00
ci Add a step to run cargo build w/o features (#52) 2023-01-19 16:34:35 +02:00
nodes Http status codes (#88) 2023-03-06 15:19:27 +02:00
nomos-core Improve Mock network (#78) 2023-02-21 16:10:26 +08:00
nomos-services Http status codes (#88) 2023-03-06 15:19:27 +02:00
.dockerignore Docker image for nomos node (#60) 2023-02-01 10:37:15 +02:00
.gitignore Http status codes (#88) 2023-03-06 15:19:27 +02:00
Cargo.toml Mockpool node (#53) 2023-01-25 07:24:33 -08:00
Dockerfile Docker image for nomos node (#60) 2023-02-01 10:37:15 +02:00
README.md Add services and project information to project README (#72) 2023-02-10 17:07:04 +01:00
config.yml.example Http status codes (#88) 2023-03-06 15:19:27 +02:00
shell.nix Fix Nix derivation so it works in a Darwin Nix environment (explicitly requiring clang and setting env variable) (#84) 2023-02-24 11:08:46 +02:00

README.md

nomos-research

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