Go to file
Jack Grigg 19c7742318 qa: `cargo vet init` 2022-06-09 14:50:23 +00:00
.cargo Migrate to `zcash_primitives 0.6` et al 2022-05-11 00:04:34 +00:00
.github Bump actions/checkout from 2 to 3 2022-04-14 01:10:19 +00:00
build-aux/m4 Partial revert of "Update links". See #4904 2020-12-17 01:42:03 +00:00
contrib halo2 is now under MIT/Apache-2.0, so does not need a declaration in `contrib/debian/copyright`. 2022-06-07 18:59:28 +01:00
depends depends: Vendor dependencies of native_cxxbuild 2022-05-27 23:16:17 +00:00
doc Mark the `dumpwallet` RPC method as disabled. 2022-05-26 14:31:26 -06:00
qa qa: `cargo vet init` 2022-06-09 14:50:23 +00:00
share Update links 2020-12-13 11:24:44 +02:00
src Merge pull request #5971 from str4d/rust-cxx 2022-06-02 16:11:22 +01:00
test/lint Fix -Wthread-safety-analysis warnings. Change the sync.h primitives to std from boost. 2022-05-14 01:25:08 +00:00
zcutil Migrate Equihash Rust FFI to `cxx` 2022-05-27 20:15:05 +00:00
.gitattributes Separate protocol versioning from clientversion 2014-10-29 00:24:40 -04:00
.gitignore Migrate Equihash Rust FFI to `cxx` 2022-05-27 20:15:05 +00:00
CONTRIBUTING.md Link to development guidelines in CONTRIBUTING.md 2019-06-11 10:27:52 -05:00
COPYING Note dependence on BOSL in COPYING 2022-06-01 20:23:28 +00:00
Cargo.lock depends: Add cxx crate to dependencies 2022-05-26 03:14:21 +00:00
Cargo.toml qa: `cargo vet init` 2022-06-09 14:50:23 +00:00
INSTALL Typo Fix 2019-08-21 11:17:21 -04:00
Makefile.am Include $(bin_SCRIPTS) in `check-symbols`, `check-security`, and `clean` targets. 2022-03-13 22:53:29 +00:00
README.md make-release.py: Versioning changes for 5.0.0. 2022-05-10 19:48:53 -06:00
SECURITY.md Rename responsible_disclosure.md to SECURITY.md 2021-02-18 23:38:32 +00:00
autogen.sh Enable ShellCheck rules 2020-10-26 17:36:26 +00:00
code_of_conduct.md Beef up the CoC to address use of dog-whistles. 2020-10-11 08:24:37 +01:00
configure.ac depends: Add cxxbridge command to dependencies 2022-05-27 20:15:05 +00:00
libzcash_script.pc.in Rename libzcashconsensus.la -> libzcash_script.la 2021-01-25 22:20:25 +00:00
rust-toolchain depends: Update Rust to 1.59.0 2022-03-01 00:09:18 +00:00

README.md

Zcash 5.0.0

What is Zcash?

Zcash is an implementation of the "Zerocash" protocol. Based on Bitcoin's code, Zcash intends to offer a far higher standard of privacy through a sophisticated zero-knowledge proving scheme that preserves confidentiality of transaction metadata. More technical details are available in our Protocol Specification.

This software is the Zcash client. It downloads and stores the entire history of Zcash transactions; depending on the speed of your computer and network connection, the synchronization process could take a day or more once the blockchain has reached a significant size.

🔒 Security Warnings

See important security warnings on the Security Information page.

Zcash is experimental and a work in progress. Use it at your own risk.

📒 Deprecation Policy

This release is considered deprecated 16 weeks after the release day. There is an automatic deprecation shutdown feature which will halt the node some time after this 16-week period. The automatic feature is based on block height.

Getting Started

Please see our user guide for joining the main Zcash network.

Need Help?

  • 📘 See the documentation at the ReadTheDocs for help and more information.
  • 📨 Ask for help on the Zcash forum.
  • 💬 Join our community on Discord

Participation in the Zcash project is subject to a Code of Conduct.

Building

Build Zcash along with most dependencies from source by running the following command:

./zcutil/build.sh -j$(nproc)

Currently, Zcash is only officially supported on Debian and Ubuntu. See the Debian / Ubuntu build for detailed instructions.

License

For license information see the file COPYING.