Zebra

https://github.com/zcashfoundation/zebra
Admin
Zebra is an independent, consensus-compatible Zcash full node implementation written in Rust,...
Tokens:691,294
Snippets:4,234
Trust Score:7.7
License:Apache-2.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Redis on Debian/Ubuntu

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Install and run Redis on Debian/Ubuntu. The commands add the Redis package repository, install Redis, and start the server on the default port.

```sh
sudo apt-get install lsb-release
curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list

sudo apt-get update
sudo apt-get install redis
redis-server
```

--------------------------------

### Quick start commands

Source: https://github.com/zcashfoundation/zebra/blob/main/docker/mining/README.md

Quick start commands: copy .env, start services, wait for sync, then start mining with either the built-in nheqminer container or an external miner.

```bash
# 1. Configure
cp .env.example .env
# Edit .env - set MINER_ADDRESS (required)

# 2. Start
docker compose up -d

# 3. Wait for Zebra to sync (hours)
docker compose logs -f zebra

# 4. Once synced, start mining (choose one):

# Option A: Built-in nheqminer container
docker compose --profile miner up -d nheqminer

# Option B: External miner
nheqminer -l <host>:3333 -u <address>.worker1 -t <threads>
```

--------------------------------

### Start Zebra node

Source: https://github.com/zcashfoundation/zebra/blob/main/README.md

Starts the Zebra node after installation. For detailed configuration and optional features, refer to the Building and Installing Zebra and Running Zebra sections in the book.

```sh
zebrad start
```

--------------------------------

### Run installer unattended with flags

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/zcashd-compat.md

Runs the installer unattended with flags matching every interactive prompt. This example uses the supervised mode, Mainnet network, and a custom zcashd datadir. Use --dry-run to preview actions without executing them.

```console
install-zebra.sh --install-profile zcashd-compat --mode supervised \
  --network Mainnet --zcashd-datadir /var/lib/zcashd --non-interactive
```

--------------------------------

### Run pre-configured observability stack

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/metrics.md

Alternative to manual setup: starts Zebra, Prometheus, Grafana, Jaeger, and AlertManager with a single Docker Compose command. Uses the pre-configured observability stack.

```bash
docker compose -f docker/docker-compose.observability.yml up
```

--------------------------------

### Install zecwallet-cli

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/lightwalletd.md

Installs the zecwallet-cli binary from the adityapk00 fork. The binary will be placed at ~/.cargo/bin/zecwallet-cli.

```console
cargo install --locked --git https://github.com/adityapk00/zecwallet-light-cli
```

--------------------------------

### Download and build lightwalletd

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/lightwalletd.md

Clone the lightwalletd repository and build it using make. Requires Go to be installed and in your PATH. After successful installation, the lightwalletd binary will be in ~/go/bin/.

```console
git clone https://github.com/zcash/lightwalletd
cd lightwalletd
make
make install
```

--------------------------------

### Start Zebra and Observability Stack

Source: https://github.com/zcashfoundation/zebra/blob/main/docker/observability/grafana/README.md

Starts Zebra and all observability tools from the repository root. Access Grafana at http://localhost:3000 with default credentials admin/admin.

```bash
docker compose -f docker/docker-compose.observability.yml up -d
```

--------------------------------

### Start Redis on Arch

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Start the Redis service on Arch Linux using systemctl.

```sh
sudo systemctl start redis
```

--------------------------------

### Start Observability Stack and View Logs

Source: https://github.com/zcashfoundation/zebra/blob/main/docker/observability/README.md

Commands to start the full observability stack and view Zebra logs. The first command starts all services in detached mode, and the second follows the logs for the Zebra container.

```bash
docker compose -f docker/docker-compose.observability.yml up -d
```

```bash
docker compose -f docker/docker-compose.observability.yml logs -f zebra
```

--------------------------------

### Install Redis, Boost, and libsodium on Arch

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Install Redis, Boost, and libsodium on Arch Linux using pacman.

```sh
sudo pacman -S redis boost libsodium
```

--------------------------------

### Start Zebra with --zcashd-compat

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/zcashd-compat-migration.md

Starts Zebra with the zcashd compatibility flag. zcashd loads the existing block index and wallet without rescan or key import. Supervised zcashd runs with -printtoconsole, so its output is streamed into Zebra's log under the zcashd_compat.zcashd target.

