Expand description
A tonic gRPC server that implements the lightwalletd CompactTxStreamer client API.
The interface is defined by the zcash/lightwalletd proto files, so Zcash light
clients that normally connect to a lightwalletd instance can connect directly to
Zebra instead.
Modules§
- compact_
tx_ streamer_ client - Generated client implementations.
- compact_
tx_ streamer_ server - Generated server implementations.
- methods
- Implements
CompactTxStreamermethods on theLightwalletdRPCtype. - server
- A tonic gRPC server for the lightwalletd
CompactTxStreamerclient API. - tracing
- Request tracing for the lightwalletd gRPC server.
- wire 🔒
Structs§
- Address
- Address
List - Balance
- BlockId
- 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.
- Block
Range - BlockRange specifies a series of blocks from start to end inclusive. Both BlockIDs must be heights; specification by hash is not yet supported.
- Chain
Metadata - Information about the state of the chain as of a given block.
- Chain
Spec - Chainspec is a placeholder to allow specification of a particular chain fork.
- Compact
Block - A compact representation of the shielded data in a Zcash block.
- Compact
Orchard Action - A compact representation of an Orchard Action.
- Compact
Sapling Output - A compact representation of a Sapling Output.
- Compact
Sapling Spend - A compact representation of a Sapling Spend.
- Compact
Tx - A compact representation of the shielded data in a Zcash transaction.
- Duration
- 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
- Empty is for gRPCs that take no arguments, currently only GetLightdInfo.
- Exclude
- The a shortened transaction ID is the prefix in big-endian (hex) format (then converted to binary).
- GetAddress
Utxos Arg - Results are sorted by height, which makes it easy to issue another request that picks up from where the previous left off.
- GetAddress
Utxos Reply - GetAddress
Utxos Reply List - GetSubtree
Roots Arg - Lightd
Info - LightdInfo returns various information about this lightwalletd instance and the state of the blockchain.
- Ping
Response - 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
- 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.
- Send
Response - 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.
- Subtree
Root - Transparent
Address Block Filter - TransparentAddressBlockFilter restricts the results to the given address or block range.
- Tree
State - The TreeState is derived from the Zcash z_gettreestate rpc.
- TxFilter
- 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.
Enums§
Constants§
- COMPACT_
CIPHERTEXT_ 🔒SIZE - The number of bytes of an encrypted note ciphertext included in compact
outputs and actions, from the
compact_formats.protospecification. - FILE_
DESCRIPTOR_ 🔒SET
Functions§
- compact_
action 🔒 - Builds a
CompactOrchardActionfrom an Orchard-encoded action. - has_
compact_ 🔒data - Returns true if the transaction contains any data that belongs in a
CompactTx: Sapling spends or outputs, or Orchard or Ironwood actions. - has_
nullifiers 🔒 - Returns true if the transaction contains any nullifiers, so it belongs in a
nullifiers-only
CompactBlock.