libzkchannels

(β˜… 71)

zkChannels: Anonymous Payment Channels for Bitcoin, Zcash, Tezos and more

  • .gitignore
  • .travis.yml
  • blog-header-light-14.png
  • build.rs
  • build.sh
  • build_docker_image.sh
  • Cargo.lock
  • Cargo.toml
  • cbindgen.toml
  • Dockerfile
  • env
  • libzkchannels-mpc-arch.png
  • libzkchannels.go
  • libzkchannels_test.go
  • LICENSE
  • Makefile
  • README.md
  • setup_redis.sh
  • test_channels_mpc.sh
  • test_database.sh
  • test_gowrapper.sh
  • test_ignored.sh
  • test_mpcwrapper.sh

# Installation Guide

1. Get the code
git clone https://github.com/boltlabs-inc/libzkchannels

Downloads the entire project code from GitHub to your computer.

cd libzkchannels

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t libzkchannels .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 libzkchannels

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r tx/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo clean

Type this command into your terminal and run it.

cargo build --release

Compiles the Rust project.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make deps

Compiles the code based on the generated build configuration to produce an executable.

make mpctest

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation