Merge pull request #98 from plebhash/update-mining-protocol

cleanup and update Mining Protocol specs
stratum-mining · Dec 10, 2024 · 52e1fa2 · 52e1fa2
2 parents 02b0963 + 4e27a06
commit 52e1fa2
Show file tree

Hide file tree

Showing 13 changed files with 1,066 additions and 75 deletions.
diff --git a/05-Mining-Protocol.md b/05-Mining-Protocol.md
diff --git a/README.md b/README.md
@@ -37,12 +37,16 @@ This repository contains the Stratum V2 protocol specification.
   - [4.6 URL Scheme and Pool Authority Key](./04-Protocol-Security.md#46-url-scheme-and-pool-authority-key)
   - [4.7 References](./04-Protocol-Security.md#47-references)
 - [5. Mining Protocol](./05-Mining-Protocol.md)
-  - [5.1 Channels](./05-Mining-Protocol.md#51-channels)
-    - [5.1.1 Standard Channels](./05-Mining-Protocol.md#511-standard-channels)
-    - [5.1.2 Extended Channels](./05-Mining-Protocol.md#512-extended-channels)
-    - [5.1.3 Group Channels](./05-Mining-Protocol.md#513-group-channels)
-    - [5.1.4 Future Jobs](./05-Mining-Protocol.md#514-future-jobs)
-  - [5.2 Hashing Space Distribution](./05-Mining-Protocol.md#52-hashing-space-distribution)
+  - [5.1 Jobs](./05-Mining-Protocol.md#51-jobs)
+    - [5.1.1 Standard Jobs](./05-Mining-Protocol.md#511-standard-jobs)
+    - [5.1.2 Extended Jobs](./05-Mining-Protocol.md#512-extended-jobs)
+      - [5.1.2.1 Extended Extranonce](./05-Mining-Protocol.md#5121-extended-extranonce)
+    - [5.1.3 Future Jobs](./05-Mining-Protocol.md#513-future-jobs)
+    - [5.1.4 Custom Jobs](./05-Mining-Protocol.md#514-custom-jobs)
+  - [5.2 Channels](./05-Mining-Protocol.md#52-channels)
+    - [5.2.1 Standard Channels](./05-Mining-Protocol.md#521-standard-channels)
+    - [5.2.2 Extended Channels](./05-Mining-Protocol.md#522-extended-channels)
+    - [5.2.3 Group Channels](./05-Mining-Protocol.md#523-group-channels)
   - [5.3 Mining Protocol Messages](./05-Mining-Protocol.md#53-mining-protocol-messages)
     - [5.3.1 SetupConnection Flags for Mining Protocol](./05-Mining-Protocol.md#531-setupconnection-flags-for-mining-protocol)
     - [5.3.2 OpenStandardMiningChannel (Client -> Server)](./05-Mining-Protocol.md#532-openstandardminingchannel-client---server)
@@ -65,8 +69,7 @@ This repository contains the Stratum V2 protocol specification.
     - [5.3.19 SetCustomMiningJob.Success (Server -> Client)](./05-Mining-Protocol.md#5319-setcustomminingjobsuccess-server---client)
     - [5.3.20 SetCustomMiningJob.Error (Server -> Client)](./05-Mining-Protocol.md#5320-setcustomminingjoberror-server---client)
     - [5.3.21 SetTarget (Server -> Client)](./05-Mining-Protocol.md#5321-settarget-server---client)
-    - [5.3.22 Reconnect (Server -> Client)](./05-Mining-Protocol.md#5322-reconnect-server---client)
-    - [5.3.23 SetGroupChannel (Server -> Client)](./05-Mining-Protocol.md#5323-setgroupchannel-server---client)
+    - [5.3.22 SetGroupChannel (Server -> Client)](./05-Mining-Protocol.md#5322-setgroupchannel-server---client)
 - [6. Job Declaration Protocol](./06-Job-Declaration-Protocol.md)
   - [6.1 Job Declaration Protocol Messages](./06-Job-Declaration-Protocol.md#61-job-declaration-protocol-messages)
     - [6.1.1 SetupConnection Flags for Job Declaration Protocol](./06-Job-Declaration-Protocol.md#611-setupconnection-flags-for-job-declaration-protocol)

diff --git a/img/4.3.a-Mining-Protocol-Messages-Initialization.png b/img/4.3.a-Mining-Protocol-Messages-Initialization.png
diff --git a/img/4.3.b-Mining-Protocol-Messages-Mining-on-Standard-Channel.png b/img/4.3.b-Mining-Protocol-Messages-Mining-on-Standard-Channel.png
diff --git a/img/drawio/README.md b/img/drawio/README.md
@@ -0,0 +1,6 @@
+In case the `*.png` files on the parent directory need to be adjusted, the `*.drawio.xml` files from this directory 
+should be imported into the `draw.io` online tool for editing.
+
+After editing:
+- export the `.png` file to replace the old one in the parent directory
+- export the `.drawio.xml` file to replace the old one on this directory
diff --git a/img/drawio/extended_extranonce.drawio.xml b/img/drawio/extended_extranonce.drawio.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36" version="24.8.2">
+  <diagram id="FxWmPz-zqYVIyW4dWZh6" name="Extended Extranonce">
+    <mxGraphModel dx="1434" dy="887" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+      <root>
+        <mxCell id="0" />
+        <mxCell id="1" parent="0" />
+        <mxCell id="1wnQGwD5fLxFCYtxcwfU-1" value="extranonce_prefix&lt;br&gt;(upstream reserved)" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+          <mxGeometry x="190" y="200" width="130" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="1wnQGwD5fLxFCYtxcwfU-2" value="downstream reserved" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#808080;" parent="1" vertex="1">
+          <mxGeometry x="450" y="200" width="130" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="1wnQGwD5fLxFCYtxcwfU-3" value="locally reserved" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#B3B3B3;" parent="1" vertex="1">
+          <mxGeometry x="320" y="200" width="130" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="1wnQGwD5fLxFCYtxcwfU-4" value="&lt;b&gt;Extended Extranonce&lt;/b&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
+          <mxGeometry x="312.5" y="170" width="145" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="1wnQGwD5fLxFCYtxcwfU-5" value="Generic Stratum Layer" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
+          <mxGeometry x="30" y="215" width="140" height="30" as="geometry" />
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>