2022-01-05 12:16:10 -08:00
|
|
|
Zcash 4.6.0-1
|
2018-08-20 09:18:14 -07:00
|
|
|
<img align="right" width="120" height="80" src="doc/imgs/logo.png">
|
|
|
|
|
===========
|
2016-01-20 08:15:36 -08:00
|
|
|
|
2016-01-19 23:37:45 -08:00
|
|
|
What is Zcash?
|
2016-07-11 05:38:54 -07:00
|
|
|
--------------
|
2012-12-12 18:27:58 -08:00
|
|
|
|
2016-10-25 08:14:38 -07:00
|
|
|
[Zcash](https://z.cash/) is an implementation of the "Zerocash" protocol.
|
2019-03-27 15:46:28 -07:00
|
|
|
Based on Bitcoin's code, Zcash intends to offer a far higher standard of privacy
|
2016-11-03 21:07:56 -07:00
|
|
|
through a sophisticated zero-knowledge proving scheme that preserves
|
2019-03-27 15:46:28 -07:00
|
|
|
confidentiality of transaction metadata. More technical details are available
|
2021-01-27 09:46:03 -08:00
|
|
|
in our [Protocol Specification](https://zips.z.cash/protocol/protocol.pdf).
|
2012-12-12 18:27:58 -08:00
|
|
|
|
2016-10-25 08:14:38 -07:00
|
|
|
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
|
2016-12-04 09:02:39 -08:00
|
|
|
blockchain has reached a significant size.
|
2016-03-31 17:35:52 -07:00
|
|
|
|
2018-08-20 09:18:14 -07:00
|
|
|
<p align="center">
|
|
|
|
|
<img src="doc/imgs/zcashd_screen.gif" height="500">
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
#### :lock: Security Warnings
|
2016-07-12 12:34:34 -07:00
|
|
|
|
2017-10-31 20:31:40 -07:00
|
|
|
See important security warnings on the
|
|
|
|
|
[Security Information page](https://z.cash/support/security/).
|
2016-07-12 12:34:34 -07:00
|
|
|
|
2019-03-27 15:46:28 -07:00
|
|
|
**Zcash is experimental and a work in progress.** Use it at your own risk.
|
2016-10-25 08:14:38 -07:00
|
|
|
|
2018-08-20 09:18:14 -07:00
|
|
|
#### :ledger: Deprecation Policy
|
2017-05-24 07:37:10 -07:00
|
|
|
|
|
|
|
|
This release is considered deprecated 16 weeks after the release day. There
|
2017-05-24 08:15:03 -07:00
|
|
|
is an automatic deprecation shutdown feature which will halt the node some
|
2019-03-27 15:46:28 -07:00
|
|
|
time after this 16-week period. The automatic feature is based on block
|
2018-08-20 09:18:14 -07:00
|
|
|
height.
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
2017-05-24 07:37:10 -07:00
|
|
|
|
2018-08-20 09:18:14 -07:00
|
|
|
Please see our [user guide](https://zcash.readthedocs.io/en/latest/rtd_pages/rtd_docs/user_guide.html) for joining the main Zcash network.
|
2016-10-25 08:14:38 -07:00
|
|
|
|
|
|
|
|
### Need Help?
|
|
|
|
|
|
2019-10-30 13:12:00 -07:00
|
|
|
* :blue_book: See the documentation at the [ReadTheDocs](https://zcash.readthedocs.io)
|
2016-10-25 08:14:38 -07:00
|
|
|
for help and more information.
|
2018-08-20 09:18:14 -07:00
|
|
|
* :incoming_envelope: Ask for help on the [Zcash](https://forum.z.cash/) forum.
|
2020-12-24 04:46:36 -08:00
|
|
|
* :speech_balloon: Join our community on [Discord](https://discordapp.com/invite/PhJY6Pm)
|
2016-10-25 08:14:38 -07:00
|
|
|
|
|
|
|
|
Participation in the Zcash project is subject to a
|
|
|
|
|
[Code of Conduct](code_of_conduct.md).
|
|
|
|
|
|
2018-08-20 09:18:14 -07:00
|
|
|
### Building
|
|
|
|
|
|
2019-03-27 15:46:28 -07:00
|
|
|
Build Zcash along with most dependencies from source by running the following command:
|
2018-08-20 09:18:14 -07:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
./zcutil/build.sh -j$(nproc)
|
|
|
|
|
```
|
2016-10-25 08:14:38 -07:00
|
|
|
|
2020-09-22 00:12:30 -07:00
|
|
|
Currently, Zcash is only officially supported on Debian and Ubuntu. See the
|
|
|
|
|
[Debian / Ubuntu build](https://zcash.readthedocs.io/en/latest/rtd_pages/Debian-Ubuntu-build.html)
|
|
|
|
|
for detailed instructions.
|
2016-10-25 08:14:38 -07:00
|
|
|
|
2012-12-12 18:27:58 -08:00
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
2016-10-25 08:14:38 -07:00
|
|
|
For license information see the file [COPYING](COPYING).
|
