IPC docs (for v31)

.github/workflows/ci.yml

@@ -55,6 +55,23 @@ jobs:
           rm Gemfile.lock
           make all
 
+  doc-gen:
+    runs-on: ubuntu-latest
+    container:
+      image: debian:bookworm
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install packages
+        run: |
+          apt-get update
+          apt-get install -y capnproto golang
+      - name: Vet and build doc generator
+        working-directory: contrib/doc-gen
+        run: |
+          go vet ./...
+          go build ./...
+
   verify-commits:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'

_doc/en/31.0.0/ipc/blocktemplate/destroy.html

@@ -0,0 +1,16 @@
+---
+name: destroy
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/destroy/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">destroy</span> <span class="nd">@0</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+

_doc/en/31.0.0/ipc/blocktemplate/getBlock.html

@@ -0,0 +1,16 @@
+---
+name: getBlock
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/getBlock/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">getBlock</span> <span class="nd">@2</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><span class="kt">Data</span>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+

_doc/en/31.0.0/ipc/blocktemplate/getBlockHeader.html

@@ -0,0 +1,16 @@
+---
+name: getBlockHeader
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/getBlockHeader/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">getBlockHeader</span> <span class="nd">@1</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><span class="kt">Data</span>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+

_doc/en/31.0.0/ipc/blocktemplate/getCoinbaseMerklePath.html

@@ -0,0 +1,23 @@
+---
+name: getCoinbaseMerklePath
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/getCoinbaseMerklePath/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">getCoinbaseMerklePath</span> <span class="nd">@6</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><span class="kt">List</span><span class="p">(</span><span class="kt">Data</span><span class="p">)</span>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<div class="ipc-doc">
+<p>Compute merkle path to the coinbase transaction</p>
+<dl class="ipc-doc-tags">
+  <dt><strong>returns</strong></dt>
+  <dd>merkle path ordered from the deepest</dd>
+</dl>
+</div>
+

_doc/en/31.0.0/ipc/blocktemplate/getCoinbaseTx.html

@@ -0,0 +1,19 @@
+---
+name: getCoinbaseTx
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/getCoinbaseTx/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">getCoinbaseTx</span> <span class="nd">@5</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><a class="nc" href="../../structs/#CoinbaseTx">CoinbaseTx</a>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<div class="ipc-doc">
+<p>Return fields needed to construct a coinbase transaction</p>
+</div>
+

_doc/en/31.0.0/ipc/blocktemplate/getTxFees.html

@@ -0,0 +1,16 @@
+---
+name: getTxFees
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/getTxFees/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">getTxFees</span> <span class="nd">@3</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><span class="kt">List</span><span class="p">(</span><span class="kt">Int64</span><span class="p">)</span>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+

_doc/en/31.0.0/ipc/blocktemplate/getTxSigops.html

@@ -0,0 +1,16 @@
+---
+name: getTxSigops
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/getTxSigops/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">getTxSigops</span> <span class="nd">@4</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><span class="kt">List</span><span class="p">(</span><span class="kt">Int64</span><span class="p">)</span>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+

_doc/en/31.0.0/ipc/blocktemplate/index.html

@@ -0,0 +1,24 @@
+---
+name: BlockTemplate
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+btcifaceindex: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/
+---
+
+<p>Methods on the <code>BlockTemplate</code> IPC interface:</p>
+<ul>
+  <li><a href="destroy/">destroy</a></li>
+  <li><a href="getBlockHeader/">getBlockHeader</a></li>
+  <li><a href="getBlock/">getBlock</a></li>
+  <li><a href="getTxFees/">getTxFees</a></li>
+  <li><a href="getTxSigops/">getTxSigops</a></li>
+  <li><a href="getCoinbaseTx/">getCoinbaseTx</a></li>
+  <li><a href="getCoinbaseMerklePath/">getCoinbaseMerklePath</a></li>
+  <li><a href="submitSolution/">submitSolution</a></li>
+  <li><a href="waitNext/">waitNext</a></li>
+  <li><a href="interruptWait/">interruptWait</a></li>
+</ul>
+

_doc/en/31.0.0/ipc/blocktemplate/interruptWait.html

@@ -0,0 +1,19 @@
+---
+name: interruptWait
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/interruptWait/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">interruptWait</span> <span class="nd">@9</span> <span class="p">(</span>
+
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<div class="ipc-doc">
+<p>Interrupts the current wait for the next block template.</p>
+</div>
+

_doc/en/31.0.0/ipc/blocktemplate/submitSolution.html

@@ -0,0 +1,35 @@
+---
+name: submitSolution
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/submitSolution/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">submitSolution</span> <span class="nd">@7</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span><span class="p">,</span>
+  <span class="nv">version</span> <span class="p">:</span><span class="kt">UInt32</span><span class="p">,</span>
+  <span class="nv">timestamp</span> <span class="p">:</span><span class="kt">UInt32</span><span class="p">,</span>
+  <span class="nv">nonce</span> <span class="p">:</span><span class="kt">UInt32</span><span class="p">,</span>
+  <span class="nv">coinbase</span> <span class="p">:</span><span class="kt">Data</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><span class="kt">Bool</span>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<div class="ipc-doc">
+<p>Construct and broadcast the block. Modifies the template in place, updating the fields listed below as well as the merkle root.</p>
+<dl class="ipc-doc-tags">
+  <dt><strong>param [in]</strong> <code>version</code></dt>
+  <dd>version block header field</dd>
+  <dt><strong>param [in]</strong> <code>timestamp</code></dt>
+  <dd>time block header field (unix timestamp)</dd>
+  <dt><strong>param [in]</strong> <code>nonce</code></dt>
+  <dd>nonce block header field</dd>
+  <dt><strong>param [in]</strong> <code>coinbase</code></dt>
+  <dd>complete coinbase transaction (including witness)  @note unlike the submitblock RPC, this method does NOT add the coinbase witness automatically.</dd>
+  <dt><strong>returns</strong></dt>
+  <dd>if the block was processed, does not necessarily indicate validity.  @note Returns true if the block is already known, which can happen if the solved block is constructed and broadcast by multiple nodes (e.g. both the miner who constructed the template and the pool).</dd>
+</dl>
+</div>
+

