Skip to content

Latest commit

 

History

History
105 lines (77 loc) · 3.49 KB

README.md

File metadata and controls

105 lines (77 loc) · 3.49 KB
Raw

ℤ - Bazuka!

Bazuka codecov

Bazuka is a wallet and node software for the Zeeka (ℤ) Protocol. Zeeka is a novel layer-1 cryptocurrency which uses Zero-Knowledge proofs as the backend of its smart-contract (I.e Zero Contracts).

Bazuka ensures the availability of latest contract-states, so that they remain public and everybody is able to update and build on them, making Zeeka a more decentralized protocol compared to similar projects.

Links

How to run a Bazuka node?

If you only want to run a Zeeka node and do not want to execute Zero Contract or mine Zeeka, you will only need to install bazuka (This repo). In case you also want to mine Zeeka, you will need to install zoro (The Main Payment Network executor) and also the uzi-miner (A RandomX CPU miner).

How to install bazuka?

  • Prepare a Linux machine.
  • Make sure you have installed libssl-dev and cmake packages. 
    sudo apt install -y build-essential libssl-dev cmake
  • Install the Rust toolchain (https://rustup.rs/) 
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • Clone the bazuka repo: 
    git clone https://github.com/zeeka-network/bazuka
  • Warning: Make sure Rust binaries are present in your PATH before compiling: 
    source "$HOME/.cargo/env"
  • Compile and install: 
    cd bazuka
cargo install --path .

Now if you want to join the chaos testnet, you first have to initialize your node. If you have already initialized bazuka for the Debug Testnet, you first need to remove your previous initialization by running:

rm ~/.bazuka.yaml

Then initialize:

bazuka init --network chaos

This will generate a 12-word mnemonic word list for you. Keep it somewhere safe! If you already have a 12-word mnemonic phrase, you can pass it through --mnemonic flag and restore your wallet.

You can use the nodes introduced by the community as your --bootstrap nodes.

Run your node:

bazuka node --listen 0.0.0.0:8765 --external [your external ip]:8765 \
  --network chaos --db ~/.bazuka-chaos

You either have to run your node on a machine with a static IP, or configure a NAT Virtual Server in order to expose your node on a public IP. Specify your public IP through the --external option.

Highly recommended to also provide your Discord handle through the --discord-handle flag. By providing your handle, you will leave our bots a way to contact you regarding the problems you may have in your node and its status.

Useful commands:

bazuka deposit Deposit funds to a Zero-Contract

bazuka help Prints this message or the help of the given subcommand(s)

bazuka init Initialize node/wallet

bazuka node Run node

bazuka rsend Send funds through a regular-transaction

bazuka status Get status of a node

bazuka withdraw Withdraw funds from a Zero-Contract

bazuka zsend Send funds through a zero-transaction