```bash
zebrad -c zebrad.toml start --zcashd-compat
```

--------------------------------

### Start s-nomp mining pool

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/fork-zebra-testnet.md

Starts the s-nomp mining pool software.

```bash
npm start
```

--------------------------------

### Start Zebra with custom config

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/fork-zebra-testnet.md

Starts Zebra with the modified config file `myconf.toml`. The sync will halt at the configured `debug_stop_at_height`.

```bash
zebrad -c myconf.toml start
```

--------------------------------

### Install zebra-checkpoints with cargo install

Source: https://github.com/zcashfoundation/zebra/blob/main/zebra-utils/README.md

Compiles and installs the standalone zebra-checkpoints binary from the Zebra repository. Requires a Rust toolchain and network access to GitHub.

```sh
cargo install --locked --features zebra-checkpoints --git https://github.com/ZcashFoundation/zebra zebra-utils
```

--------------------------------

### Build and run zebrad

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/install.md

Builds the zebrad binary in release mode and starts it.

```bash
cargo build --release --bin zebrad
target/release/zebrad start
```

--------------------------------

### Install Boost and libsodium on Debian/Ubuntu

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Install the Boost and libsodium development libraries required by s-nomp on Debian/Ubuntu.

```sh
sudo apt install libboost-all-dev
sudo apt install libsodium-dev
```

--------------------------------

### Install Node.js 10 with nodenv or nvm

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Install and activate Node.js 10 using either nodenv or nvm. These are alternative commands; choose one based on your node version manager.

```sh
nodenv install 10
nodenv local 10
```

```sh
nvm install 10
nvm use 10
```

--------------------------------

### Good crate release summary example

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/changelog-guidelines.md

Example of a good release summary for a crate changelog, naming specific types and changes, and focusing on required code changes.

```text
`FundingStreamReceiver` variants renamed for clarity: `Ecc` to `Bootstrap`,
`ZcashFoundation` to `Foundation`. The `subsidy` module constants are now
`pub(crate)`; use the provided accessor functions instead.

```

--------------------------------

### Run the interactive installer

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/zcashd-compat.md

Runs the interactive installer for Zebra with zcashd compatibility. At the first prompt, choose '2) With Zcashd compatibility', then select one of the zcashd-compat modes: split-binary (default), supervised, docker-split-containers, docker-supervised, or build-from-source.

```console
curl -fsSL https://raw.githubusercontent.com/ZcashFoundation/zebra/main/scripts/install-zebra.sh | bash
```

--------------------------------

### Install Zebra from GitHub tag

Source: https://github.com/zcashfoundation/zebra/blob/main/README.md

Installs Zebra directly from the GitHub repository at the specified tag (v6.0.0). Use this to test an unreleased or specific version.

```sh
cargo install --git https://github.com/ZcashFoundation/zebra --tag v6.0.0 zebrad
```

--------------------------------

### Install pre-built binary with cargo binstall

Source: https://github.com/zcashfoundation/zebra/blob/main/README.md

Downloads and installs a signed, pre-built binary of Zebra using `cargo binstall`. It avoids the build dependencies on x86_64 or aarch64 Linux with glibc 2.34+.

```sh
cargo binstall zebrad
```

--------------------------------

### Install RocksDB on Arch Linux

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/install.md

Installs RocksDB as a system library on Arch Linux for dynamic linking.

```bash
pacman -S rocksdb
```

--------------------------------

### Install RocksDB on Ubuntu

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/install.md

Installs the RocksDB development package on Ubuntu version >= 24.04 for dynamic linking.

```bash
apt install -y librocksdb-dev
```

--------------------------------

### Install cargo-fuzz and run a fuzz target

Source: https://github.com/zcashfoundation/zebra/blob/main/zebra-fuzz/README.md

