TxSubmission module

.github/workflows/run-tests-on-push-to-main.yml

@@ -40,8 +40,10 @@ jobs:
             --package acropolis_module_snapshot_bootstrapper \
             --package acropolis_module_spdd_state \
             --package acropolis_module_stake_delta_filter \
+            --package acropolis_module_tx_submitter \
             --package acropolis_module_upstream_chain_fetcher \
-            --package acropolis_module_utxo_state
+            --package acropolis_module_utxo_state \
+            --package acropolis_process_tx_submitter_cli
 
       - name: Run Build
         run: cargo build --verbose

Cargo.toml

@@ -25,11 +25,13 @@ members = [
     "modules/historical_accounts_state",    # Tracks historical account information
     "modules/consensus",                    # Chooses favoured chain across multiple options
     "modules/chain_store",                  # Tracks historical information about blocks and TXs
+    "modules/tx_submitter",                 # Submits TXs to peers
 
     # Process builds
-    "processes/omnibus",      # All-inclusive omnibus process
-    "processes/replayer",     # All-inclusive process to replay messages
-    "processes/golden_tests", # All-inclusive golden tests process
+    "processes/omnibus",            # All-inclusive omnibus process
+    "processes/replayer",           # All-inclusive process to replay messages
+    "processes/golden_tests",       # All-inclusive golden tests process
+    "processes/tx_submitter_cli",   # CLI wrapper for TX submitter
 ]
 resolver = "2"
 
@@ -41,7 +43,7 @@ caryatid_module_clock = "0.12"
 caryatid_module_spy = "0.12"
 anyhow = "1.0"
 chrono = "0.4"
-clap = { version = "4.5", features = ["derive"] }
+clap = { version = "4.5", features = ["derive", "string"] }
 config = "0.15.11"
 dashmap = "6.1.0"
 hex = "0.4"

common/src/commands/mod.rs

@@ -0,0 +1 @@
+pub mod transactions;

common/src/commands/transactions.rs

@@ -0,0 +1,19 @@
+use serde_with::{hex::Hex, serde_as};
+
+use crate::TxHash;
+
+#[serde_as]
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub enum TransactionsCommand {
+    Submit {
+        #[serde_as(as = "Hex")]
+        cbor: Vec<u8>,
+        wait_for_ack: bool,
+    },
+}
+
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub enum TransactionsCommandResponse {
+    Submitted { id: TxHash },
+    Error(String),
+}

common/src/lib.rs

@@ -4,6 +4,7 @@ pub mod address;
 pub mod byte_array;
 pub mod calculations;
 pub mod cip19;
+pub mod commands;
 pub mod crypto;
 pub mod genesis_values;
 pub mod hash;

common/src/messages.rs

@@ -3,6 +3,7 @@
 // We don't use these messages in the acropolis_common crate itself
 #![allow(dead_code)]
 
+use crate::commands::transactions::{TransactionsCommand, TransactionsCommandResponse};
 use crate::genesis_values::GenesisValues;
 use crate::ledger_state::SPOState;
 use crate::protocol_params::{NonceHash, ProtocolParams};
@@ -350,6 +351,10 @@ pub enum Message {
     // State query messages
     StateQuery(StateQuery),
     StateQueryResponse(StateQueryResponse),
+
+    // Commands
+    Command(Command),
+    CommandResponse(CommandResponse),
 }
 
 // Casts from specific Caryatid messages
@@ -422,3 +427,13 @@ pub enum StateQueryResponse {
     UTxOs(UTxOStateQueryResponse),
     SPDD(SPDDStateQueryResponse),
 }
+
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub enum Command {
+    Transactions(TransactionsCommand),
+}
+
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub enum CommandResponse {
+    Transactions(TransactionsCommandResponse),
+}

modules/tx_submitter/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "acropolis_module_tx_submitter"
+version = "0.1.0"
+edition = "2024"
+authors = ["Simon Gellis <[email protected]>"]
+description = "TX submission module for Acropolis"
+license = "Apache-2.0"
+
+[dependencies]
+acropolis_common = { path = "../../common" }
+
+caryatid_sdk = { workspace = true }
+
+anyhow = { workspace = true }
+config = { workspace = true }
+futures = "0.3.31"
+hex = { workspace = true }
+pallas = { workspace = true }
+tokio = { workspace = true }
+tracing = { workspace = true }
+
+[lib]
+path = "src/tx_submitter.rs"

modules/tx_submitter/README.md

@@ -0,0 +1,21 @@
+# TX submission module
+
+The TX submission module implements the TXSubmission node-to-node protocol to submit transactions to a single upstream source.
+
+## Messages
+
+The TX submission module listens for requests to submit transactions on the `cardano.txs.submit` topic. It will send a response once any upstream server has acknowledged the transaction.
+
+## Default configuration
+
+```toml
+[module.tx-submitter]
+
+# Upstream node connection
+node-address = "backbone.cardano.iog.io:3001"
+magic-number = 764824073
+
+# Message topics
+subscribe-topic = "cardano.txs.submit"
+
+```