Skip to content

Commit 6878935

Browse files
Larry RuaneLarryRuane
Larry Ruane
authored and
LarryRuane
committed
update RTD index.html for Orchard
This file is generated from the *.proto files, and had gotten out of date. Updating it required installing docker; I followed these instructions: https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository I also needed to: $ sudo chmod 666 /var/run/docker.sock
1 parent 26df6f0 commit 6878935

File tree

1 file changed

+99
-13
lines changed

1 file changed

+99
-13
lines changed

‎docs/rtd/index.html

Lines changed: 99 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,15 @@ <h2>Table of Contents</h2>
183183
</li>
184184

185185
<li>
186-
<a href="#cash.z.wallet.sdk.rpc.CompactOutput"><span class="badge">M</span>CompactOutput</a>
186+
<a href="#cash.z.wallet.sdk.rpc.CompactOrchardAction"><span class="badge">M</span>CompactOrchardAction</a>
187187
</li>
188188

189189
<li>
190-
<a href="#cash.z.wallet.sdk.rpc.CompactSpend"><span class="badge">M</span>CompactSpend</a>
190+
<a href="#cash.z.wallet.sdk.rpc.CompactSaplingOutput"><span class="badge">M</span>CompactSaplingOutput</a>
191+
</li>
192+
193+
<li>
194+
<a href="#cash.z.wallet.sdk.rpc.CompactSaplingSpend"><span class="badge">M</span>CompactSaplingSpend</a>
191195
</li>
192196

193197
<li>
@@ -408,7 +412,52 @@ <h3 id="cash.z.wallet.sdk.rpc.CompactBlock">CompactBlock</h3>
408412

409413

410414

411-
<h3 id="cash.z.wallet.sdk.rpc.CompactOutput">CompactOutput</h3>
415+
<h3 id="cash.z.wallet.sdk.rpc.CompactOrchardAction">CompactOrchardAction</h3>
416+
<p>https://github.com/zcash/zips/blob/main/zip-0225.rst#orchard-action-description-orchardaction</p><p>(but not all fields are needed)</p>
417+
418+
419+
<table class="field-table">
420+
<thead>
421+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
422+
</thead>
423+
<tbody>
424+
425+
<tr>
426+
<td>nullifier</td>
427+
<td><a href="#bytes">bytes</a></td>
428+
<td></td>
429+
<td><p>[32] The nullifier of the input note </p></td>
430+
</tr>
431+
432+
<tr>
433+
<td>cmx</td>
434+
<td><a href="#bytes">bytes</a></td>
435+
<td></td>
436+
<td><p>[32] The x-coordinate of the note commitment for the output note </p></td>
437+
</tr>
438+
439+
<tr>
440+
<td>ephemeralKey</td>
441+
<td><a href="#bytes">bytes</a></td>
442+
<td></td>
443+
<td><p>[32] An encoding of an ephemeral Pallas public key </p></td>
444+
</tr>
445+
446+
<tr>
447+
<td>ciphertext</td>
448+
<td><a href="#bytes">bytes</a></td>
449+
<td></td>
450+
<td><p>[52] The note plaintext component of the encCiphertext field </p></td>
451+
</tr>
452+
453+
</tbody>
454+
</table>
455+
456+
457+
458+
459+
460+
<h3 id="cash.z.wallet.sdk.rpc.CompactSaplingOutput">CompactSaplingOutput</h3>
412461
<p>output is a Sapling Output Description as described in section 7.4 of the</p><p>Zcash protocol spec. Total size is 948.</p>
413462

414463

@@ -436,7 +485,7 @@ <h3 id="cash.z.wallet.sdk.rpc.CompactOutput">CompactOutput</h3>
436485
<td>ciphertext</td>
437486
<td><a href="#bytes">bytes</a></td>
438487
<td></td>
439-
<td><p>ciphertext and zkproof </p></td>
488+
<td><p>first 52 bytes of ciphertext </p></td>
440489
</tr>
441490

442491
</tbody>
@@ -446,8 +495,8 @@ <h3 id="cash.z.wallet.sdk.rpc.CompactOutput">CompactOutput</h3>
446495

447496

448497

449-
<h3 id="cash.z.wallet.sdk.rpc.CompactSpend">CompactSpend</h3>
450-
<p>CompactSpend is a Sapling Spend Description as described in 7.3 of the Zcash</p><p>protocol specification.</p>
498+
<h3 id="cash.z.wallet.sdk.rpc.CompactSaplingSpend">CompactSaplingSpend</h3>
499+
<p>CompactSaplingSpend is a Sapling Spend Description as described in 7.3 of the Zcash</p><p>protocol specification.</p>
451500

452501

453502
<table class="field-table">
@@ -507,18 +556,25 @@ <h3 id="cash.z.wallet.sdk.rpc.CompactTx">CompactTx</h3>
507556

508557
<tr>
509558
<td>spends</td>
510-
<td><a href="#cash.z.wallet.sdk.rpc.CompactSpend">CompactSpend</a></td>
559+
<td><a href="#cash.z.wallet.sdk.rpc.CompactSaplingSpend">CompactSaplingSpend</a></td>
511560
<td>repeated</td>
512561
<td><p>inputs </p></td>
513562
</tr>
514563