These commands install the `cargo-fuzz` executable, build the fuzz targets using the nightly toolchain,and run a specified target. Expect the first run to be slow and to produce a large target directory; the command will run indefinitely unless you add `-- -rms= code>1,000</code> to exit after one pass.

```shell script; 
cargo +nightly fuzz build --fodyurllib3fuzz-dir zebra-fuzz/fuzz cargo +nightly 
```

```shell script; 
cadaver +nightly fuzz build --fuzz-dir zebra-fuzz/fuzz cargo +nightly 
```

```shell script; 
cadaver +nightly fuzz build --f  zebra-fuzz/fuzz cargo +nightly 
```

--------------------------------

### Run Zebra with custom config

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/metrics.md

Start Zebra using the -c flag to specify the path to the zebrad.toml configuration file.

```bash
zebrad -c zebrad.toml start
```

--------------------------------

### Run zcashd externally with Zebra (command line and zcash.conf)

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/zcashd-compat.md

Run zcashd externally with Zebra, using the command line or the equivalent zcash.conf settings. The command line example disables listening, DNS seeding, onion, and discovery, and connects to Zebra's port. The zcash.conf example provides the same connection and listen settings.

```console
zcashd -datadir=/var/lib/zcashd \
       -connect=127.0.0.1:8233 -listen=0 -dnsseed=0 -listenonion=0 -discover=0 \
       -printtoconsole
```

```text
connect=127.0.0.1:8233
listen=0
```

--------------------------------

### Bad crate release summary example

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/changelog-guidelines.md

Example of a bad release summary that is vague and does not name specific changes or required code modifications.

```text
This release improves code organization and internal structure.

```

--------------------------------

### Install Zebra from crates.io

Source: https://github.com/zcashfoundation/zebra/blob/main/README.md

Builds and installs the latest Zebra release from source, after the required dependencies are in place. This command does not accept GitHub tags or branches.

```sh
cargo install --locked zebrad
```

--------------------------------

### Start Zebra mining container on Testnet

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-docker.md

Starts a Zebra container on Testnet, binding P2P port 18233 and RPC port 18232. Requires setting ZEBRA_NETWORK__NETWORK to Testnet and using a Testnet address (prefix t2) for rewards. Using a Mainnet address on Testnet or vice versa prevents Zebra from starting.

```bash
docker run -d --name zebra_local \
  -e ZEBRA_NETWORK__NETWORK="Testnet" \
  -e ZEBRA_MINING__MINER_ADDRESS="t27eWDgjFYJGVXmzrXeVjnb5J3uXDM9xH9v" \
  -e ZEBRA_RPC__LISTEN_ADDR=0.0.0.0:18232 \
  -p 18233:18233 \
  -p 18232:18232 \
  -v zebrad-cache:/home/zebra/.cache/zebra \
  zfnd/zebra:latest
```

--------------------------------

### GET /ready

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/health.md

Readiness check endpoint for Kubernetes probes and load balancers. Returns 200 OK when the node is synced and near the tip, otherwise 503.

```APIDOC
## GET /ready

### Description
Readiness check endpoint that returns 200 OK when the node is near the network tip, the estimated block lag is within the configured threshold (default: 2 blocks), and the tip is recent enough (default: 5 minutes). Returns 503 Service Unavailable if still syncing, lag exceeds threshold, tip is too old, or insufficient peers.

### Method
GET

### Endpoint
/ready

### Response
#### Success Response (200)
- Node is near the network tip, block lag within threshold, tip recent enough.

#### Error Response (503)
- Still syncing, lag exceeds threshold, tip too old, or insufficient peers.

```

--------------------------------

### Start lightwalletd sync with Zebra

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/lightwalletd.md

Starts lightwalletd synchronization with Zebra. Requires zebrad running with RPC endpoint and up-to-date blockchain. Uses default Zebra RPC endpoint (127.0.0.1:8232) and an empty zcash.conf. For non-default port, use rpcport=28232 and rpcbind=127.0.0.1; for testnet, use testnet=1. For production, a cert.pem is required; otherwise use --no-tls-very-insecure flag.

```console
lightwalletd --zcash-conf-path ~/.config/zcash.conf --data-dir ~/.cache/lightwalletd --log-file /dev/stdout
```

--------------------------------

### Run tokio-console

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/tokio-console.md

Starts the tokio-console diagnostics tool. With default options, it connects to a running zebrad instance without additional configuration.

```bash
tokio-console
```

--------------------------------

### Run Kibana

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/elasticsearch.md

Starts the Kibana server. The first run provides a URL with a code for configuration, and Kibana listens on https://localhost:5601 by default.

```sh
./bin/kibana
```

--------------------------------

### How to Upgrade section template

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/changelog-guidelines.md

Template for the How to Upgrade section, providing platform-specific instructions for binary/package and Docker installations. Includes commands to stop/start zebrad and Docker pull/update commands.

```text
## How to Upgrade

