{"id":13511307,"url":"https://github.com/ZcashFoundation/zebra","last_synced_at":"2025-03-30T20:32:59.181Z","repository":{"id":37253347,"uuid":"205255683","full_name":"ZcashFoundation/zebra","owner":"ZcashFoundation","description":"Zcash - Financial Privacy in Rust 🦓","archived":false,"fork":false,"pushed_at":"2024-04-12T22:15:58.000Z","size":28324,"stargazers_count":391,"open_issues_count":161,"forks_count":88,"subscribers_count":21,"default_branch":"main","last_synced_at":"2024-04-14T06:47:10.483Z","etag":null,"topics":["rust","zcash","zcash-node","zebra"],"latest_commit_sha":null,"homepage":"https://zfnd.org/zebra/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ZcashFoundation.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-08-29T21:48:14.000Z","updated_at":"2024-04-15T07:59:50.752Z","dependencies_parsed_at":"2023-12-20T14:28:17.833Z","dependency_job_id":"60b643e4-5355-4091-afef-22f39fd69486","html_url":"https://github.com/ZcashFoundation/zebra","commit_stats":{"total_commits":4482,"total_committers":33,"mean_commits":135.8181818181818,"dds":0.6979027219991075,"last_synced_commit":"fb3fec0b9323af47ae6324907a76407b853ff007"},"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZcashFoundation%2Fzebra","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZcashFoundation%2Fzebra/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZcashFoundation%2Fzebra/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZcashFoundation%2Fzebra/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ZcashFoundation","download_url":"https://codeload.github.com/ZcashFoundation/zebra/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222266555,"owners_count":16958432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rust","zcash","zcash-node","zebra"],"created_at":"2024-08-01T03:00:46.940Z","updated_at":"2025-03-30T20:32:59.174Z","avatar_url":"https://github.com/ZcashFoundation.png","language":"Rust","funding_links":[],"categories":["Blockchains","Rust","\u003ca name=\"Rust\"\u003e\u003c/a\u003eRust"],"sub_categories":[],"readme":"![Zebra logotype](https://zfnd.org/wp-content/uploads/2022/03/zebra-logotype.png)\n\n---\n\n[![Integration Tests](https://github.com/ZcashFoundation/zebra/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/ZcashFoundation/zebra/actions/workflows/ci-tests.yml)\n[![CI OSes](https://github.com/ZcashFoundation/zebra/actions/workflows/ci-unit-tests-os.yml/badge.svg)](https://github.com/ZcashFoundation/zebra/actions/workflows/ci-unit-tests-os.yml)\n[![Continuous Delivery](https://github.com/ZcashFoundation/zebra/actions/workflows/cd-deploy-nodes-gcp.yml/badge.svg)](https://github.com/ZcashFoundation/zebra/actions/workflows/cd-deploy-nodes-gcp.yml)\n[![codecov](https://codecov.io/gh/ZcashFoundation/zebra/branch/main/graph/badge.svg)](https://codecov.io/gh/ZcashFoundation/zebra)\n[![Build docs](https://github.com/ZcashFoundation/zebra/actions/workflows/docs-deploy-firebase.yml/badge.svg)](https://github.com/ZcashFoundation/zebra/actions/workflows/docs-deploy-firebase.yml)\n![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)\n\n- [About](#about)\n- [Getting Started](#getting-started)\n  - [Docker](#docker)\n  - [Manual Build](#manual-build)\n    - [General instructions for installing dependencies](#general-instructions-for-installing-dependencies)\n    - [Dependencies on Arch](#dependencies-on-arch)\n- [CI/CD Architecture](#cicd-architecture)\n- [Documentation](#documentation)\n- [User support](#user-support)\n- [Security](#security)\n- [License](#license)\n\n## About\n\n[Zebra](https://zebra.zfnd.org/) is a Zcash full-node written in Rust.\n\nZebra implements all the features required to reach Zcash network consensus, and\nthe network stack is interoperable with `zcashd`.\n[Here](https://docs.rs/zebrad/latest/zebrad/index.html#zebra-advantages) are\nsome benefits of Zebra.\n\nZebra validates blocks and transactions, but needs extra software to generate\nthem:\n\n- To generate transactions, [run Zebra with `lightwalletd`](https://zebra.zfnd.org/user/lightwalletd.html).\n- To generate blocks, use a mining pool or miner with Zebra's mining JSON-RPCs.\n  Currently Zebra can only send mining rewards to a single fixed address.\n  To distribute rewards, use mining software that creates its own distribution transactions,\n  a light wallet or the `zcashd` wallet.\n\nPlease [join us on Discord](https://discord.gg/na6QZNd) if you'd like to find\nout more or get involved!\n\n## Getting Started\n\nYou can run Zebra using our Docker image or you can build it manually. Please\nsee the [System Requirements](https://zebra.zfnd.org/user/requirements.html)\nsection in the Zebra book for system requirements.\n\n### Docker\n\nThis command will run our latest release, and sync it to the tip:\n\n```sh\ndocker run zfnd/zebra:latest\n```\n\nFor more information, read our [Docker documentation](https://zebra.zfnd.org/user/docker.html).\n\n### Manual Build\n\nBuilding Zebra requires [Rust](https://www.rust-lang.org/tools/install),\n[libclang](https://clang.llvm.org/doxygen/group__CINDEX.html), and a C++\ncompiler.\n\nZebra is tested with the latest `stable` Rust version. Earlier versions are not\nsupported or tested. Any Zebra release can start depending on new features in the\nlatest stable Rust.\n\nAround every 6 weeks, we release a [new Zebra version](https://github.com/ZcashFoundation/zebra/releases).\n\nBelow are quick summaries for installing the dependencies on your machine.\n\n[//]: # \"The empty line in the `summary` tag below is required for correct Markdown rendering.\"\n\u003cdetails\u003e\u003csummary\u003e\n\n#### General instructions for installing dependencies\n\n\u003c/summary\u003e\n\n1. Install [`cargo` and `rustc`](https://www.rust-lang.org/tools/install).\n\n2. Install Zebra's build dependencies:\n\n   - **libclang** is a library that might have different names depending on your\n     package manager. Typical names are `libclang`, `libclang-dev`, `llvm`, or\n     `llvm-dev`.\n   - **clang** or another C++ compiler: `g++` (all platforms) or `Xcode` (macOS).\n   - **[`protoc`](https://grpc.io/docs/protoc-installation/)**\n\n\u003e [!NOTE]\n\u003e Zebra uses the `--experimental_allow_proto3_optional` flag with `protoc`\n\u003e during compilation. This flag was introduced in [Protocol Buffers\n\u003e v3.12.0](https://github.com/protocolbuffers/protobuf/releases/tag/v3.12.0)\n\u003e released in May 16, 2020, so make sure you're not using a version of `protoc`\n\u003e older than 3.12.\n\n\u003c/details\u003e\n\n[//]: # \"The empty line in the `summary` tag below is required for correct Markdown rendering.\"\n\u003cdetails\u003e\u003csummary\u003e\n\n#### Dependencies on Arch\n\n\u003c/summary\u003e\n\n```sh\nsudo pacman -S rust clang protobuf\n```\n\nNote that the package `clang` includes `libclang` as well as the C++ compiler.\n\n\u003c/details\u003e\n\nOnce the dependencies are in place, you can build and install Zebra:\n\n```sh\ncargo install --locked zebrad\n```\n\nYou can start Zebra by\n\n```sh\nzebrad start\n```\n\nRefer to the [Installing Zebra](https://zebra.zfnd.org/user/install.html) and\n[Running Zebra](https://zebra.zfnd.org/user/run.html) sections in the book for\nenabling optional features, detailed configuration and further details.\n\n## CI/CD Architecture\n\nZebra uses a comprehensive CI/CD system built on GitHub Actions to ensure code quality, maintain stability, and automate routine tasks. Our CI/CD infrastructure:\n\n- Runs automated tests on every PR and commit\n- Manages deployments to various environments\n- Handles cross-platform compatibility checks\n- Automates release processes\n\nFor a detailed understanding of our CI/CD system, including workflow diagrams, infrastructure details, and best practices, see our [CI/CD Architecture Documentation](.github/workflows/README.md).\n\n## Documentation\n\nThe Zcash Foundation maintains the following resources documenting Zebra:\n\n- The Zebra Book:\n  - [General Introduction](https://zebra.zfnd.org/index.html),\n  - [User Documentation](https://zebra.zfnd.org/user.html),\n  - [Developer Documentation](https://zebra.zfnd.org/dev.html).\n\n- The [documentation of the public\n  APIs](https://docs.rs/zebrad/latest/zebrad/#zebra-crates) for the latest\n  releases of the individual Zebra crates.\n\n- The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)\n  for the `main` branch of the whole Zebra monorepo.\n\n## User support\n\nFor bug reports please [open a bug report ticket in the Zebra repository](https://github.com/ZcashFoundation/zebra/issues/new?assignees=\u0026labels=C-bug%2C+S-needs-triage\u0026projects=\u0026template=bug_report.yml\u0026title=%5BUser+reported+bug%5D%3A+).\n\nAlternatively by chat, [Join the Zcash Foundation Discord\nServer](https://discord.com/invite/aRgNRVwsM8) and find the #zebra-support\nchannel.\n\nWe maintain a list of known issues in the\n[Troubleshooting](https://zebra.zfnd.org/user/troubleshooting.html) section of\nthe book.\n\n## Security\n\nZebra has a [responsible disclosure policy](https://github.com/ZcashFoundation/zebra/blob/main/SECURITY.md), which we encourage security researchers to follow.\n\n## License\n\nZebra is distributed under the terms of both the MIT license\nand the Apache License (Version 2.0).\n\nSee [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT).\n\nSome Zebra crates are distributed under the [MIT license only](LICENSE-MIT),\nbecause some of their code was originally from MIT-licensed projects.\nSee each crate's directory for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZcashFoundation%2Fzebra","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FZcashFoundation%2Fzebra","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZcashFoundation%2Fzebra/lists"}