Nomos blockchain node
Go to file
Al Liu 40048fa47b
Fix #183: support structured log for sim app. (#184)
2023-06-16 19:26:48 +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 ci: fix GOCACHE and GOPATH to avoid poisoning (#125) 2023-06-13 11:29:01 +03:00
consensus-engine fix: prevent approving new views not bigger than the last timeout_qc (#165) 2023-06-15 18:31:52 +09:00
nodes Carnot info api (#177) 2023-06-15 11:29:50 +02:00
nomos-core Simulation happy path (#161) 2023-06-14 16:52:37 +02:00
nomos-services Carnot info api (#177) 2023-06-15 11:29:50 +02:00
simulations Fix #183: support structured log for sim app. (#184) 2023-06-16 19:26:48 +08: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 Consensus engine rework (#127) 2023-04-27 19:18:24 +02:00
Dockerfile Docker image for nomos node (#60) 2023-02-01 10:37:15 +02:00
README.md Update README.md (#120) 2023-04-24 11:05:00 +02:00
config.yml.example Http status codes (#88) 2023-03-06 15:19:27 +02:00
rustfmt.toml add rustfmt.toml (#118) 2023-04-19 15:59:51 +08: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
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