rpc_api.md

Zaino RPC APIs

Zaino's Final RPC API is currently unfinalised and will be completed in this GitHub Issue.

Lightwallet gRPC Services

Zaino Currently Serves the following gRPC services as defined in the LightWallet Protocol:

• GetLatestBlock (ChainSpec) returns (BlockID)
• GetBlock (BlockID) returns (CompactBlock)
• GetBlockNullifiers (BlockID) returns (CompactBlock)
• GetBlockRange (BlockRange) returns (stream CompactBlock)
• GetBlockRangeNullifiers (BlockRange) returns (stream CompactBlock)
• GetTransaction (TxFilter) returns (RawTransaction)
• SendTransaction (RawTransaction) returns (SendResponse)
• GetTaddressTxids (TransparentAddressBlockFilter) returns (stream RawTransaction)
• GetTaddressBalance (AddressList) returns (Balance)
• GetTaddressBalanceStream (stream Address) returns (Balance) (MARKED FOR DEPRECATION)
• GetMempoolTx (Exclude) returns (stream CompactTx)
• GetMempoolStream (Empty) returns (stream RawTransaction)
• GetTreeState (BlockID) returns (TreeState)
• GetLatestTreeState (Empty) returns (TreeState)
• GetSubtreeRoots (GetSubtreeRootsArg) returns (stream SubtreeRoot)
• GetAddressUtxos (GetAddressUtxosArg) returns (GetAddressUtxosReplyList)
• GetAddressUtxosStream (GetAddressUtxosArg) returns (stream GetAddressUtxosReply)
• GetLightdInfo (Empty) returns (LightdInfo)
• Ping (Duration) returns (PingResponse) (CURRENTLY UNIMPLEMENTED)

Zcash RPC Services

Zaino has commited to taking over responsibility for serving the following Zcash RPCs from Zcashd:

• getaddressbalance
• getaddressdeltas
• getaddressmempool (MARKED FOR DEPRECATION)
• getaddresstxids
• getaddressutxos
• getbestblockhash (LOW PRIORITY. MARKED FOR POSSIBLE DEPRECATION)
• getblock
• getblockchaininfo
• getblockcount
• getblockdeltas
• getblockhash
• getblockhashes
• getblockheader
• getchaintips
• getdifficulty
• getmempoolinfo
• getrawmempool
• getspentinfo
• gettxout
• gettxoutproof (LOW PRIORITY. MARKED FOR POSSIBLE DEPRECATION)
• gettxoutsetinfo
• verifytxoutproof(LOW PRIORITY. MARKED FOR POSSIBLE DEPRECATION)
• z_gettreestate

Zaino will also provide wrapper functionality for the following RPCs in Zebra (to allow block explorers to fetch all data they require directly from / through Zaino):

• getinfo
• getmininginfo
• getnetworksolps
• getnetworkinfo
• getpeerinfo
• ping