Struct BlockTemplateResponse

pub struct BlockTemplateResponse { /* private fields */ }

A serialized getblocktemplate RPC response in template mode.

This is the output of the getblocktemplate RPC in the default ‘template’ mode. See BlockProposalResponse for the output in ‘proposal’ mode.

Implementations

impl BlockTemplateResponse

Auto-generated by derive_getters::Getters.

pub fn capabilities(&self) -> &Vec<String>

The getblocktemplate RPC capabilities supported by Zebra.

At the moment, Zebra does not support any of the extra capabilities from the specification:

• proposal: https://en.bitcoin.it/wiki/BIP_0023#Block_Proposal
• longpoll: https://en.bitcoin.it/wiki/BIP_0022#Optional:_Long_Polling
• serverlist: https://en.bitcoin.it/wiki/BIP_0023#Logical_Services

By the above, Zebra will always return an empty vector here.

pub fn version(&self) -> u32

The version of the block format. Always 4 for new Zcash blocks.

pub fn previous_block_hash(&self) -> Hash

The hash of the previous block.

pub fn block_commitments_hash(&self) -> ChainHistoryBlockTxAuthCommitmentHash

The block commitment for the new block’s header.

Same as [DefaultRoots.block_commitments_hash], see that field for details.

pub fn light_client_root_hash(&self) -> ChainHistoryBlockTxAuthCommitmentHash

Legacy backwards-compatibility header root field.

Same as [DefaultRoots.block_commitments_hash], see that field for details.

pub fn final_sapling_root_hash(&self) -> ChainHistoryBlockTxAuthCommitmentHash

Legacy backwards-compatibility header root field.

Same as [DefaultRoots.block_commitments_hash], see that field for details.

pub fn default_roots(&self) -> &DefaultRoots

The block header roots for [GetBlockTemplate.transactions].

If the transactions in the block template are modified, these roots must be recalculated according to the specification.

pub fn transactions(&self) -> &Vec<TransactionTemplate<NonNegative>>

The non-coinbase transactions selected for this block template.

pub fn coinbase_txn(&self) -> &TransactionTemplate<NegativeOrZero>

The coinbase transaction generated from transactions and height.

pub fn long_poll_id(&self) -> LongPollId

An ID that represents the chain tip and mempool contents for this template.

pub fn target(&self) -> ExpandedDifficulty

The expected difficulty for the new block displayed in expanded form.

pub fn min_time(&self) -> DateTime32

For each block other than the genesis block, nTime MUST be strictly greater than the median-time-past of that block.

https://zips.z.cash/protocol/protocol.pdf#blockheader

pub fn mutable(&self) -> &Vec<String>

Hardcoded list of block fields the miner is allowed to change.

pub fn nonce_range(&self) -> &String

A range of valid nonces that goes from u32::MIN to u32::MAX.

pub fn sigop_limit(&self) -> u64

Max legacy signature operations in the block.

pub fn size_limit(&self) -> u64

Max block size in bytes

pub fn cur_time(&self) -> DateTime32

the current time as seen by the server (recommended for block time). note this is not necessarily the system clock, and must fall within the mintime/maxtime rules

https://en.bitcoin.it/wiki/BIP_0022#Block_Template_Request

pub fn bits(&self) -> CompactDifficulty

The expected difficulty for the new block displayed in compact form.

pub fn height(&self) -> u32

The height of the next block in the best chain.

pub fn max_time(&self) -> DateTime32

the maximum time allowed

https://en.bitcoin.it/wiki/BIP_0023#Mutations

Zebra adjusts the minimum and current times for testnet minimum difficulty blocks, so we need to tell miners what the maximum valid time is.

This field is not in zcashd or the Zcash RPC reference yet.

Currently, some miners just use min_time or cur_time. Others calculate max_time from the fixed 90 minute consensus rule, or a smaller fixed interval (like 1000s). Some miners don’t check the maximum time. This can cause invalid blocks after network downtime, a significant drop in the hash rate, or after the testnet minimum difficulty interval.

pub fn submit_old(&self) -> Option<bool>

only relevant for long poll responses: indicates if work received prior to this response remains potentially valid (default) and should have its shares submitted; if false, the miner may wish to discard its share queue

https://en.bitcoin.it/wiki/BIP_0022#Optional:_Long_Polling

This field is not in zcashd or the Zcash RPC reference yet.

In Zebra, submit_old is false when the tip block changed or max time is reached, and true if only the mempool transactions have changed.

impl BlockTemplateResponse

pub fn new( capabilities: Vec<String>, version: u32, previous_block_hash: Hash, block_commitments_hash: ChainHistoryBlockTxAuthCommitmentHash, light_client_root_hash: ChainHistoryBlockTxAuthCommitmentHash, final_sapling_root_hash: ChainHistoryBlockTxAuthCommitmentHash, default_roots: DefaultRoots, transactions: Vec<TransactionTemplate<NonNegative>>, coinbase_txn: TransactionTemplate<NegativeOrZero>, long_poll_id: LongPollId, target: ExpandedDifficulty, min_time: DateTime32, mutable: Vec<String>, nonce_range: String, sigop_limit: u64, size_limit: u64, cur_time: DateTime32, bits: CompactDifficulty, height: u32, max_time: DateTime32, submit_old: Option<bool>, ) -> Self

Constructs a new BlockTemplateResponse.

impl BlockTemplateResponse

pub fn all_capabilities() -> Vec<String>

Returns a Vec of capabilities supported by the getblocktemplate RPC

Trait Implementations

impl Clone for BlockTemplateResponse

fn clone(&self) -> BlockTemplateResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BlockTemplateResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockTemplateResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BlockTemplateResponse> for GetBlockTemplateResponse

fn from(template: BlockTemplateResponse) -> Self

Converts to this type from the input type.

impl PartialEq for BlockTemplateResponse

fn eq(&self, other: &BlockTemplateResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BlockTemplateResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BlockTemplateResponse

impl StructuralPartialEq for BlockTemplateResponse