Zenotta Network Protocol

A repo for the development of the Zenotta Network Protocol (ZNP).

We will regularly be updating links and easter eggs inside the code. Please join us on this link on April 13th, 10h00 CET to discuss the design of a social compute. It has a sustainable mining client which also will provide distributed compute at the infrastructure layer. The protocol layer will introduce a very novel file system, all of which feeds an application layer that can be built using APIs. We believe you've never seen anything quite like this and look forward to engaging with you in our community!

..

Setup

The Zenotta Network Protocol (in fact, almost all of Zenotta's code) runs on Rust, so installing this is the first step before dealing with any code. You can install rustup, Rust's toolchain installer, by running the following:

curl https://sh.rustup.rs -sSf | sh

When asked how to proceed, simply selecting the option 1) Proceed with installation is generally the best. You can then run the following to update the PATH variable and check whether everything installed correctly:

source $HOME/.cargo/env
rustc --version

If the terminal responds with the rustc version you're currently running then everything went well, and you're ready to go.

Linux

Linux (Ubuntu 20.04.01 LTS) may require extra package installations depending on what you've developed before. The following package installs assume a completely new machine instance, and should cover everything you need to get going:

sudo apt install build-essential
sudo apt-get install m4
sudo apt-get install llvm
sudo apt-get install libclang-dev

Repo Setup

You can then set up the project on your local machine using the following steps:

• Clone this repo using one of the options in Gitlab
• From your terminal, move into the cloned folder on your local machine
• Run the following:

make

You will also require a local instances of the Zenotta NAOM and Keccak Prime repo, which is a crate dependency. The dependency is listed in the Cargo.toml as:

naom = { path = "../naom" }
keccak_prime = { path = "../keccak-prime" }

The path can be changed as needed. Once done you can build the project using cargo build and run it using cargo run, as per usual.

..

Running Nodes Locally

You can build everything by running

cargo build --release

This will compile everything into a release state, from which you can then run your nodes locally. The following are example commands for each type to get you up and running quickly:

• Compute: RUST_LOG=warp target/release/node compute --config=src/bin/node_settings_local_raft_1.toml
• Storage: RUST_LOG=warp target/release/node storage --config=src/bin/node_settings_local_raft_1.toml
• Miner: RUST_LOG=warp target/release/node miner --config=src/bin/node_settings_local_raft_1.toml
• User: RUST_LOG=warp target/release/node user --config=src/bin/node_settings_local_raft_1.toml

You can provide a number of flags to the command depending on the type of node, and you can view information on the available flags for each node type by running the compiled binary with the --help flag (e.g. target/release/storage --help). You can also run a full, 1 node system in your local environment by running sh src/bin/node_settings_local_raft_1_run.sh and perusing the generated logs.

If you run into TLS problems on the API routes, you can pass --api_use_tls=0 to the shell script in order to disable TLS. Note that this will create a security concern, so it's best not to use this too frequently or for anything public facing.

..

Git Flow

When working on this repo, please ensure that any branches you may create pull from develop regularly. In doing this you ensure that your local version has the latest code for the project and minimizes the possibility of unnecessary merge conflicts.

Zenotta's Git flow generally involves working on each new task in a new branch, which you should checkout from develop and can be done as in the following example

git checkout -b branch_name

where branch_name would be replaced with your chosen branch name. There is no general branch naming convention aside from two cases:

• New features: These should be prefixed with feature_ and then the branch name (e.g. feature_new_cool_feature)
• Bugfixes: These should be prefixed with bugfix_ and then the branch name (e.g. bugfix_new_damn_bug)

Beyond this, it is only expected that branches have sensible naming that describes what the branch involves or is for.

..

Deployment

Steps to deploy the node binaries in choice of your environment.

• Run the pipeline for branch of your choice with following variables.
• Set deploy_binaries to true to enforce infrastructure changes.
• Set zenotta_env with choice of your environment. e.g - dev-stg, dev-byron etc.
• Successful run of infra pipeline will present with you IP addresses of different nodes.
• IP address of node will still need to be configured in node_settings.toml and tls_certificates.json manually post rollout.

..

Documentation

Documentation can be built locally with rustdoc by running the following command:

cargo +nightly doc --document-private-items

The resulting documentation can be found in target/doc/system/index.html.

Nightly is required because one of dependencies (gmp-mpfr-sys) uses unstable features.