From 68789356fb1a75f62735a529b38389ef08ea7582 Mon Sep 17 00:00:00 2001 From: Larry Ruane Date: Tue, 19 Apr 2022 12:29:24 -0600 Subject: [PATCH] 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 --- docs/rtd/index.html | 112 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 99 insertions(+), 13 deletions(-) diff --git a/docs/rtd/index.html b/docs/rtd/index.html index 6070357..dc6f8b9 100644 --- a/docs/rtd/index.html +++ b/docs/rtd/index.html @@ -183,11 +183,15 @@
  • - MCompactOutput + MCompactOrchardAction
  • - MCompactSpend + MCompactSaplingOutput +
    • + +
  • + MCompactSaplingSpend
  • @@ -408,7 +412,52 @@ -

    CompactOutput

    +

    CompactOrchardAction

    +

    https://github.com/zcash/zips/blob/main/zip-0225.rst#orchard-action-description-orchardaction

    (but not all fields are needed)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeLabelDescription
    nullifierbytes

    [32] The nullifier of the input note

    cmxbytes

    [32] The x-coordinate of the note commitment for the output note

    ephemeralKeybytes

    [32] An encoding of an ephemeral Pallas public key

    ciphertextbytes

    [52] The note plaintext component of the encCiphertext field

    + + + + + +

    CompactSaplingOutput

    output is a Sapling Output Description as described in section 7.4 of the

    Zcash protocol spec. Total size is 948.

    @@ -436,7 +485,7 @@ ciphertext bytes -

    ciphertext and zkproof

    +

    first 52 bytes of ciphertext

    @@ -446,8 +495,8 @@ -

    CompactSpend

    -

    CompactSpend is a Sapling Spend Description as described in 7.3 of the Zcash

    protocol specification.

    +

    CompactSaplingSpend

    +

    CompactSaplingSpend is a Sapling Spend Description as described in 7.3 of the Zcash

    protocol specification.

    @@ -507,18 +556,25 @@ in a pure-Sapling context, the fee will be calculable as: - + - + + + + + + + +
    spendsCompactSpendCompactSaplingSpend repeated

    inputs

    outputsCompactOutputCompactSaplingOutput repeated

    outputs

    actionsCompactOrchardActionrepeated
    @@ -836,6 +892,21 @@ into a specified block on the next ApplyStaged().

    Clear the incoming transaction pool.

    + + AddAddressUtxo + GetAddressUtxosReply + Empty +

    Add a GetAddressUtxosReply entry to be returned by GetAddressUtxos(). +There is no staging or applying for these, very simple.

    + + + + ClearAddressUtxo + Empty + Empty +

    Clear the list of GetAddressUtxos entries (can't fail)

    + + @@ -1045,7 +1116,7 @@ into a specified block on the next ApplyStaged().

    GetAddressUtxosArg

    -

    +

    Results are sorted by height, which makes it easy to issue another

    request that picks up from where the previous left off.

    @@ -1055,9 +1126,9 @@ into a specified block on the next ApplyStaged().

    - + - + @@ -1092,6 +1163,13 @@ into a specified block on the next ApplyStaged().

    + + + + + + + @@ -1305,7 +1383,7 @@ into a specified block on the next ApplyStaged().

    RawTransaction

    -

    RawTransaction contains the complete transaction data. It also optionally includes

    the block height in which the transaction was included.

    +

    RawTransaction contains the complete transaction data. It also optionally includes

    the block height in which the transaction was included, or, when returned

    by GetMempoolStream(), the latest block height.

    addressaddresses stringrepeated

    addressstring

    txid bytes
    @@ -1572,6 +1650,14 @@ match a shortened txid, they are all sent (none is excluded). Transactions in the exclude list that don't exist in the mempool are ignored.

    + + + + + + + @@ -1607,7 +1693,7 @@ The block can be specified by either height or hash.

    - +
    GetMempoolStreamEmptyRawTransaction stream

    Return a stream of current Mempool transactions. This will keep the output stream open while +there are mempool transactions. It will close the returned stream when a new block is mined.

    GetTreeState BlockID Ping Duration PingResponse

    Testing-only

    Testing-only, requires lightwalletd --ping-very-insecure (do not enable in production)