zrt-node

Node for zero-art protocol

Project structure:

• apps
  • zrt-node - node which takes a role of a intermediate server, storing data for users
• crates
  • api - main logic of a server
  • callback - small helper crate for defining structures for communication between api and proof-verifier.
  • proof-verifier - separate proof verifier
  • storage - mongo db storage
  • tests - unit tests for a project
  • types - library with types used in the project. It contains errors, mongodb records, requests, responses, queries, etc.

Docker Build

To build the Docker image with access to private GitHub repositories:

DOCKER_BUILDKIT=1 docker build --ssh default .

This command uses Docker BuildKit with SSH agent forwarding to authenticate with private GitHub repositories during the build process.

Build features

• zrt-node features

  • default - Enables verification feature. To run the node without default features, use --no-default-features command line option.
  • verification - Enable api/verification feature.

• api features

  • api/verification - Enable Proof verification. (Automatically enables api/art_modifications feature.)

• tests feature

  • tests/integration_tests - Enables integration tests.
  • tests/merge_changes - configure tests, to work with merge_changes config enabled

Run

To run the node without features use --no-default-features option.

cargo run -p zrt-node --no-default-features --release -- run --config config.toml

Tests

Unit tests

Integration tests

To test the node api, one should prepare the environment. Firstly raise the infrastructure in docker. Node can be run in docker or locally. Then one can run tests with integration_tests and or merge_changes features like the next:

cargo test -p tests --features integration_tests,merge_changes