Zkool Documentation
  • Guides

    • Getting Started
    • Account Manager
    • Synchronization
    • Account
    • Addresses
    • Payments
    • Other features
    • Building Zkool from source
  • Recipes

    • Edit an Account
    • Supported Key Types
    • Cold Wallet
    • Ledger
    • Troubleshooting Synchronization Issues
    • Folders
    • Database/Wallet Files
    • Using TOR
    • Security
    • Kiosk Zkool
    • Mempool
    • Payment URI
    • Locking Notes
    • Mainnet, Testnet, Regtest
    • Export to CSV
  • Categories / Reports

    • Overview
    • Examples
    • Categories
    • ZEC Price
    • Charts
  • MultiSig Accounts / FROST

    • Overview
    • Key Generation
    • Signing a Transaction
  • GraphQL

    • GraphQL API
    • Build
    • GraphIQL
    • Account Management
    • Synchronization
    • Balance
    • Transaction History
    • Receiving Funds
    • Sending Funds
    • Unconfirmed Funds
    • Notifications / Subscriptions
  • Zcash tech

    • Shielded Pools
    • Bitcoin Data Model
    • Transaction Graph
    • Privacy

zkool_graphql is only release from source. As a 100% Rust app, it is easy to build for many architectures and therefore, we don't provide pre-built binaries.

Clone from github

git clone https://github.com/hhanh00/zkool2

Build

Requirement: Install Rust

Then build with cargo.

cd rust
cargo b -r --features=graphql --bin zkool_graphql

This creates the executable zkool_graphql in the target/release directory.

Configuration

The config file needs to specify the path to the database file (which will be automatically created), the URL to the LightwalletD server and the listening port.

db_path = "zkool.db"
lwd_url = "https://zec.rocks"
port = 8000

Alternatively, you can specify another config file or set the values on the command line.

Usage: zkool_graphql [OPTIONS]

Options:
  -c, --config-path <CONFIG_PATH>
  -d, --db-path <DB_PATH>
  -l, --lwd-url <LWD_URL>
  -p, --port <PORT>
  -h, --help                       Print help

Using Testnet or Regtest

To use the testnet, name the database with testnet in it. For regtest, name the database with regtest in it.

Important

You must also use a lightwalletd that connects to the proper network.

Last Updated: 1/7/26, 4:58 PM
Contributors: Hanh
Prev
GraphQL API
Next
GraphIQL