More info about merge mining

SChernykh · Jun 30, 2024 · 17de2ff · 17de2ff
1 parent 0b07922
commit 17de2ff
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ These are 3rd-party pages. If they are down, it doesn't mean there is a problem
 - [How to mine on P2Pool](#how-to-mine-on-p2pool)
   - [General Considerations](#general-considerations)
   - [GUI for P2Pool](#gui-for-p2pool)
+  - [Merge mining](#merge-mining)
   - [GNU/Linux](#gnulinux)
   - [Windows](#windows)
 - [Build instructions](#build-instructions)
@@ -75,12 +76,13 @@ First you need to find a pool share. This share will stay in [PPLNS](https://en.
 
 - The latest Monero network upgrade happened on August 13th, 2022 (block 2,688,888).
 - The latest P2Pool network upgrade happened on March 18th, 2023 at 21:00 UTC.
+- Next P2Pool network upgrade will happen on October 12th, 2024 at 20:00 UTC.
 
 In order to continue mining on P2Pool, you must update both Monero and P2Pool software to the latest available versions as soon as they are released.
 
 |Monero protocol version|Required Monero software version|Required P2Pool version
 |-|-|-|
-|v15, v16 (active after August 13th, 2022)|v0.18.0.0 or newer, v0.18.3.1 is recommended|v3.0 or newer
+|v15, v16 (active after August 13th, 2022)|v0.18.0.0 or newer, v0.18.3.3 is recommended|v4.0 or newer
 
 ## How to mine on P2Pool
 
@@ -107,6 +109,23 @@ In order to continue mining on P2Pool, you must update both Monero and P2Pool so
 
 - [Gupax](https://github.com/hinto-janai/gupax) project aims to provide an easy to use cross-platform GUI to configure and run P2Pool & [XMRig](https://github.com/xmrig/xmrig).
 
+### Merge mining
+
+Merge mining will be available in P2Pool after the fork on October 12th, 2024. Version 4.0 or newer is required to use it.
+
+- Blockchains that will support [Merge mining RPC API](https://github.com/SChernykh/p2pool/blob/master/docs/MERGE_MINING.MD#proposed-rpc-api)
+  - [Townforge](https://townforge.net/) supports it in their [tmp-mm branch](https://git.townforge.net/townforge/townforge/src/branch/tmp-mm) (not released yet)
+  - [DarkFi](https://dark.fi/) is going to support it, but it's [not ready yet](https://github.com/darkrenaissance/darkfi/issues/244)
+  ```
+  p2pool.exe --wallet YOUR_MONERO_WALLET_ADDRESS --merge-mine IP:port YOUR_WALLET_ADDRESS_ON_ANOTHER_BLOCKCHAIN
+  ```
+
+- [Tari](https://www.tari.com/) uses their own gRPC API and requires a different command line:
+  ```
+  p2pool.exe --wallet YOUR_MONERO_WALLET_ADDRESS --merge-mine tari://IP:port TARI_WALLET_ADDRESS
+  ```
+  Merge mining is available for testing in Tari's [v1.0.0-pre.14 release](https://github.com/tari-project/tari/releases/tag/v1.0.0-pre.14) (Esmeralda testnet).
+
 ### GNU/Linux
 
 1. Download the latest P2Pool binaries [here](https://github.com/SChernykh/p2pool/releases/latest).

diff --git a/docs/COMMAND_LINE.MD b/docs/COMMAND_LINE.MD
@@ -54,12 +54,17 @@ p2pool.exe --host 127.0.0.1 --host node.monerodevs.org --rpc-port 18089 --zmq-po
 
 ### Merge mining
 
-```
-p2pool.exe --wallet YOUR_WALLET_ADDRESS --merge-mine IP:port YOUR_WALLET_ADDRESS_ON_ANOTHER_BLOCKCHAIN
-```
+Merge mining will be available in P2Pool after the fork on October 12th, 2024. Version 4.0 or newer is required to use it.
 
-For Tari:
+- Blockchains that will support [Merge mining RPC API](https://github.com/SChernykh/p2pool/blob/master/docs/MERGE_MINING.MD#proposed-rpc-api)
+  - [Townforge](https://townforge.net/) supports it in their [tmp-mm branch](https://git.townforge.net/townforge/townforge/src/branch/tmp-mm) (not released yet)
+  - [DarkFi](https://dark.fi/) is going to support it, but it's [not ready yet](https://github.com/darkrenaissance/darkfi/issues/244)
+  ```
+  p2pool.exe --wallet YOUR_MONERO_WALLET_ADDRESS --merge-mine IP:port YOUR_WALLET_ADDRESS_ON_ANOTHER_BLOCKCHAIN
+  ```
 
-```
-p2pool.exe --wallet YOUR_WALLET_ADDRESS --merge-mine tari://IP:port TARI_WALLET_ADDRESS
-```
+- [Tari](https://www.tari.com/) uses their own gRPC API and requires a different command line:
+  ```
+  p2pool.exe --wallet YOUR_MONERO_WALLET_ADDRESS --merge-mine tari://IP:port TARI_WALLET_ADDRESS
+  ```
+  Merge mining is available for testing in Tari's [v1.0.0-pre.14 release](https://github.com/tari-project/tari/releases/tag/v1.0.0-pre.14) (Esmeralda testnet).
diff --git a/docs/MERGE_MINING.MD b/docs/MERGE_MINING.MD
@@ -44,7 +44,7 @@ Reference code: `get_aux_slot` and `find_aux_nonce` in `merkle.cpp`
 
 ## Proposed RPC API
 
-P2Pool must be able to get mining jobs from merge mined chains and submit PoW solutions to them.
+P2Pool must be able to get mining jobs from merge mined chains and submit PoW solutions to them. All RPC calls here are sent as HTTP POST requests with `Content-Type: application/json`.
 
 ### merge_mining_get_chain_id