### Binary/Package

1. Stop zebrad: `systemctl stop zebrad` or `Ctrl+C`
2. Wait for clean shutdown (check logs for "shutdown complete")
3. Replace binary or update via package manager
4. Start zebrad: `systemctl start zebrad`

### Docker

```bash
docker pull zfnd/zebra:X.Y.Z
# or update your compose file and:
docker compose pull && docker compose up -d
```
```

--------------------------------

### Run Zebra

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/elasticsearch.md

Starts Zebra with the default configuration path, beginning the blockchain sync. The sync takes time, and Kibana can be used to monitor block insertion.

```sh
zebrad
```

--------------------------------

### Zebra sync progress output

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/lightwalletd.md

Example output showing the estimated progress to chain tip during synchronization.

```console
...
zebrad::commands::start: estimated progress to chain tip sync_percent=10.783 %
...
```

--------------------------------

### Zebra sync completion output

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/lightwalletd.md

Example output indicating that the initial sync to chain tip has finished.

```console
...
zebrad::commands::start: finished initial sync to chain tip, using gossiped blocks sync_percent=100.000 %
...
```

--------------------------------

### zcash-rpc-diff: Compare zebrad and zcashd RPC responses

Source: https://github.com/zcashfoundation/zebra/blob/main/zebra-utils/README.md

Compares `zebrad` and `zcashd` RPC responses. Requires zcashd and zebrad installed and synced. The script gets tip height and network, sends RPC requests via `zcash-cli`, compares responses using `diff`, and leaves full responses in a temporary directory. It warns if heights or networks differ, accepts any RPC with any number of arguments, and exits with an error if a node doesn't implement an RPC. The script uses the configured `zcash-cli` RPC port and the `zebrad` port supplied on the command-line. It doesn't check node type, so you can compare two `zcashd` or `zebrad` nodes. Override binaries with `$ZCASH_CLI`, `$DIFF`, and `$JQ`.

```sh
$ zebra-utils/zcash-rpc-diff 28232 getinfo
Checking zebrad network and tip height...
Checking zcashd network and tip height...

Request:
getinfo

Querying zebrad main chain at height 1649797...
Querying zcashd main chain at height 1649797...

Response diff (between zcashd port and port 28232):
--- /run/user/1000/tmp.g9CJecu2Wo/zebrad-main-1649797-getinfo.json      2022-04-29 14:08:46.766240355 +1000
+++ /run/user/1000/tmp.g9CJecu2Wo/zcashd-main-1649797-getinfo.json      2022-04-29 14:08:46.769240315 +1000
@@ -1,4 +1,16 @@
 {
-  "build": "1.0.0-beta.8+54.ge83e93a",
-  "subversion": "/Zebra:1.0.0-beta.8/"
+  "version": 4070050,
+  "build": "v4.7.0-gitian",
+  "subversion": "/MagicBean:4.7.0/",
... more extra zcashd fields ...
 }
```

--------------------------------

### Start Zebra mining container on Mainnet

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-docker.md

Starts a Zebra container on Mainnet, binding P2P port 8233 and RPC port 8232. Requires setting the ZEBRA_MINING__MINER_ADDRESS environment variable to a Mainnet P2SH address (prefix t3) for mining rewards. The container must sync before generating blocks.

```bash
docker run -d --name zebra_local \
  -e ZEBRA_MINING__MINER_ADDRESS="t3dvVE3SQEi7kqNzwrfNePxZ1d4hUyztBA1" \
  -e ZEBRA_RPC__LISTEN_ADDR=0.0.0.0:8232 \
  -p 8233:8233 \
  -p 8232:8232 \
  -v zebrad-cache:/home/zebra/.cache/zebra \
  zfnd/zebra:latest
```

--------------------------------

### rustdoc link examples

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/mass-renames.md

Shows the syntax for rustdoc links in doc comments. Using these links helps the rustdoc lint detect typos or name changes in documentation.

```rust
//! This is what `rustdoc` links look like:
//! - [`u32`] type or trait
//! - [`drop()`] function
//! - [`Clone::clone()`] method
//! - [`Option::None`] enum variant
//! - [`Option::Some(_)`](Option::Some) enum variant with data
//! - [`HashMap`](std::collections::HashMap) fully-qualified path
//! - [`BTreeSet<String>`](std::collections::BTreeSet) fully-qualified path with generics