_doc/en/31.0.0/ipc/blocktemplate/waitNext.html

@@ -0,0 +1,26 @@
+---
+name: waitNext
+btcversion: 31.0.0
+btcgroup: blocktemplate
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/blocktemplate/waitNext/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>BlockTemplate</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">waitNext</span> <span class="nd">@8</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span><span class="p">,</span>
+  <span class="nv">options</span> <span class="p">:</span><a class="nc" href="../../structs/#BlockWaitOptions">BlockWaitOptions</a>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><a class="nc" href="../../blocktemplate/">BlockTemplate</a>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<div class="ipc-doc">
+<p>Waits for fees in the next block to rise, a new tip or the timeout.</p>
+<dl class="ipc-doc-tags">
+  <dt><strong>param [in]</strong> <code>options</code></dt>
+  <dd>Control the timeout (default forever) and by how much total fees for the next block should rise (default infinite).</dd>
+  <dt><strong>returns</strong></dt>
+  <dd>a new <a href="../../blocktemplate/">BlockTemplate</a> or nothing if the timeout occurs.  On testnet this will additionally return a template with difficulty 1 if the tip is more than 20 minutes old.</dd>
+</dl>
+</div>
+

_doc/en/31.0.0/ipc/echo/destroy.html

@@ -0,0 +1,16 @@
+---
+name: destroy
+btcversion: 31.0.0
+btcgroup: echo
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/echo/destroy/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>Echo</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">destroy</span> <span class="nd">@0</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+

_doc/en/31.0.0/ipc/echo/echo.html

@@ -0,0 +1,20 @@
+---
+name: echo
+btcversion: 31.0.0
+btcgroup: echo
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/echo/echo/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>Echo</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">echo</span> <span class="nd">@1</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span><span class="p">,</span>
+  <span class="nv">echo</span> <span class="p">:</span><span class="kt">Text</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><span class="kt">Text</span>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<div class="ipc-doc">
+<p><a href="../../echo/">Echo</a> provided string.</p>
+</div>
+

_doc/en/31.0.0/ipc/echo/index.html

@@ -0,0 +1,16 @@
+---
+name: Echo
+btcversion: 31.0.0
+btcgroup: echo
+btcdoctype: IPC
+btchtml: true
+btcifaceindex: true
+permalink: en/doc/31.0.0/ipc/echo/
+---
+
+<p>Methods on the <code>Echo</code> IPC interface:</p>
+<ul>
+  <li><a href="destroy/">destroy</a></li>
+  <li><a href="echo/">echo</a></li>
+</ul>
+

_doc/en/31.0.0/ipc/index.html

@@ -0,0 +1,9 @@
+---
+name: ipcindex
+btcversion: 31.0.0
+btcgroup: index
+btcdoctype: IPC
+permalink: en/doc/31.0.0/ipc/
+---
+
+

_doc/en/31.0.0/ipc/init/index.html

@@ -0,0 +1,16 @@
+---
+name: Init
+btcversion: 31.0.0
+btcgroup: init
+btcdoctype: IPC
+btchtml: true
+btcifaceindex: true
+permalink: en/doc/31.0.0/ipc/init/
+---
+
+<p>Methods on the <code>Init</code> IPC interface:</p>
+<ul>
+  <li><a href="makeEcho/">makeEcho</a></li>
+  <li><a href="makeMining/">makeMining</a></li>
+</ul>
+

_doc/en/31.0.0/ipc/init/makeEcho.html

@@ -0,0 +1,17 @@
+---
+name: makeEcho
+btcversion: 31.0.0
+btcgroup: init
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/init/makeEcho/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>Init</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">makeEcho</span> <span class="nd">@1</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><a class="nc" href="../../echo/">Echo</a>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<p class="ipc-makes">Returns the <a href="../../echo/">Echo</a> interface.</p>
+

_doc/en/31.0.0/ipc/init/makeMining.html

@@ -0,0 +1,17 @@
+---
+name: makeMining
+btcversion: 31.0.0
+btcgroup: init
+btcdoctype: IPC
+btchtml: true
+permalink: en/doc/31.0.0/ipc/init/makeMining/
+---
+
+<p class="ipc-context">Method on interface <a href="../"><code>Init</code></a>.</p>
+<div class="highlight"><pre><code><span class="nv">makeMining</span> <span class="nd">@3</span> <span class="p">(</span>
+  <span class="nv">context</span> <span class="p">:</span><span class="nc">Context</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span>
+  <span class="nv">result</span> <span class="p">:</span><a class="nc" href="../../mining/">Mining</a>
+<span class="p">)</span><span class="p">;</span></code></pre></div>
+<p class="ipc-makes">Returns the <a href="../../mining/">Mining</a> interface.</p>
+