515564
<tr>
516565
<td>outputs</td>
517-
<td><a href="#cash.z.wallet.sdk.rpc.CompactOutput">CompactOutput</a></td>
566+
<td><a href="#cash.z.wallet.sdk.rpc.CompactSaplingOutput">CompactSaplingOutput</a></td>
518567
<td>repeated</td>
519568
<td><p>outputs </p></td>
520569
</tr>
521570

571+
<tr>
572+
<td>actions</td>
573+
<td><a href="#cash.z.wallet.sdk.rpc.CompactOrchardAction">CompactOrchardAction</a></td>
574+
<td>repeated</td>
575+
<td><p> </p></td>
576+
</tr>
577+
522578
</tbody>
523579
</table>
524580

@@ -836,6 +892,21 @@ <h3 id="cash.z.wallet.sdk.rpc.DarksideStreamer">DarksideStreamer</h3>
836892
<td><p>Clear the incoming transaction pool.</p></td>
837893
</tr>
838894

895+
<tr>
896+
<td>AddAddressUtxo</td>
897+
<td><a href="#cash.z.wallet.sdk.rpc.GetAddressUtxosReply">GetAddressUtxosReply</a></td>
898+
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
899+
<td><p>Add a GetAddressUtxosReply entry to be returned by GetAddressUtxos().
900+
There is no staging or applying for these, very simple.</p></td>
901+
</tr>
902+
903+
<tr>
904+
<td>ClearAddressUtxo</td>
905+
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
906+
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
907+
<td><p>Clear the list of GetAddressUtxos entries (can&#39;t fail)</p></td>
908+
</tr>
909+
839910
</tbody>
840911
</table>
841912

@@ -1045,7 +1116,7 @@ <h3 id="cash.z.wallet.sdk.rpc.Exclude">Exclude</h3>
10451116

10461117

10471118
<h3 id="cash.z.wallet.sdk.rpc.GetAddressUtxosArg">GetAddressUtxosArg</h3>
1048-
<p></p>
1119+
<p>Results are sorted by height, which makes it easy to issue another</p><p>request that picks up from where the previous left off.</p>
10491120

10501121

10511122
<table class="field-table">
@@ -1055,9 +1126,9 @@ <h3 id="cash.z.wallet.sdk.rpc.GetAddressUtxosArg">GetAddressUtxosArg</h3>
10551126
<tbody>
10561127

10571128
<tr>
1058-
<td>address</td>
1129+
<td>addresses</td>
10591130
<td><a href="#string">string</a></td>
1060-
<td></td>
1131+
<td>repeated</td>
10611132
<td><p> </p></td>
10621133
</tr>
10631134

@@ -1092,6 +1163,13 @@ <h3 id="cash.z.wallet.sdk.rpc.GetAddressUtxosReply">GetAddressUtxosReply</h3>
10921163
</thead>
10931164
<tbody>
10941165

1166+
<tr>
1167+
<td>address</td>
1168+
<td><a href="#string">string</a></td>
1169+
<td></td>
1170+
<td><p> </p></td>
1171+
</tr>
1172+
10951173
<tr>
10961174
<td>txid</td>
10971175
<td><a href="#bytes">bytes</a></td>
@@ -1305,7 +1383,7 @@ <h3 id="cash.z.wallet.sdk.rpc.PingResponse">PingResponse</h3>
13051383

13061384

13071385
<h3 id="cash.z.wallet.sdk.rpc.RawTransaction">RawTransaction</h3>
1308-
<p>RawTransaction contains the complete transaction data. It also optionally includes </p><p>the block height in which the transaction was included.</p>
1386+
<p>RawTransaction contains the complete transaction data. It also optionally includes </p><p>the block height in which the transaction was included, or, when returned</p><p>by GetMempoolStream(), the latest block height.</p>
13091387

13101388

13111389
<table class="field-table">
@@ -1572,6 +1650,14 @@ <h3 id="cash.z.wallet.sdk.rpc.CompactTxStreamer">CompactTxStreamer</h3>
15721650
in the exclude list that don&#39;t exist in the mempool are ignored.</p></td>
15731651
</tr>
15741652

1653+
<tr>
1654+
<td>GetMempoolStream</td>
1655+
<td><a href="#cash.z.wallet.sdk.rpc.Empty">Empty</a></td>
1656+
<td><a href="#cash.z.wallet.sdk.rpc.RawTransaction">RawTransaction</a> stream</td>
1657+
<td><p>Return a stream of current Mempool transactions. This will keep the output stream open while
1658+
there are mempool transactions. It will close the returned stream when a new block is mined.</p></td>
1659+
</tr>
1660+
15751661
<tr>
15761662
<td>GetTreeState</td>
15771663
<td><a href="#cash.z.wallet.sdk.rpc.BlockID">BlockID</a></td>
@@ -1607,7 +1693,7 @@ <h3 id="cash.z.wallet.sdk.rpc.CompactTxStreamer">CompactTxStreamer</h3>
16071693
<td>Ping</td>
16081694
<td><a href="#cash.z.wallet.sdk.rpc.Duration">Duration</a></td>
16091695
<td><a href="#cash.z.wallet.sdk.rpc.PingResponse">PingResponse</a></td>
1610-
<td><p>Testing-only</p></td>
1696+
<td><p>Testing-only, requires lightwalletd --ping-very-insecure (do not enable in production)</p></td>
16111697
</tr>
16121698

16131699
</tbody>

0 commit comments

Comments
 (0)