```

--------------------------------

### getblocktemplate RPC output

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining.md

Example output from the getblocktemplate RPC call. If you see a similar response, your Zebra setup is working correctly.

```console
{
  "result": {
    "capabilities": [
      "proposal"
    ],
    "version": 4,
    "previousblockhash": "000000000173ae4123b7cb0fbed51aad913a736b846eaa9f23c3bb7f6c65b011",
    "blockcommitmentshash": "84ac267e51ce10e6e4685955e3a3b08d96a7f862d74b2d60f141c8e91f1af3a7",
    "lightclientroothash": "84ac267e51ce10e6e4685955e3a3b08d96a7f862d74b2d60f141c8e91f1af3a7",
    "finalsaplingroothash": "84ac267e51ce10e6e4685955e3a3b08d96a7f862d74b2d60f141c8e91f1af3a7",
    "defaultroots": {
      "merkleroot": "5e312942e7f024166f3cb9b52627c07872b6bfa95754ccc96c96ca59b2938d11",
      "chainhistoryroot": "97be47b0836d629f094409f5b979e011cbdb51d4a7e6f1450acc08373fe0901a",
      "authdataroot": "dc40ac2b3a4ae92e4aa0d42abeea6934ef91e6ab488772c0466d7051180a4e83",
      "blockcommitmentshash": "84ac267e51ce10e6e4685955e3a3b08d96a7f862d74b2d60f141c8e91f1af3a7"
    },
    "transactions": [
      {
        "data": "0400008085202f890120a8b2e646b5c5ee230a095a3a19ffea3c2aa389306b1ee3c31e9abd4ac92e08010000006b483045022100fb64eac188cb0b16534e0bd75eae7b74ed2bdde20102416f2e2c18638ec776dd02204772076abbc4f9baf19bd76e3cdf953a1218e98764f41ebc37b4994886881b160121022c3365fba47d7db8422d8b4a410cd860788152453f8ab75c9e90935a7a693535ffffffff015ca00602000000001976a914411d4bb3c17e67b5d48f1f6b7d55ee3883417f5288ac000000009d651e000000000000000000000000",
        "hash": "63c939ad16ef61a1d382a2149d826e3a9fe9a7dbb8274bfab109b8e70f469012",
        "authdigest": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
        "depends": [],
        "fee": 11300,
        "sigops": 1,
        "required": false
      },
      {
        "data": "0400008085202f890192e3403f2fb04614a7faaf66b5f59a78101fe3f721aee3291dea3afcc5a4080d000000006b483045022100b39702506ff89302dcde977e3b817c8bb674c4c408df5cd14b0cc3199c832be802205cbbfab3a14e80c9765af69d21cd2406cea4e8e55af1ff5b64ec00a6df1f5e6b01210207d2b6f6b3b500d567d5cf11bc307fbcb6d342869ec1736a8a3a0f6ed17f75f4ffffffff0147c717a8040000001976a9149f68dd83709ae1bc8bc91d7068f1d4d6418470b688ac00000000000000000000000000000000000000",
        "hash": "d5c6e9eb4c378c8304f045a43c8a07c1ac377ab6b4d7206e338eda38c0f196ba",
        "authdigest": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
        "depends": [],
        "fee": 185,
        "sigops": 1,
        "required": false
      }
    ]
  }
}
```

--------------------------------

### Run zecwallet-cli with --server

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/lightwalletd.md

Runs zecwallet-cli with the --server flag pointing to a local lightwalletd instance. The output shows a successful connection and the interactive prompt.

```console
$ zecwallet-cli --server 127.0.0.1:9067
Lightclient connecting to http://127.0.0.1:9067/
{
  "result": "success",
  "latest_block": 1683911,
  "total_blocks_synced": 49476
}
Ready!
(main) Block:1683911 (type 'help') >>
```

--------------------------------

### Install Node.js 10 with nvm on Arch

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Install and use Node.js 10 with nvm on Arch Linux. The commands unset npm_config_prefix and source the nvm init script before installing.

```sh
unset npm_config_prefix
source /usr/share/nvm/init-nvm.sh
nvm install 10
nvm use 10
```

--------------------------------

### Update and install s-nomp on Arch

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Update dependencies and install s-nomp on Arch Linux.

```sh
npm update
npm install
```

--------------------------------

### Prepare and run a fuzz target with its seed archive using git clone, mkdir, and cargo fuzz run --fission-durrectory zebra-fuzz/fuzz <target> — zebra-fuzz README Seed corpusHow to clone the seed repository to /tmp/zera-fuzz-corpora, create the target's directory under zebra-fuzz/fuse/corpus/<target> — and then extract the appropriate seed archive there before running the target with cargo +nightly git clone https://git clone --depth  

Source: https://github.com/zcashfoundation/zebra/blob/main/zebra-fuzz/README.md

Use this shell script when you need to run a fusting target with its prebuilt seed corpus from the external repository named in the text: it clones the whole `zebra-fuzz-cornucopia` repo once (–depth uses a shallow clone to save time), ensures the target's directory exists, extracts the corresponding `<target> —seed_cruise.zip archive into that directory, and then executes the target with cargo +nightly git clone https://git clone --depth  

