Go to file
Elliot Olds 845b31a760 Check if zmq is installed in tests, update docs
If ZMQ is enabled, check whether it's installed before running ZMQ tests.
If it isn't, disable ZMQ and print a warning.

Also add dependency info to test docs, so users know ZMQ is required
before running tests, and so they know how to install it.

When following the build instructions before this change then trying
to run the RPC tests, a unix user would get an error when python
tried to import zmq.

There may be other dependencies that should be added to the docs,
particularly ones for non-unix systems. This is the only unlisted
dependency I encountered using linux.
2020-11-21 02:33:27 +00:00
.cargo Use ed25519-zebra from crates.io. 2020-07-08 13:11:27 -06:00
.github Update documentation info 2020-04-12 15:27:09 +03:00
build-aux/m4 build: Update AX_CXX_COMPILE_STDCXX macro 2020-10-20 13:55:14 +01:00
contrib make-release.py: Updated release notes and changelog for 4.1.1. 2020-11-16 10:23:40 -07:00
depends Set release CFLAGS/CXXFLAGS to use -O3. 2020-11-13 22:39:17 +00:00
doc Add notable changes to release notes for v4.1.1 2020-11-16 10:26:11 -07:00
qa Check if zmq is installed in tests, update docs 2020-11-21 02:33:27 +00:00
share Add error handling: exit if cd fails 2020-10-27 15:08:36 +00:00
src Fix crash when mining with empty keypool. 2020-11-20 03:30:37 +00:00
test/lint lint: Re-exclude subtrees from lint-include-guards.sh 2020-11-09 23:06:21 +00:00
zcutil Windows cross-build generates .lib files, which should be ignored by git and removed by clean. 2020-11-16 11:03:22 +00:00
.gitattributes Separate protocol versioning from clientversion 2014-10-29 00:24:40 -04:00
.gitignore Windows cross-build generates .lib files, which should be ignored by git and removed by clean. 2020-11-16 11:03:22 +00:00
CONTRIBUTING.md Link to development guidelines in CONTRIBUTING.md 2019-06-11 10:27:52 -05:00
COPYING Remove remaining OpenSSL references 2020-09-30 00:40:12 +01:00
Cargo.lock cargo update 2020-11-10 21:39:55 +00:00
Cargo.toml Replace libsodium's crypto_generichash_blake2b with blake2b_simd 2020-09-24 15:58:14 +01:00
INSTALL Typo Fix 2019-08-21 11:17:21 -04:00
Makefile.am build: don't distribute tests_config.py 2020-11-21 02:33:27 +00:00
README.md make-release.py: Versioning changes for 4.1.1. 2020-11-16 10:07:07 -07: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 Migrated rpc-tests.sh to all python rpc-tests.py 2020-11-20 03:32:53 +00:00
libzcashconsensus.pc.in build: remove libcrypto as internal dependency in libbitcoinconsensus.pc 2020-09-30 00:40:12 +01:00
responsible_disclosure.md Fixes #4013, added BitcoinABC as a disclosure partner 2019-05-14 07:51:08 -07:00
rust-toolchain Update Rust to 1.44.1. 2020-09-22 15:06:01 -06:00

README.md

Zcash 4.1.1

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.
  • 💬 Chat with our support 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.