Struct TxSenderClient

pub struct TxSenderClient<D>
where
    D: TxSenderDatabase,
{
    pub db: D,
    pub tx_sender_consumer_id: String,
}

Fields

db: D

tx_sender_consumer_id: String

Implementations

impl<D> TxSenderClient<D>

where D: TxSenderDatabase,

pub fn new(db: D, tx_sender_consumer_id: String) -> Self

pub async fn insert_try_to_send( &self, dbtx: Option<&mut D::Transaction>, tx_metadata: Option<TxMetadata>, signed_tx: &Transaction, fee_paying_type: FeePayingType, rbf_signing_info: Option<RbfSigningInfo>, cancel_outpoints: &[OutPoint], cancel_txids: &[Txid], activate_txids: &[ActivatedWithTxid], activate_outpoints: &[ActivatedWithOutpoint], ) -> Result<u32, BridgeError>

Saves a transaction to the database queue for sending/fee bumping.

This function determines the initial parameters for a transaction send attempt, including its [FeePayingType], associated metadata, and dependencies (cancellations/activations). It then persists this information in the database via [Database::save_tx] and related functions. The actual sending logic (CPFP/RBF) is handled later by the transaction sender’s task loop.

Default Activation and Cancellation Conditions

By default, this function automatically adds cancellation conditions for all outpoints spent by the signed_tx itself. If signed_tx confirms, these input outpoints are marked as spent/cancelled in the database.

There are no default activation conditions added implicitly; all activation prerequisites must be explicitly provided via the activate_txids and activate_outpoints arguments.

Arguments

• dbtx - An active database transaction.
• tx_metadata - Optional metadata about the transaction’s purpose.
• signed_tx - The transaction to be potentially sent.
• fee_paying_type - Whether to use CPFP or RBF for fee management.
• cancel_outpoints - Outpoints that should be marked invalid if this tx confirms (in addition to the tx’s own inputs).
• cancel_txids - Txids that should be marked invalid if this tx confirms.
• activate_txids - Txids that are prerequisites for this tx, potentially with a relative timelock.
• activate_outpoints - Outpoints that are prerequisites for this tx, potentially with a relative timelock.

Returns

• u32: The database ID (try_to_send_id) assigned to this send attempt.

pub async fn add_tx_to_queue( &self, dbtx: Option<&mut D::Transaction>, tx_type: TransactionType, signed_tx: &Transaction, related_txs: &[(TransactionType, Transaction)], tx_metadata: Option<TxMetadata>, protocol_paramset: &ProtocolParamset, rbf_info: Option<RbfSigningInfo>, ) -> Result<u32, BridgeError>

Adds a transaction to the sending queue based on its type and configuration.

This is a higher-level wrapper around Self::insert_try_to_send. It determines the appropriate FeePayingType (CPFP or RBF) and any specific cancellation or activation dependencies based on the tx_type and config.

For example:

• Challenge transactions use RBF.
• Most other transactions default to CPFP.
• Specific types like OperatorChallengeAck might activate certain outpoints based on related transactions (kickoff_txid).

Arguments

• dbtx - An active database transaction.
• tx_type - The semantic type of the transaction.
• signed_tx - The transaction itself.
• related_txs - Other transactions potentially related (e.g., the kickoff for a challenge ack).
• tx_metadata - Optional metadata, tx_type will be added/overridden.
• config - Bridge configuration providing parameters like finality depth.

Returns

• u32: The database ID (try_to_send_id) assigned to this send attempt.

Trait Implementations

impl<D> Clone for TxSenderClient<D>

where D: TxSenderDatabase + Clone,

fn clone(&self) -> TxSenderClient<D>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D> Debug for TxSenderClient<D>

where D: TxSenderDatabase + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.