```sh
git clone --depth 1 https:// ther.this is a placeholder, actual code follows:
```sh
```sh
```sh
```sh
```sh
```sh
```sh
```sh
```sh
```sh
```sh
```sh

```

--------------------------------

### Install Zebra with Prometheus feature

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/metrics.md

Install a Zebra binary with the prometheus feature enabled using cargo install. This is only needed if building from source with a custom feature set, as prebuilt binaries already include it.

```bash
cargo install --features prometheus --locked --git https://github.com/ZcashFoundation/zebra zebrad
```

--------------------------------

### Implement IntoDisk and FromDisk for ValueBalance and Amount

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/rfcs/0012-value-pools.md

Implements IntoDisk and FromDisk for ValueBalance<C> and Amount to enable serialization into the disk database. Requires a new Amount::from_bytes method.

```rust
impl IntoDisk for ValueBalance<C> {
    type Bytes = [u8; 32];

    fn as_bytes(&self) -> Self::Bytes {
        [self.transparent.to_bytes(), self.sprout.to_bytes(),
        self.sapling.to_bytes(), self.orchard.to_bytes()].concat()
    }
}

impl FromDisk for ValueBalance<C> {
    fn from_bytes(bytes: impl AsRef<[u8]>) -> Self {
        let array = bytes.as_ref().try_into().unwrap();
        ValueBalance {
            transparent: Amount::from_bytes(array[0..8]).try_into().unwrap()
            sprout: Amount::from_bytes(array[8..16]).try_into().unwrap()
            sapling: Amount::from_bytes(array[16..24]).try_into().unwrap()
            orchard: Amount::from_bytes(array[24..32]).try_into().unwrap()
        }
    }
}

impl IntoDisk for Amount {
    type Bytes = [u8; 8];

    fn as_bytes(&self) -> Self::Bytes {
        self.to_bytes()
    }
}

impl FromDisk for Amount {
    fn from_bytes(bytes: impl AsRef<[u8]>) -> Self {
        let array = bytes.as_ref().try_into().unwrap();
        Amount::from_bytes(array)
    }
}
```

--------------------------------

### Install nvm, Python 3.10, and virtualenv on Arch

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Install nvm, Python 3.10, and virtualenv on Arch Linux. The first command uses paru to install python310 and nvm, and the second uses pacman for python-virtualenv.

```sh
paru -S python310 nvm
sudo pacman -S python-virtualenv
```

--------------------------------

### Install nheqminer dependencies on Arch

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Install dependencies for building nheqminer on Arch Linux. Requires sudo privileges.

```sh
sudo pacman -S cmake boost icu
```

--------------------------------

### Install Zebra with elasticsearch feature

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/elasticsearch.md

Builds and installs Zebra with the experimental elasticsearch feature enabled. The binary is placed at ~/.cargo/bin/zebrad.

```sh
cargo install --features elasticsearch --locked --git https://github.com/ZcashFoundation/zebra zebrad
```

--------------------------------

### Using the zebra-state service

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/rfcs/0005-state-updates.md

Shows how to initialize the state service and send a BlockLocator request using the tower::Service API. Requires calling ready_and().await before call().

