Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Refactor the installation instructions for s-nomp #7835

Merged
merged 5 commits into from
Oct 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 28 additions & 22 deletions book/src/user/mining-testnet-s-nomp.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@ These fixes disable mining pool operator payments and miner payments: they just

</details>

2. [Build](https://github.com/ZcashFoundation/zebra#build-instructions) and [Run Zebra](https://zebra.zfnd.org/user/run.html) with the `getblocktemplate-rpcs` feature:
2. [Run Zebra](https://zebra.zfnd.org/user/run.html) with the config you created:
```sh
cargo run --release --features "getblocktemplate-rpcs" --bin zebrad -- -c zebrad.toml
zebrad -c zebrad.toml
```
3. Wait a few hours for Zebra to sync to the testnet tip (on mainnet this takes 2-3 days)
3. Wait for Zebra to sync to the testnet tip. This takes 8-12 hours on testnet (or 2-3 days on mainnet) as of October 2023.

## Install `s-nomp`

Expand Down Expand Up @@ -137,43 +137,49 @@ These fixes disable mining pool operator payments and miner payments: they just

<details><summary>Arch-specific instructions</summary>

#### Install dependencies
#### Install `s-nomp`

1. Install [`redis`](https://redis.io/docs/getting-started/) and run it on the default port:
1. Install Redis, and development libraries required by S-nomp

```sh
sudo pacman -S redis
sudo systemctl start redis
sudo pacman -S redis boost libsodium
```

2. Install and activate [`nvm`](https://github.com/nvm-sh/nvm#installing-and-updating):
2. Install `nvm`, Python 3.10 and `virtualenv`

```sh
sudo pacman -S nvm
unset npm_config_prefix
source /usr/share/nvm/init-nvm.sh
paru -S python310 nvm
sudo pacman -S python-virtualenv
```

3. Install `boost` and `libsodium` development libraries:

3. Start Redis
```sh
sudo pacman -S boost libsodium
sudo systemctl start redis
```

#### Install `s-nomp`
4. Clone the repository

```sh
git clone https://github.com/ZcashFoundation/s-nomp && cd s-nomp
```

1. `git clone https://github.com/ZcashFoundation/s-nomp && cd s-nomp`
5. Use Node 10:

2. Use the Zebra configs: `git checkout zebra-mining`
```sh
unset npm_config_prefix
source /usr/share/nvm/init-nvm.sh
nvm install 10
nvm use 10
```

3. Use node 8.11.0:
6. Use Python 3.10

```sh
nvm install 8.11.0
nvm use 8.11.0
virtualenv -p 3.10 s-nomp
source s-nomp/bin/activate
```

4. Update dependencies and install:
7. Update dependencies and install:

```sh
npm update
Expand Down