Updates snapshot test, adds mod docs, moves HexData to its own mod, a…

…nd removes the unrelated make_server_error refactor for now

zebra-rpc/src/lib.rs

@@ -5,8 +5,6 @@
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_rpc")]
 
 pub mod config;
-#[cfg(feature = "getblocktemplate-rpcs")]
-mod errors;
 pub mod methods;
 pub mod queue;
 pub mod server;

zebra-rpc/src/methods/get_block_template_rpcs.rs

@@ -17,15 +17,12 @@ use zebra_chain::{
 use zebra_consensus::{BlockError, VerifyBlockError, VerifyChainError, VerifyCheckpointError};
 use zebra_node_services::mempool;
 
-use crate::{
-    errors::make_server_error,
-    methods::{
-        get_block_template_rpcs::types::{
-            default_roots::DefaultRoots, get_block_template::GetBlockTemplate, submit_block,
-            transaction::TransactionTemplate,
-        },
-        GetBlockHash, MISSING_BLOCK_ERROR_CODE,
+use crate::methods::{
+    get_block_template_rpcs::types::{
+        default_roots::DefaultRoots, get_block_template::GetBlockTemplate, hex_data::HexData,
+        submit_block, transaction::TransactionTemplate,
     },
+    GetBlockHash, MISSING_BLOCK_ERROR_CODE,
 };
 
 pub mod config;
@@ -99,7 +96,7 @@ pub trait GetBlockTemplateRpc {
     #[rpc(name = "submitblock")]
     fn submit_block(
         &self,
-        hex_data: submit_block::HexData,
+        hex_data: HexData,
         _options: Option<submit_block::JsonParameters>,
     ) -> BoxFuture<Result<submit_block::Response>>;
 }
@@ -354,7 +351,7 @@ where
 
     fn submit_block(
         &self,
-        submit_block::HexData(block_bytes): submit_block::HexData,
+        HexData(block_bytes): HexData,
         _options: Option<submit_block::JsonParameters>,
     ) -> BoxFuture<Result<submit_block::Response>> {
         let mut chain_verifier = self.chain_verifier.clone();
@@ -368,7 +365,11 @@ where
             let chain_verifier_response = chain_verifier
                 .ready()
                 .await
-                .map_err(make_server_error)?
+                .map_err(|error| Error {
+                    code: ErrorCode::ServerError(0),
+                    message: error.to_string(),
+                    data: None,
+                })?
                 .call(Arc::new(block))
                 .await;
 

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

@@ -2,5 +2,6 @@
 
 pub(crate) mod default_roots;
 pub(crate) mod get_block_template;
+pub(crate) mod hex_data;
 pub(crate) mod submit_block;
 pub(crate) mod transaction;

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

@@ -0,0 +1,6 @@
+//! Deserializes hex-encoded inputs such as the one required
+//! for the `submitblock` RPC method.
+
+/// Deserialize hex-encoded strings to bytes.
+#[derive(Debug, PartialEq, Eq, serde::Deserialize)]
+pub struct HexData(#[serde(with = "hex")] pub Vec<u8>);

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

@@ -45,5 +45,3 @@ impl From<ErrorResponse> for Response {
         Self::ErrorResponse(error_response)
     }
 }
-#[derive(Debug, PartialEq, Eq, serde::Deserialize)]
-pub struct HexData(#[serde(with = "hex")] pub Vec<u8>);

zebra-rpc/src/methods/tests/snapshot/get_block_template_rpcs.rs

@@ -15,8 +15,8 @@ use zebra_state::LatestChainTip;
 use zebra_test::mock_service::{MockService, PanicAssertion};
 
 use crate::methods::{
-    get_block_template_rpcs::types::submit_block, GetBlockHash, GetBlockTemplateRpc,
-    GetBlockTemplateRpcImpl,
+    get_block_template_rpcs::types::{hex_data::HexData, submit_block},
+    GetBlockHash, GetBlockTemplateRpc, GetBlockTemplateRpcImpl,
 };
 
 pub async fn test_responses<State, ReadState>(
@@ -103,8 +103,10 @@ pub async fn test_responses<State, ReadState>(
 
     // `submitblock`
     let submit_block = get_block_template_rpc
-        .submit_block(submit_block::HexData("".into()), None)
-        .await;
+        .submit_block(HexData("".into()), None)
+        .await
+        .expect("unexpected error in submitblock RPC call");
+
     snapshot_rpc_submit_block_invalid(submit_block, &settings);
 }
 
@@ -128,7 +130,7 @@ fn snapshot_rpc_getblocktemplate(
 
 /// Snapshot `submitblock` response, using `cargo insta` and JSON serialization.
 fn snapshot_rpc_submit_block_invalid(
-    submit_block_response: jsonrpc_core::Result<submit_block::Response>,
+    submit_block_response: submit_block::Response,
     settings: &insta::Settings,
 ) {
     settings.bind(|| {

zebra-rpc/src/methods/tests/snapshot/snapshots/snapshot_rpc_submit_block_invalid@mainnet_10.snap

@@ -2,6 +2,4 @@
 source: zebra-rpc/src/methods/tests/snapshot/get_block_template_rpcs.rs
 expression: submit_block_response
 ---
-{
-  "Ok": "rejected"
-}
+"rejected"

zebra-rpc/src/methods/tests/snapshot/snapshots/snapshot_rpc_submit_block_invalid@testnet_10.snap

@@ -2,6 +2,4 @@
 source: zebra-rpc/src/methods/tests/snapshot/get_block_template_rpcs.rs
 expression: submit_block_response
 ---
-{
-  "Ok": "rejected"
-}
+"rejected"

zebra-rpc/src/methods/tests/vectors.rs

@@ -890,7 +890,7 @@ async fn rpc_submitblock_errors() {
     for (_height, &block_bytes) in zebra_test::vectors::CONTINUOUS_MAINNET_BLOCKS.iter() {
         let submit_block_response = get_block_template_rpc
             .submit_block(
-                get_block_template_rpcs::types::submit_block::HexData(block_bytes.into()),
+                get_block_template_rpcs::types::hex_data::HexData(block_bytes.into()),
                 None,
             )
             .await;
@@ -903,7 +903,7 @@ async fn rpc_submitblock_errors() {
 
     let submit_block_response = get_block_template_rpc
         .submit_block(
-            get_block_template_rpcs::types::submit_block::HexData(
+            get_block_template_rpcs::types::hex_data::HexData(
                 zebra_test::vectors::BAD_BLOCK_MAINNET_202_BYTES.to_vec(),
             ),
             None,

zebrad/tests/common/get_block_template_rpcs.rs

@@ -1,3 +1,5 @@
+//! Acceptance tests for getblocktemplate RPC methods in Zebra.
+
 use super::*;
 
 pub(crate) mod submit_block;

zebrad/tests/common/get_block_template_rpcs/submit_block.rs

@@ -1,3 +1,13 @@
+//! Test submitblock RPC method.
+//!
+//! This test requires a cached chain state that is partially synchronized close to the
+//! network chain tip height, and will finish the sync and update the cached chain state.
+//!
+//! After finishing the sync, it will get the first 20 blocks in the non-finalized state
+//! (past the MAX_BLOCK_REORG_HEIGHT) via getblock rpc calls, get the finalized tip height
+//! of the updated cached state, restart zebra without peers, and submit blocks above the
+//! finalized tip height.
+
 use std::path::PathBuf;
 
 use color_eyre::eyre::{eyre, Context, Result};