```rust
use tower::{Service, ServiceExt};

let state = zebra_state::on_disk::init(state_config, network);
let request = zebra_state::Request::BlockLocator;
let response = state.ready_and().await?.call(request).await?;

assert!(matches!(response, zebra_state::Response::BlockLocator(_)));
```

--------------------------------

### Start nheqminer miner

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/fork-zebra-testnet.md

Starts the nheqminer CPU miner, connecting to the local s-nomp pool at 127.0.0.1:1234 with the specified worker address and one thread.

```bash
nheqminer -l 127.0.0.1:1234 -u tmRGc4CD1UyUdbSJmTUzcB6oDqk4qUaHnnh.worker1 -t 1
```

--------------------------------

### Build, test, and development commands

Source: https://github.com/zcashfoundation/zebra/blob/main/AGENTS.md

Commands that must pass before submitting a PR. The first is optional; the next three (fmt, clippy, test) are required. The remaining commands are for running specific crates, a single test by name, and a CI-like nextest profile.

```bash
# Optional full build check
cargo build --workspace --locked
```

```bash
# All three must pass before any PR
cargo fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace
```

```bash
# Run a single crate's tests
cargo test -p zebra-chain
cargo test -p zebra-state
```

```bash
# Run a single test by name
cargo test -p zebra-chain -- test_name
```

```bash
# CI-like nextest profile (unit + integration, excludes stateful and E2E)
cargo nextest run --profile ci --locked --release --features default-release-binaries --run-ignored=all
```

```bash
# Zebrad test category and GCP profile examples are maintained in zebrad/tests/main.rs.
```

--------------------------------

### Update and install s-nomp dependencies

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Update dependencies and install s-nomp. The CXXFLAGS environment variable is set to enable C++17 support before running npm commands.

```sh
export CXXFLAGS="-std=gnu++17"
npm update
npm install
```

--------------------------------

### Run Zebra with zebrad -c zebrad.toml

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/mining-testnet-s-nomp.md

Command to run Zebra with the created configuration file. Use after configuring zebrad.toml and before waiting for the node to sync to the testnet tip.

```sh
zebrad -c zebrad.toml
```

--------------------------------

### Build from source commands

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/changelog-guidelines.md

Commands to build Zebra from source, fetching the release tag and building with cargo in release mode.

```bash
git fetch && git checkout vX.Y.Z
cargo build --release
```

--------------------------------

### Jaeger Trace Waterfall Example

Source: https://github.com/zcashfoundation/zebra/blob/main/docker/observability/jaeger/README.md

Example of a Jaeger trace waterfall showing a getblock RPC request with nested spans for state::read_block and db::get, including span durations and attributes.

```text
┌─────────────────────────────────────────────────────────────────────┐
│ Trace: abc123 (5 spans, 234ms)                                      │
├─────────────────────────────────────────────────────────────────────┤
│                                                                     │
│ ├─ rpc_request [SERVER] ─────────────────────────────── 234ms ────┤│
│ │  rpc.method: getblock                                            ││
│ │  rpc.system: jsonrpc                                             ││
│ │                                                                  ││
│ │  ├─ state::read_block ─────────────────────── 180ms ───────────┤││
│ │  │  block.height: 2000000                                       │││
│ │  │                                                              │││
│ │  │  ├─ db::get ───────────────────── 150ms ──────────────────┤│││
│ │  │  │  cf: blocks                                             ││││
│ │  │  └─────────────────────────────────────────────────────────┘│││
│ │  └─────────────────────────────────────────────────────────────┘││
│ └─────────────────────────────────────────────────────────────────┘│
└─────────────────────────────────────────────────────────────────────┘
```

--------------------------------

### zebrad-hash-lookup: Get block info from hash

Source: https://github.com/zcashfoundation/zebra/blob/main/zebra-utils/README.md

Given a block hash, the script gets additional information using `zcash-cli`. Commonly used as part of `zebrad-log-filter` where hashes are captured from `zebrad` output.

```sh
$ echo "00000001f53a5e284393dfecf2a2405f62c07e2503047a28e2d1b6e76b25f863" | zebrad-hash-lookup
high: 3299
time: 2016-11-02T13:24:26Z
hash: 00000001f53a5e284393dfecf2a2405f62c07e2503047a28e2d1b6e76b25f863
prev: 00000001dbbb8b26eb92003086c5bd854e16d9f16e2e5b4fcc007b6b0ae57be3
next: 00000001ff3ac2b4ccb57d9fd2d1187475156489ae22337ca866bbafe62991a2
$
```

