Nomos blockchain node
Go to file
Al Liu b43d268543
Finish the skeleton of the api for nomos-node (#451)
* finish the barebone of the api for nomos-node
2023-10-06 16:32:35 +08:00
.cargo fix link flgs (#144) 2023-05-08 17:28:10 +02:00
.github remove waku from the codebase (#446) 2023-10-02 16:41:08 +08:00
ci remove waku from the codebase (#446) 2023-10-02 16:41:08 +08:00
consensus-engine fix clippy and check warnings (#452) 2023-10-06 15:08:52 +08:00
mixnet Nomos node config (#423) 2023-10-05 15:16:40 +03:00
nodes Nomos node config (#423) 2023-10-05 15:16:40 +03:00
nomos-cli Send certificate to node after dissemination + tests (#450) 2023-10-04 13:37:13 +02:00
nomos-core Add a canonical way to get an id for Attestation and Certificate (#448) 2023-10-02 15:59:57 +02:00
nomos-da fix clippy and check warnings (#452) 2023-10-06 15:08:52 +08:00
nomos-http-api Finish the skeleton of the api for nomos-node (#451) 2023-10-06 16:32:35 +08:00
nomos-libp2p Remove unnecessary dependencies (#433) 2023-09-25 17:26:21 +09:00
nomos-services fix clippy and check warnings (#452) 2023-10-06 15:08:52 +08:00
simulations Nomos node tree overlay (#415) 2023-10-05 11:56:24 +03:00
testnet Nomos node config (#423) 2023-10-05 15:16:40 +03:00
tests fix clippy and check warnings (#452) 2023-10-06 15:08:52 +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 Docker compose for small libp2p node network (#364) 2023-09-15 17:27:38 +03:00
.gitignore Docker compose for small libp2p node network (#364) 2023-09-15 17:27:38 +03:00
Cargo.toml Finish the skeleton of the api for nomos-node (#451) 2023-10-06 16:32:35 +08:00
Dockerfile remove waku from the codebase (#446) 2023-10-02 16:41:08 +08:00
README.md Update README.md (#120) 2023-04-24 11:05:00 +02:00
compose.yml Docker compose for small libp2p node network (#364) 2023-09-15 17:27:38 +03: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 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