From 5a6a6a3f806cf24bb8103d9c35538b70a896aec8 Mon Sep 17 00:00:00 2001 From: teor Date: Wed, 23 Nov 2022 16:01:34 +1000 Subject: [PATCH] Explain that Zebra needs extra software to generate blocks or transactions (#5698) --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a7201605a..e81b4b95b 100644 --- a/README.md +++ b/README.md @@ -61,11 +61,15 @@ Every few weeks, we release a [new Zebra version](https://github.com/ZcashFounda Zebra's network stack is interoperable with `zcashd`, and Zebra implements all the features required to reach Zcash network consensus. - -Zebra also supports the [`lightwalletd` backend JSON-RPCs](https://github.com/ZcashFoundation/zebra#configuring-json-rpc-for-lightwalletd). - Currently, Zebra validates all of the Zcash consensus rules for the NU5 network upgrade. +Zebra validates blocks and transactions, but needs extra software to generate them: +- to generate transactions, [configure `zebrad`'s JSON-RPC port](https://github.com/ZcashFoundation/zebra#configuring-json-rpc-for-lightwalletd), + and use a light wallet with `lightwalletd` and Zebra. +- to generate blocks, [compile `zebrad` with the `getblocktemplate-rpcs` feature](https://doc.zebra.zfnd.org/zebrad/#json-rpc), configure the JSON-RPC port, + and use a mining pool or miner with Zebra's mining JSON-RPCs. + Mining support is currently incomplete, experimental, and off by default. + ## Getting Started You can run Zebra using our Docker image. @@ -77,7 +81,10 @@ docker run zfnd/zebra:1.0.0-rc.1 For more information, read our [Docker documentation](book/src/user/docker.md). -> You can also [enable Zebra's RPC port](https://github.com/ZcashFoundation/zebra#configuring-json-rpc-for-lightwalletd) and [configure other features](https://zebra.zfnd.org/user/run.html). +You can also: +- [compile Zebra with metrics or tracing](https://doc.zebra.zfnd.org/zebrad/#metrics), +- [enable Zebra's RPC port](https://github.com/ZcashFoundation/zebra#configuring-json-rpc-for-lightwalletd), and +- [configure other features](https://zebra.zfnd.org/user/run.html). ### Build Instructions