Module methods

Zebra supported RPC methods.

Based on the zcashd RPC methods as used by lightwalletd.

Some parts of the zcashd RPC documentation are outdated. So this implementation follows the zcashd server and lightwalletd client implementations.

Re-exports

pub use get_block_template_rpcs::GetBlockTemplateRpcImpl;

pub use get_block_template_rpcs::GetBlockTemplateRpcServer;

Modules

get_block_template_rpcs

Mining-related RPCs.

hex_data

Deserializes hex-encoded inputs such as the one required for the submitblock RPC method.

opthex 🔒

A helper module to serialize Option<T: ToHex> as a hex string.

trees

Types and functions for note commitment tree RPCs.

types

Types used in RPC methods.

Structs

AddressBalance

The transparent balance of a set of addresses.

AddressStrings

A wrapper type with a list of transparent address strings.

ConsensusBranchIdHex

A hex-encoded ConsensusBranchId string.

GetAddressTxIdsRequest

A struct to use as parameter of the getaddresstxids.

GetAddressUtxos

Response to a getaddressutxos RPC request.

GetBlockChainInfo

Response to a getblockchaininfo RPC request.

GetBlockHash

Response to a getbestblockhash and getblockhash RPC request.

GetBlockHeaderObject

Verbose response to a getblockheader RPC request.

GetBlockHeightAndHash

Response to a getbestblockheightandhash RPC request.

GetBlockTrees

Information about the sapling and orchard note commitment trees if any.

GetInfo

Response to a getinfo RPC request.

NetworkUpgradeInfo

Information about NetworkUpgrade activation.

OrchardTrees

Orchard note commitment tree information.

RpcImpl

RPC method implementations.

SaplingTrees

Sapling note commitment tree information.

SentTransactionHash

Response to a sendrawtransaction RPC request.

TipConsensusBranch

The ConsensusBranchIds for the tip and the next block.

Enums

GetBlock

Response to a getblock RPC request.

GetBlockHeader

Response to a getblockheader RPC request.

GetBlockTransaction

The transaction list in a getblock call. Can be a list of transaction IDs or the full transaction details depending on verbosity.

GetRawTransaction

Response to a getrawtransaction RPC request.

NetworkUpgradeStatus

The activation status of a NetworkUpgrade.

Traits

RpcServer

Server trait implementation for the Rpc RPC API.

Functions

best_chain_tip_height

Returns the best chain tip height of latest_chain_tip, or an RPC error if there are no blocks in the state.

build_height_range 🔒

Build a valid height range from the given optional start and end numbers.

chain_tip_difficulty

Returns the proof-of-work difficulty as a multiple of the minimum difficulty.

height_from_signed_int

Given a potentially negative index, find the corresponding Height.

Type Aliases

LoggedLastEvent

A type alias for the last event logged by the server.