zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(README): Fix `lightwalletd` instructions to be compatible with Zebra (#6088) 

* Move detailed lightwalletd instructions out of README.md

* Move details from README into the lightwalletd instructions
This commit is contained in:
teor 2023-02-02 13:26:51 +10:00 committed by GitHub
parent b327d5bb7d
commit d575e5b40c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -118,17 +118,14 @@ listen_addr = '127.0.0.1:8232'
parallel_cpu_threads = 0 parallel_cpu_threads = 0
``` ```
It is recommended to use [adityapk00/lightwalletd](https://github.com/adityapk00/lightwalletd) because that is used in testing.
If using [zcash/lightwalletd](https://github.com/zcash/lightwalletd.git):
- note that it will require a zcash.conf file:
- `rpcuser` and `rpcpassword` are required by `lightwalletd`, but Zebra ignores them if it receives them from `lightwalletd`
- when using a non-default port, use `rpcport=28232` and `rpcbind=127.0.0.1`
- when using testnet, use `testnet=1`
**WARNING:** This config allows multiple Zebra instances to share the same RPC port. **WARNING:** This config allows multiple Zebra instances to share the same RPC port.
See the [RPC config documentation](https://doc.zebra.zfnd.org/zebra_rpc/config/struct.Config.html) for details. See the [RPC config documentation](https://doc.zebra.zfnd.org/zebra_rpc/config/struct.Config.html) for details.
`lightwalletd` also requires a `zcash.conf` file.
It is recommended to use [adityapk00/lightwalletd](https://github.com/adityapk00/lightwalletd) because that is used in testing.
Other `lightwalletd` forks have limited support, see the [detailed `lightwalletd` instructions](https://github.com/ZcashFoundation/zebra/blob/main/book/src/user/lightwalletd.md#sync-lightwalletd).
### Optional Features ### Optional Features
For performance reasons, some debugging and monitoring features are disabled in release builds. For performance reasons, some debugging and monitoring features are disabled in release builds.

9
book/src/user/lightwalletd.md
View File

@ -81,14 +81,14 @@ For implementing zebra as a service please see [here](https://github.com/ZcashFo
## Download and build lightwalletd ## Download and build lightwalletd
[#download-and-build-lightwalletd]: #download-and-build-lightwalletd [#download-and-build-lightwalletd]: #download-and-build-lightwalletd
While you synchronize Zebra you can install [lightwalletd](https://github.com/zcash/lightwalletd). While you synchronize Zebra you can install [lightwalletd](https://github.com/adityapk00/lightwalletd).
Before installing, you need to have `go` in place. Please visit the [go install page](https://go.dev/doc/install) with download and installation instructions. Before installing, you need to have `go` in place. Please visit the [go install page](https://go.dev/doc/install) with download and installation instructions.
With go installed and in your path, download and install lightwalletd: With go installed and in your path, download and install lightwalletd:
```console ```console
git clone https://github.com/zcash/lightwalletd git clone https://github.com/adityapk00/lightwalletd
cd lightwalletd cd lightwalletd
make make
make install make install
@ -101,7 +101,10 @@ If everything went good you should have a `lightwalletd` binary in `~/go/bin/`.
Please make sure you have zebrad running (with RPC endpoint and up to date blockchain) to synchronize lightwalletd. Please make sure you have zebrad running (with RPC endpoint and up to date blockchain) to synchronize lightwalletd.
- `lightwalletd` requires a `zcash.conf` file located somewhere, however this file can be empty if you are using the default zebra rpc endpoint (`127.0.0.1:8232`). - `lightwalletd` requires a `zcash.conf` file, however this file can be empty if you are using the default Zebra rpc endpoint (`127.0.0.1:8232`) and the `adityapk00/lightwalletd` fork
- Some `lightwalletd` forks also require a `rpcuser` and `rpcpassword`, but Zebra ignores them if it receives them from `lightwalletd`
- When using a non-default port, use `rpcport=28232` and `rpcbind=127.0.0.1`
- When using testnet, use `testnet=1`
- For production setups `lightwalletd` requires a `cert.pem`. For more information on how to do this please [see here](https://github.com/zcash/lightwalletd#production-usage). - For production setups `lightwalletd` requires a `cert.pem`. For more information on how to do this please [see here](https://github.com/zcash/lightwalletd#production-usage).