Package cash.z.wallet.sdk.internal.rpc

Darksidewalletd maintains two staging areas, blocks and transactions. The
Stage*() gRPCs add items to the staging area; ApplyStaged() "applies" everything
in the staging area to the working (operational) state that the mock zcashd
serves; transactions are placed into their corresponding blocks (by height).

A block is a hex-encoded string.

DarksideBlocksURL is typically something like:
https://raw.githubusercontent.com/zcash-hackworks/darksidewalletd-test-data/master/basic-reorg/before-reorg.txt

DarksideTransactionsURL refers to an HTTP source that contains a list
of hex-encoded transactions, one per line, that are to be associated
with the given height (fake-mined into the block at that height)

ChainMetadata represents information about the state of the chain as of a given block.

CompactBlock is a packaging of ONLY the data from a block that's needed to:
1. Detect a payment to your shielded Sapling address
2. Detect a spend of your shielded Sapling notes
3. Update your witnesses to generate new Sapling spend proofs.

CompactTx contains the minimum information for a wallet to know if this transaction
is relevant to it (either pays to it or spends from it) via shielded elements
only. This message will not encode a transparent-to-transparent transaction.

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

output encodes the `cmu` field, `ephemeralKey` field, and a 52-byte prefix of the
`encCiphertext` field of a Sapling Output Description. These fields are described in
section 7.4 of the Zcash protocol spec:
https://zips.z.cash/protocol/protocol.pdf#outputencodingandconsensus
Total size is 116 bytes.

https://github.com/zcash/zips/blob/main/zip-0225.rst#orchard-action-description-orchardaction
(but not all fields are needed)

A BlockID message contains identifiers to select a block: a height or a
hash. Specification by hash is not implemented, but may be in the future.

BlockRange specifies a series of blocks from start to end inclusive.
Both BlockIDs must be heights; specification by hash is not yet supported.

A TxFilter contains the information needed to identify a particular
transaction: either a block and an index, or a direct transaction hash.
Currently, only specification by hash is supported.

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.

A SendResponse encodes an error code and a string. It is currently used
only by SendTransaction(). If error code is zero, the operation was
successful; if non-zero, it and the message specify the failure.

Chainspec is a placeholder to allow specification of a particular chain fork.

Empty is for gRPCs that take no arguments, currently only GetLightdInfo.

LightdInfo returns various information about this lightwalletd instance
and the state of the blockchain.

TransparentAddressBlockFilter restricts the results to the given address
or block range.

Duration is currently used only for testing, so that the Ping rpc
can simulate a delay, to create many simultaneous connections. Units
are microseconds.

PingResponse is used to indicate concurrency, how many Ping rpcs
are executing upon entry and upon exit (after the delay).
This rpc is used for testing only.

The TreeState is derived from the Zcash z_gettreestate rpc.

Results are sorted by height, which makes it easy to issue another
request that picks up from where the previous left off.

A BlockID message contains identifiers to select a block: a height or a
hash. Specification by hash is not implemented, but may be in the future.

BlockRange specifies a series of blocks from start to end inclusive.
Both BlockIDs must be heights; specification by hash is not yet supported.

ChainMetadata represents information about the state of the chain as of a given block.

Chainspec is a placeholder to allow specification of a particular chain fork.

CompactBlock is a packaging of ONLY the data from a block that's needed to:
1. Detect a payment to your shielded Sapling address
2. Detect a spend of your shielded Sapling notes
3. Update your witnesses to generate new Sapling spend proofs.

https://github.com/zcash/zips/blob/main/zip-0225.rst#orchard-action-description-orchardaction
(but not all fields are needed)

output encodes the `cmu` field, `ephemeralKey` field, and a 52-byte prefix of the
`encCiphertext` field of a Sapling Output Description. These fields are described in
section 7.4 of the Zcash protocol spec:
https://zips.z.cash/protocol/protocol.pdf#outputencodingandconsensus
Total size is 116 bytes.

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

CompactTx contains the minimum information for a wallet to know if this transaction
is relevant to it (either pays to it or spends from it) via shielded elements
only. This message will not encode a transparent-to-transparent transaction.

A block is a hex-encoded string.

DarksideBlocksURL is typically something like:
https://raw.githubusercontent.com/zcash-hackworks/darksidewalletd-test-data/master/basic-reorg/before-reorg.txt

DarksideTransactionsURL refers to an HTTP source that contains a list
of hex-encoded transactions, one per line, that are to be associated
with the given height (fake-mined into the block at that height)

Duration is currently used only for testing, so that the Ping rpc
can simulate a delay, to create many simultaneous connections. Units
are microseconds.

Empty is for gRPCs that take no arguments, currently only GetLightdInfo.

Results are sorted by height, which makes it easy to issue another
request that picks up from where the previous left off.

LightdInfo returns various information about this lightwalletd instance
and the state of the blockchain.

PingResponse is used to indicate concurrency, how many Ping rpcs
are executing upon entry and upon exit (after the delay).
This rpc is used for testing only.

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.

A SendResponse encodes an error code and a string. It is currently used
only by SendTransaction(). If error code is zero, the operation was
successful; if non-zero, it and the message specify the failure.

TransparentAddressBlockFilter restricts the results to the given address
or block range.

The TreeState is derived from the Zcash z_gettreestate rpc.

A TxFilter contains the information needed to identify a particular
transaction: either a block and an index, or a direct transaction hash.
Currently, only specification by hash is supported.