--------------------------------

### Run synced Zebra instance for benchmarking

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/dev/profiling-and-benchmarking.md

Runs a synced Zebra instance for benchmarking, using the provided TOML config. The config allows quick reconnections from localhost and disables ephemeral state.

```bash
cargo run --release -- --config /path/to/zebrad-synced.toml
```

```toml
# Config for a synced Zebra instance in a network-suppressed setup.

[network]
cache_dir = true
max_connections_per_ip = 1000
network = "Mainnet"

[state]
# cache_dir = "/path/to/.cache/zebra-synced"
delete_old_database = true
ephemeral = false

[sync]
checkpoint_verify_concurrency_limit = 1000
parallel_cpu_threads = 0
```

--------------------------------

### Install dependencies on Arch Linux

Source: https://github.com/zcashfoundation/zebra/blob/main/README.md

Installs the required build dependencies on Arch Linux: Rust, clang (which includes libclang), and protobuf. If a compiling failure in `rocksdb` occurs, see the GCC 15 workaround.

```sh
sudo pacman -S rust clang protobuf
```

--------------------------------

### Install Zebra with custom Cargo features

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/run.md

Installs Zebra with custom Cargo features. Combine multiple features by listing them as parameters of the --features flag. Some debugging and monitoring features are disabled in release builds.

```sh
cargo install --features="<feature1> <feature2> ..." ...
```

--------------------------------

### Update checkpoints with zebra-checkpoints

Source: https://github.com/zcashfoundation/zebra/blob/main/zebra-utils/README.md

Updates the mainnet and testnet checkpoint lists by appending new checkpoints starting from the last checkpoint in each file. Uses --last-checkpoint to avoid starting from genesis and runs both commands in parallel with wait.

```sh
zebra-checkpoints --last-checkpoint $(tail -1 zebra-chain/src/parameters/checkpoint/main-checkpoints.txt | cut -d" " -f1) | tee --append zebra-chain/src/parameters/checkpoint/main-checkpoints.txt &
zebra-checkpoints --last-checkpoint $(tail -1 zebra-chain/src/parameters/checkpoint/test-checkpoints.txt | cut -d" " -f1) -- -testnet | tee --append zebra-chain/src/parameters/checkpoint/test-checkpoints.txt &
wait
```

--------------------------------

### Debugging Slow RPC Example

Source: https://github.com/zcashfoundation/zebra/blob/main/docker/observability/jaeger/README.md

Step-by-step debugging workflow for slow getblock RPC calls using Jaeger, including search filters and waterfall analysis to identify the database as the bottleneck.

```text
Problem: getblock calls are slow

1. Search:
   - Service: zebra
   - Operation: rpc_request
   - Tags: rpc.method=getblock
   - Min Duration: 500ms

2. Open a slow trace

3. Examine waterfall:
   - rpc_request: 800ms total
     └─ state::read_block: 750ms  ← Most time spent here
        └─ db::get: 700ms         ← Database is the bottleneck

4. Conclusion: Database read is slow, possibly due to:
   - Disk I/O
   - Large block size
   - Missing cache
```

--------------------------------

### expect() Message Examples

Source: https://github.com/zcashfoundation/zebra/blob/main/AGENTS.md

Examples of good and bad expect() messages. Good messages explain why the invariant holds, not what happens if it fails. Use thiserror with #[from] / #[source] for error chaining and avoid turning invariant violations into misleading None/default values.

```rust
.expect("block hash exists because we just inserted it")  // good
.expect("failed to get block")                            // bad
```

--------------------------------

### Kubernetes probes for /healthy and /ready

Source: https://github.com/zcashfoundation/zebra/blob/main/book/src/user/health.md

Example Kubernetes Deployment probes for the health endpoints. The liveness probe checks /healthy every 10 seconds after a 10-second delay; the readiness probe checks /ready every 5 seconds after the same delay.

```yaml
livenessProbe:
  httpGet:
    path: /healthy
    port: 8080
  initialDelaySeconds: 10
  periodSeconds: 10
readinessProbe:
  httpGet:
    path: /ready
    port: 8080
  initialDelaySeconds: 10
  periodSeconds: 5
```
Tokens:
Raw