multiprocess: Add serialization code for CBlockTemplate

ryanofsky · ryanofsky · commit 4e67086e4c0b · 2024-07-22T13:10:40.000-04:00
diff --git a/src/ipc/capnp/mining-types.h b/src/ipc/capnp/mining-types.h
@@ -19,6 +19,14 @@ void CustomBuildMessage(InvokeContext& invoke_context,
 void CustomReadMessage(InvokeContext& invoke_context,
                        const ipc::capnp::messages::BlockValidationState::Reader& reader,
                        BlockValidationState& dest);
+
+// Custom serialization for std::unique_ptr<CBlockTemplate>.
+void CustomBuildMessage(InvokeContext& invoke_context,
+                        const std::unique_ptr<node::CBlockTemplate>& src,
+                        ipc::capnp::messages::CBlockTemplate::Builder&& builder);
+void CustomReadMessage(InvokeContext& invoke_context,
+                       const ipc::capnp::messages::CBlockTemplate::Reader& reader,
+                       std::unique_ptr<node::CBlockTemplate>& dest);
 } // namespace mp
 
 #endif // BITCOIN_IPC_CAPNP_MINING_TYPES_H
diff --git a/src/ipc/capnp/mining.capnp b/src/ipc/capnp/mining.capnp
@@ -34,7 +34,10 @@ struct BlockValidationState {
     debugMessage @3 :Text;
 }
 
-# TODO add fields to this struct
-struct CBlockTemplate $Proxy.wrap("std::unique_ptr<node::CBlockTemplate>")
+struct CBlockTemplate $Proxy.wrap("node::CBlockTemplate")
 {
+    block @0 :Data;
+    vTxFees @1 :List(UInt64);
+    vTxSigOpsCost @2 :List(UInt64);
+    vchCoinbaseCommitment @3 :Data;
 }
diff --git a/src/ipc/capnp/mining.cpp b/src/ipc/capnp/mining.cpp
@@ -44,4 +44,21 @@ void CustomReadMessage(InvokeContext& invoke_context,
         assert(false);
     }
 }
+
+void CustomBuildMessage(InvokeContext& invoke_context,
+                        const std::unique_ptr<node::CBlockTemplate>& src,
+                        ipc::capnp::messages::CBlockTemplate::Builder&& builder)
+{
+    if (src) {
+        BuildField(TypeList<node::CBlockTemplate>(), invoke_context, ValueField(builder), *src);
+    }
+}
+
+void CustomReadMessage(InvokeContext& invoke_context,
+                       const ipc::capnp::messages::CBlockTemplate::Reader& reader,
+                       std::unique_ptr<node::CBlockTemplate>& dest)
+{
+    dest = std::make_unique<node::CBlockTemplate>();
+    ReadField(TypeList<node::CBlockTemplate>(), invoke_context, ValueField(reader), ReadDestValue(*dest));
+}
 } // namespace mp
diff --git a/src/test/ipc_test.capnp b/src/test/ipc_test.capnp
@@ -21,6 +21,7 @@ interface FooInterface $Proxy.wrap("FooImplementation") {
     passTransaction @4 (arg :Data) -> (result :Data);
     passBlockState @5 (arg :Mining.BlockValidationState) -> (result :Mining.BlockValidationState);
     passVectorChar @6 (arg :Data) -> (result :Data);
+    passBlockTemplate @7 (arg :Mining.CBlockTemplate) -> (result :Mining.CBlockTemplate);
 }
 
 struct CustomStruct {
diff --git a/src/test/ipc_test.cpp b/src/test/ipc_test.cpp
@@ -16,6 +16,8 @@
 
 #include <boost/test/unit_test.hpp>
 
+using node::CBlockTemplate;
+
 namespace mp {
 //! Custom conversion functions between C++ and capnp CustomStructs
 //! Shift value by 100 to make conversion a little more interesting.
@@ -104,6 +106,11 @@ void IpcTest()
     std::vector<char> vec2{foo->passVectorChar(vec1)};
     BOOST_CHECK_EQUAL(std::string_view(vec1.begin(), vec1.end()), std::string_view(vec2.begin(), vec2.end()));
 
+    CBlockTemplate temp1;
+    temp1.block.nTime = 5;
+    CBlockTemplate temp2{foo->passBlockTemplate(temp1)};
+    BOOST_CHECK_EQUAL(temp1.block.nTime, temp2.block.nTime);
+
     // Test cleanup: disconnect pipe and join thread
     disconnect_client();
     thread.join();
diff --git a/src/test/ipc_test.h b/src/test/ipc_test.h
@@ -5,6 +5,7 @@
 #ifndef BITCOIN_TEST_IPC_TEST_H
 #define BITCOIN_TEST_IPC_TEST_H
 
+#include <node/miner.h>
 #include <primitives/transaction.h>
 #include <univalue.h>
 #include <validation.h>
@@ -24,6 +25,7 @@ class FooImplementation
     CTransactionRef passTransaction(CTransactionRef t) { return t; }
     BlockValidationState passBlockState(BlockValidationState s) { return s; }
     std::vector<char> passVectorChar(std::vector<char> v) { return v; }
+    node::CBlockTemplate passBlockTemplate(node::CBlockTemplate t) { return t; }
 };
 
 void IpcTest();
diff --git a/src/test/ipc_test_types.h b/src/test/ipc_test_types.h
@@ -6,6 +6,7 @@
 #define BITCOIN_TEST_IPC_TEST_TYPES_H
 
 #include <ipc/capnp/common-types.h>
+#include <ipc/capnp/mining.capnp.proxy-types.h>
 #include <ipc/capnp/mining-types.h>
 #include <test/ipc_test.capnp.h>
 

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,10 @@ struct BlockValidationState {`
`34`	`34`	`debugMessage @3 :Text;`
`35`	`35`	`}`
`36`	`36`
`37`		`-# TODO add fields to this struct`
`38`		`-struct CBlockTemplate $Proxy.wrap("std::unique_ptr<node::CBlockTemplate>")`
	`37`	`+struct CBlockTemplate $Proxy.wrap("node::CBlockTemplate")`
`39`	`38`	`{`
	`39`	`+ block @0 :Data;`
	`40`	`+ vTxFees @1 :List(UInt64);`
	`41`	`+ vTxSigOpsCost @2 :List(UInt64);`
	`42`	`+ vchCoinbaseCommitment @3 :Data;`
`40`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ interface FooInterface $Proxy.wrap("FooImplementation") {`
`21`	`21`	`passTransaction @4 (arg :Data) -> (result :Data);`
`22`	`22`	`passBlockState @5 (arg :Mining.BlockValidationState) -> (result :Mining.BlockValidationState);`
`23`	`23`	`passVectorChar @6 (arg :Data) -> (result :Data);`
	`24`	`+ passBlockTemplate @7 (arg :Mining.CBlockTemplate) -> (result :Mining.CBlockTemplate);`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`struct CustomStruct {`