change(test): Create test harness for calling getblocktemplate in proposal mode, but don't use it yet

zebra-chain/src/work/equihash.rs

@@ -59,6 +59,12 @@ impl Solution {
 
         Ok(())
     }
+
+    #[cfg(feature = "getblocktemplate-rpcs")]
+    /// Returns a [`Solution`] of `[0; SOLUTION_SIZE]` to be used in block proposals.
+    pub fn for_proposal() -> Self {
+        Self([0; SOLUTION_SIZE])
+    }
 }
 
 impl PartialEq<Solution> for Solution {

zebra-rpc/src/methods.rs

@@ -1193,7 +1193,7 @@ pub enum GetBlock {
 ///
 /// Also see the notes for the [`Rpc::get_best_block_hash`] and `get_block_hash` methods.
 #[derive(Copy, Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
-pub struct GetBlockHash(#[serde(with = "hex")] block::Hash);
+pub struct GetBlockHash(#[serde(with = "hex")] pub block::Hash);
 
 /// Response to a `z_gettreestate` RPC request.
 ///

zebra-rpc/src/methods/get_block_template_rpcs.rs

@@ -27,7 +27,7 @@ use crate::methods::{
         },
         get_block_template::{
             check_miner_address, check_synced_to_tip, fetch_mempool_transactions,
-            fetch_state_tip_and_local_time, generate_coinbase_and_roots, validate_block_proposal,
+            fetch_state_tip_and_local_time, validate_block_proposal,
         },
         types::{
             get_block_template::GetBlockTemplate, get_mining_info, hex_data::HexData,
@@ -566,24 +566,12 @@ where
 
             // - After this point, the template only depends on the previously fetched data.
 
-            // Generate the coinbase transaction and default roots
-            //
-            // TODO: move expensive root, hash, and tree cryptography to a rayon thread?
-            let (coinbase_txn, default_roots) = generate_coinbase_and_roots(
+            let response = GetBlockTemplate::new(
                 network,
-                next_block_height,
                 miner_address,
-                &mempool_txs,
-                chain_tip_and_local_time.history_tree.clone(),
-                COINBASE_LIKE_ZCASHD,
-            );
-
-            let response = GetBlockTemplate::new(
                 &chain_tip_and_local_time,
                 server_long_poll_id,
-                coinbase_txn,
-                &mempool_txs,
-                default_roots,
+                mempool_txs,
                 submit_old,
                 COINBASE_LIKE_ZCASHD,
             );

zebra-rpc/src/methods/get_block_template_rpcs/get_block_template.rs

@@ -108,7 +108,7 @@ where
         + Sync
         + 'static,
 {
-    let Ok(block) = block_proposal_bytes.zcash_deserialize_into() else {
+    let Ok(block) = block_proposal_bytes.zcash_deserialize_into::<block::Block>() else {
          return Ok(ProposalRejectReason::Rejected.into())
     };
 
@@ -125,7 +125,14 @@ where
 
     Ok(chain_verifier_response
         .map(|_hash| ProposalResponse::Valid)
-        .unwrap_or_else(|_| ProposalRejectReason::Rejected.into())
+        .unwrap_or_else(|verify_chain_error| {
+            tracing::info!(
+                verify_chain_error,
+                "Got error response from chain_verifier CheckProposal request"
+            );
+
+            ProposalRejectReason::Rejected.into()
+        })
         .into())
 }
 

zebra-rpc/src/methods/get_block_template_rpcs/types/get_block_template.rs

@@ -1,10 +1,13 @@
-//! The `GetBlockTempate` type is the output of the `getblocktemplate` RPC method.
+//! The `GetBlockTempate` type is the output of the `getblocktemplate` RPC method in the
+//! default 'template' mode. See [`ProposalResponse`] for the output in 'proposal' mode.
 
 use zebra_chain::{
     amount,
     block::{ChainHistoryBlockTxAuthCommitmentHash, MAX_BLOCK_BYTES, ZCASH_BLOCK_VERSION},
+    parameters::Network,
     serialization::DateTime32,
     transaction::VerifiedUnminedTx,
+    transparent,
     work::difficulty::{CompactDifficulty, ExpandedDifficulty},
 };
 use zebra_consensus::MAX_BLOCK_SIGOPS;
@@ -16,6 +19,7 @@ use crate::methods::{
             GET_BLOCK_TEMPLATE_CAPABILITIES_FIELD, GET_BLOCK_TEMPLATE_MUTABLE_FIELD,
             GET_BLOCK_TEMPLATE_NONCE_RANGE_FIELD,
         },
+        get_block_template::generate_coinbase_and_roots,
         types::{
             default_roots::DefaultRoots, long_poll::LongPollId, transaction::TransactionTemplate,
         },
@@ -24,8 +28,10 @@ use crate::methods::{
 };
 
 pub mod parameters;
+pub mod proposal;
 
 pub use parameters::*;
+pub use proposal::*;
 
 /// A serialized `getblocktemplate` RPC response in template mode.
 #[derive(Clone, Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize)]
@@ -177,11 +183,11 @@ impl GetBlockTemplate {
     /// If `like_zcashd` is true, try to match the coinbase transactions generated by `zcashd`
     /// in the `getblocktemplate` RPC.
     pub fn new(
+        network: Network,
+        miner_address: transparent::Address,
         chain_tip_and_local_time: &GetBlockTemplateChainInfo,
         long_poll_id: LongPollId,
-        coinbase_txn: TransactionTemplate<amount::NegativeOrZero>,
-        mempool_txs: &[VerifiedUnminedTx],
-        default_roots: DefaultRoots,
+        mempool_txs: Vec<VerifiedUnminedTx>,
         submit_old: Option<bool>,
         like_zcashd: bool,
     ) -> Self {
@@ -190,20 +196,41 @@ impl GetBlockTemplate {
             (chain_tip_and_local_time.tip_height + 1).expect("tip is far below Height::MAX");
 
         // Convert transactions into TransactionTemplates
-        let mut mempool_txs: Vec<TransactionTemplate<amount::NonNegative>> =
-            mempool_txs.iter().map(Into::into).collect();
+        let mut mempool_txs_with_templates: Vec<(
+            TransactionTemplate<amount::NonNegative>,
+            VerifiedUnminedTx,
+        )> = mempool_txs
+            .into_iter()
+            .map(|tx| ((&tx).into(), tx))
+            .collect();
 
         // Transaction selection returns transactions in an arbitrary order,
         // but Zebra's snapshot tests expect the same order every time.
         if like_zcashd {
             // Sort in serialized data order, excluding the length byte.
             // `zcashd` sometimes seems to do this, but other times the order is arbitrary.
-            mempool_txs.sort_by_key(|tx| tx.data.clone());
+            mempool_txs_with_templates.sort_by_key(|(tx_template, _tx)| tx_template.data.clone());
         } else {
             // Sort by hash, this is faster.
-            mempool_txs.sort_by_key(|tx| tx.hash.bytes_in_display_order());
+            mempool_txs_with_templates
+                .sort_by_key(|(tx_template, _tx)| tx_template.hash.bytes_in_display_order());
         }
 
+        let (mempool_tx_templates, mempool_txs): (Vec<_>, Vec<_>) =
+            mempool_txs_with_templates.into_iter().unzip();
+
+        // Generate the coinbase transaction and default roots
+        //
+        // TODO: move expensive root, hash, and tree cryptography to a rayon thread?
+        let (coinbase_txn, default_roots) = generate_coinbase_and_roots(
+            network,
+            next_block_height,
+            miner_address,
+            &mempool_txs,
+            chain_tip_and_local_time.history_tree.clone(),
+            like_zcashd,
+        );
+
         // Convert difficulty
         let target = chain_tip_and_local_time
             .expected_difficulty
@@ -228,7 +255,7 @@ impl GetBlockTemplate {
             final_sapling_root_hash: default_roots.block_commitments_hash,
             default_roots,
 
-            transactions: mempool_txs,
+            transactions: mempool_tx_templates,
 
             coinbase_txn,
 
@@ -259,33 +286,6 @@ impl GetBlockTemplate {
     }
 }
 
-/// Error response to a `getblocktemplate` RPC request in proposal mode.
-#[derive(Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
-#[serde(rename_all = "kebab-case")]
-pub enum ProposalRejectReason {
-    /// Block proposal rejected as invalid.
-    Rejected,
-}
-
-/// Response to a `getblocktemplate` RPC request in proposal mode.
-///
-/// See <https://en.bitcoin.it/wiki/BIP_0023#Block_Proposal>
-#[derive(Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
-#[serde(untagged, rename_all = "kebab-case")]
-pub enum ProposalResponse {
-    /// Block proposal was rejected as invalid, returns `reject-reason` and server `capabilities`.
-    ErrorResponse {
-        /// Reason the proposal was invalid as-is.
-        reject_reason: ProposalRejectReason,
-
-        /// The getblocktemplate RPC capabilities supported by Zebra.
-        capabilities: Vec<String>,
-    },
-
-    /// Block proposal was successfully validated, returns null.
-    Valid,
-}
-
 #[derive(Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
 #[serde(untagged)]
 /// A `getblocktemplate` RPC response.
@@ -296,30 +296,3 @@ pub enum Response {
     /// `getblocktemplate` RPC request in proposal mode.
     ProposalMode(ProposalResponse),
 }
-
-impl From<ProposalRejectReason> for ProposalResponse {
-    fn from(reject_reason: ProposalRejectReason) -> Self {
-        Self::ErrorResponse {
-            reject_reason,
-            capabilities: GetBlockTemplate::capabilities(),
-        }
-    }
-}
-
-impl From<ProposalRejectReason> for Response {
-    fn from(error_response: ProposalRejectReason) -> Self {
-        Self::ProposalMode(ProposalResponse::from(error_response))
-    }
-}
-
-impl From<ProposalResponse> for Response {
-    fn from(proposal_response: ProposalResponse) -> Self {
-        Self::ProposalMode(proposal_response)
-    }
-}
-
-impl From<GetBlockTemplate> for Response {
-    fn from(template: GetBlockTemplate) -> Self {
-        Self::TemplateMode(Box::new(template))
-    }
-}

zebra-rpc/src/methods/get_block_template_rpcs/types/get_block_template/proposal.rs

@@ -0,0 +1,59 @@
+//! `ProposalResponse` is the output of the `getblocktemplate` RPC method in 'proposal' mode.
+
+use super::{GetBlockTemplate, Response};
+
+/// Error response to a `getblocktemplate` RPC request in proposal mode.
+///
+/// See <https://en.bitcoin.it/wiki/BIP_0022#Appendix:_Example_Rejection_Reasons>
+#[derive(Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum ProposalRejectReason {
+    /// Block proposal rejected as invalid.
+    Rejected,
+}
+
+/// Response to a `getblocktemplate` RPC request in proposal mode.
+///
+/// See <https://en.bitcoin.it/wiki/BIP_0023#Block_Proposal>
+#[derive(Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[serde(untagged, rename_all = "kebab-case")]
+pub enum ProposalResponse {
+    /// Block proposal was rejected as invalid, returns `reject-reason` and server `capabilities`.
+    ErrorResponse {
+        /// Reason the proposal was invalid as-is.
+        reject_reason: ProposalRejectReason,
+
+        /// The getblocktemplate RPC capabilities supported by Zebra.
+        capabilities: Vec<String>,
+    },
+
+    /// Block proposal was successfully validated, returns null.
+    Valid,
+}
+
+impl From<ProposalRejectReason> for ProposalResponse {
+    fn from(reject_reason: ProposalRejectReason) -> Self {
+        Self::ErrorResponse {
+            reject_reason,
+            capabilities: GetBlockTemplate::capabilities(),
+        }
+    }
+}
+
+impl From<ProposalRejectReason> for Response {
+    fn from(error_response: ProposalRejectReason) -> Self {
+        Self::ProposalMode(ProposalResponse::from(error_response))
+    }
+}
+
+impl From<ProposalResponse> for Response {
+    fn from(proposal_response: ProposalResponse) -> Self {
+        Self::ProposalMode(proposal_response)
+    }
+}
+
+impl From<GetBlockTemplate> for Response {
+    fn from(template: GetBlockTemplate) -> Self {
+        Self::TemplateMode(Box::new(template))
+    }
+}

zebra-rpc/src/methods/get_block_template_rpcs/types/transaction.rs

@@ -16,7 +16,7 @@ where
 {
     /// The hex-encoded serialized data for this transaction.
     #[serde(with = "hex")]
-    pub(crate) data: SerializedTransaction,
+    pub data: SerializedTransaction,
 
     /// The transaction ID of this transaction.
     #[serde(with = "hex")]

zebrad/Cargo.toml

@@ -174,6 +174,7 @@ tonic-build = { version = "0.8.0", optional = true }
 [dev-dependencies]
 abscissa_core = { version = "0.5", features = ["testing"] }
 hex = "0.4.3"
+jsonrpc-core = "18.0.0"
 once_cell = "1.17.0"
 regex = "1.7.1"
 semver = "1.0.16"