Port "rpc: Fix deserialization of /block_results response when some t…

…x results are non-ok" (tendermint-rs#1391) (#24)

.changelog/unreleased/bug-fixes/1391-block-results-not-ok.md

@@ -0,0 +1,2 @@
+- `[cometbft-rpc]` Fix deserialization of `/block_results` response when some
+  tx results are non-ok ([\#18](https://github.com/cometbft/cometbft-rs/issues/18))

cometbft/src/abci/types.rs

@@ -203,27 +203,38 @@ pub struct ExecTxResult {
     /// This code should be `Ok` only if the transaction is fully valid. However,
     /// invalid transactions included in a block will still be executed against
     /// the application state.
+    #[serde(default)]
     pub code: Code,
+
     /// Result bytes, if any.
-    #[serde(with = "serializers::nullable")]
+    #[serde(default, with = "serializers::nullable")]
     pub data: Bytes,
+
     /// The output of the application's logger.
     ///
     /// **May be non-deterministic**.
+    #[serde(default)]
     pub log: String,
+
     /// Additional information.
     ///
     /// **May be non-deterministic**.
+    #[serde(default)]
     pub info: String,
     /// Amount of gas requested for the transaction.
-    #[serde(with = "serializers::from_str")]
+    #[serde(default, with = "serializers::from_str")]
     pub gas_wanted: i64,
+
     /// Amount of gas consumed by the transaction.
-    #[serde(with = "serializers::from_str")]
+    #[serde(default, with = "serializers::from_str")]
     pub gas_used: i64,
+
     /// Events that occurred while executing the transaction.
+    #[serde(default)]
     pub events: Vec<Event>,
+
     /// The namespace for the `code`.
+    #[serde(default)]
     pub codespace: String,
 }
 

rpc/src/dialect/deliver_tx.rs

@@ -14,27 +14,39 @@ pub struct DeliverTx<Ev> {
     /// This code should be `0` only if the transaction is fully valid. However,
     /// invalid transactions included in a block will still be executed against
     /// the application state.
+    #[serde(default)]
     pub code: Code,
+
     /// Result bytes, if any.
-    #[serde(with = "serializers::nullable")]
+    #[serde(default, with = "serializers::nullable")]
     pub data: Bytes,
+
     /// The output of the application's logger.
     ///
     /// **May be non-deterministic**.
+    #[serde(default)]
     pub log: String,
+
     /// Additional information.
     ///
     /// **May be non-deterministic**.
+    #[serde(default)]
     pub info: String,
+
     /// Amount of gas requested for the transaction.
-    #[serde(with = "serializers::from_str")]
+    #[serde(default, with = "serializers::from_str")]
     pub gas_wanted: i64,
+
     /// Amount of gas consumed by the transaction.
-    #[serde(with = "serializers::from_str")]
+    #[serde(default, with = "serializers::from_str")]
     pub gas_used: i64,
+
     /// Events that occurred while executing the transaction.
+    #[serde(default = "Vec::new")]
     pub events: Vec<Ev>,
+
     /// The namespace for the `code`.
+    #[serde(default)]
     pub codespace: String,
 }
 

rpc/tests/sei_fixtures.rs

@@ -0,0 +1,53 @@
+use std::{fs, path::PathBuf};
+
+use cometbft_rpc::{endpoint, Response};
+
+use walkdir::WalkDir;
+
+fn find_fixtures(in_out_folder_name: &str) -> Vec<PathBuf> {
+    WalkDir::new(
+        PathBuf::from(env!("CARGO_MANIFEST_DIR"))
+            .join("tests")
+            .join("sei_fixtures")
+            .join(in_out_folder_name),
+    )
+    .into_iter()
+    .filter_map(|e| e.ok())
+    .filter(|e| {
+        e.file_type().is_file()
+            && e.path().extension().is_some()
+            && e.path().extension().unwrap() == "json"
+    })
+    .map(|e| e.into_path())
+    .collect::<Vec<PathBuf>>()
+}
+
+#[test]
+fn incoming_fixtures() {
+    for json_file in find_fixtures("incoming") {
+        let file_name = json_file
+            .file_name()
+            .unwrap()
+            .to_str()
+            .unwrap()
+            .strip_suffix(".json")
+            .unwrap();
+
+        let content = fs::read_to_string(&json_file).unwrap();
+
+        match file_name {
+            "block_results_with_failed_txs" => {
+                let r = endpoint::block_results::Response::from_string(&content);
+                dbg!(&r);
+                assert!(r.is_ok(), "block_results_with_failed_txs (v0.37+): {r:?}");
+
+                let r = endpoint::block_results::v0_34::DialectResponse::from_string(&content);
+                dbg!(&r);
+                assert!(r.is_ok(), "block_results_with_failed_txs (v0.34): {r:?}");
+            },
+            _ => {
+                panic!("unhandled incoming fixture: {file_name}");
+            },
+        }
+    }
+}