use core::{fmt::Debug, time::Duration}; use std::{io, collections::HashMap}; use async_trait::async_trait; use thiserror::Error; use frost::{ curve::{Ciphersuite, Curve}, ThresholdKeys, sign::PreprocessMachine, }; use serai_client::primitives::{NetworkId, Balance}; use log::error; use tokio::time::sleep; #[cfg(feature = "bitcoin")] pub mod bitcoin; #[cfg(feature = "bitcoin")] pub use self::bitcoin::Bitcoin; #[cfg(feature = "monero")] pub mod monero; #[cfg(feature = "monero")] pub use monero::Monero; use crate::{Payment, Plan}; #[derive(Clone, Copy, Error, Debug)] pub enum NetworkError { #[error("failed to connect to network daemon")] ConnectionError, } pub trait Id: Send + Sync + Clone + Default + PartialEq + AsRef<[u8]> + AsMut<[u8]> + Debug { } impl + AsMut<[u8]> + Debug> Id for I {} #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)] pub enum OutputType { // Needs to be processed/sent up to Substrate External, // Given a known output set, and a known series of outbound transactions, we should be able to // form a completely deterministic schedule S. The issue is when S has TXs which spend prior TXs // in S (which is needed for our logarithmic scheduling). In order to have the descendant TX, say // S[1], build off S[0], we need to observe when S[0] is included on-chain. // // We cannot. // // Monero (and other privacy coins) do not expose their UTXO graphs. Even if we know how to // create S[0], and the actual payment info behind it, we cannot observe it on the blockchain // unless we participated in creating it. Locking the entire schedule, when we cannot sign for // the entire schedule at once, to a single signing set isn't feasible. // // While any member of the active signing set can provide data enabling other signers to // participate, it's several KB of data which we then have to code communication for. // The other option is to simply not observe S[0]. Instead, observe a TX with an identical output // to the one in S[0] we intended to use for S[1]. It's either from S[0], or Eve, a malicious // actor, has sent us a forged TX which is... equally as usable? so who cares? // // The only issue is if we have multiple outputs on-chain with identical amounts and purposes. // Accordingly, when the scheduler makes a plan for when a specific output is available, it // shouldn't write that plan. It should *push* that plan to a queue of plans to perform when // instances of that output occur. Branch, // Should be added to the available UTXO pool with no further action Change, } impl OutputType { fn write(&self, writer: &mut W) -> io::Result<()> { writer.write_all(&[match self { OutputType::External => 0, OutputType::Branch => 1, OutputType::Change => 2, }]) } fn read(reader: &mut R) -> io::Result { let mut byte = [0; 1]; reader.read_exact(&mut byte)?; Ok(match byte[0] { 0 => OutputType::External, 1 => OutputType::Branch, 2 => OutputType::Change, _ => Err(io::Error::new(io::ErrorKind::Other, "invalid OutputType"))?, }) } } pub trait Output: Send + Sync + Sized + Clone + PartialEq + Eq + Debug { type Id: 'static + Id; fn kind(&self) -> OutputType; fn id(&self) -> Self::Id; fn tx_id(&self) -> >::Id; fn key(&self) -> ::G; fn balance(&self) -> Balance; // TODO: Remove this? fn amount(&self) -> u64 { self.balance().amount.0 } fn data(&self) -> &[u8]; fn write(&self, writer: &mut W) -> io::Result<()>; fn read(reader: &mut R) -> io::Result; } #[async_trait] pub trait Transaction: Send + Sync + Sized + Clone + Debug { type Id: 'static + Id; fn id(&self) -> Self::Id; fn serialize(&self) -> Vec; fn read(reader: &mut R) -> io::Result; #[cfg(test)] async fn fee(&self, network: &N) -> u64; } pub trait SignableTransaction: Send + Sync + Clone + Debug { fn fee(&self) -> u64; } pub trait Eventuality: Send + Sync + Clone + Debug { fn lookup(&self) -> Vec; fn read(reader: &mut R) -> io::Result; fn serialize(&self) -> Vec; } #[derive(Clone, PartialEq, Eq, Debug)] pub struct EventualitiesTracker { // Lookup property (input, nonce, TX extra...) -> (plan ID, eventuality) map: HashMap, ([u8; 32], E)>, // Block number we've scanned these eventualities too block_number: usize, } impl EventualitiesTracker { pub fn new() -> Self { EventualitiesTracker { map: HashMap::new(), block_number: usize::MAX } } pub fn register(&mut self, block_number: usize, id: [u8; 32], eventuality: E) { log::info!("registering eventuality for {}", hex::encode(id)); let lookup = eventuality.lookup(); if self.map.contains_key(&lookup) { panic!("registering an eventuality multiple times or lookup collision"); } self.map.insert(lookup, (id, eventuality)); // If our self tracker already went past this block number, set it back self.block_number = self.block_number.min(block_number); } pub fn drop(&mut self, id: [u8; 32]) { // O(n) due to the lack of a reverse lookup let mut found_key = None; for (key, value) in &self.map { if value.0 == id { found_key = Some(key.clone()); break; } } if let Some(key) = found_key { self.map.remove(&key); } } } impl Default for EventualitiesTracker { fn default() -> Self { Self::new() } } pub trait Block: Send + Sync + Sized + Clone + Debug { // This is currently bounded to being 32 bytes. type Id: 'static + Id; fn id(&self) -> Self::Id; fn parent(&self) -> Self::Id; // The monotonic network time at this block. fn time(&self) -> u64; } // The post-fee value of an expected branch. pub struct PostFeeBranch { pub expected: u64, pub actual: Option, } // Return the PostFeeBranches needed when dropping a transaction fn drop_branches( key: ::G, payments: &[Payment], ) -> Vec { let mut branch_outputs = vec![]; for payment in payments { if payment.address == N::branch_address(key) { branch_outputs.push(PostFeeBranch { expected: payment.amount, actual: None }); } } branch_outputs } pub struct PreparedSend { /// None for the transaction if the SignableTransaction was dropped due to lack of value. pub tx: Option<(N::SignableTransaction, N::Eventuality)>, pub post_fee_branches: Vec, /// The updated operating costs after preparing this transaction. pub operating_costs: u64, } #[async_trait] pub trait Network: 'static + Send + Sync + Clone + PartialEq + Eq + Debug { /// The elliptic curve used for this network. type Curve: Curve; /// The type representing the transaction for this network. type Transaction: Transaction; /// The type representing the block for this network. type Block: Block; /// The type containing all information on a scanned output. // This is almost certainly distinct from the network's native output type. type Output: Output; /// The type containing all information on a planned transaction, waiting to be signed. type SignableTransaction: SignableTransaction; /// The type containing all information to check if a plan was completed. /// /// This must be binding to both the outputs expected and the plan ID. type Eventuality: Eventuality; /// The FROST machine to sign a transaction. type TransactionMachine: PreprocessMachine; /// The type representing an address. // This should NOT be a String, yet a tailored type representing an efficient binary encoding, // as detailed in the integration documentation. type Address: Send + Sync + Clone + PartialEq + Eq + Debug + ToString + TryInto> + TryFrom>; /// Network ID for this network. const NETWORK: NetworkId; /// String ID for this network. const ID: &'static str; /// The estimated amount of time a block will take. const ESTIMATED_BLOCK_TIME_IN_SECONDS: usize; /// The amount of confirmations required to consider a block 'final'. const CONFIRMATIONS: usize; /// The maximum amount of inputs which will fit in a TX. /// This should be equal to MAX_OUTPUTS unless one is specifically limited. /// A TX with MAX_INPUTS and MAX_OUTPUTS must not exceed the max size. const MAX_INPUTS: usize; /// The maximum amount of outputs which will fit in a TX. /// This should be equal to MAX_INPUTS unless one is specifically limited. /// A TX with MAX_INPUTS and MAX_OUTPUTS must not exceed the max size. const MAX_OUTPUTS: usize; /// Minimum output value which will be handled. /// /// For any received output, there's the cost to spend the output. This value MUST exceed the /// cost to spend said output, and should by a notable margin (not just 2x, yet an order of /// magnitude). const DUST: u64; /// The cost to perform input aggregation with a 2-input 1-output TX. const COST_TO_AGGREGATE: u64; /// Tweak keys for this network. fn tweak_keys(key: &mut ThresholdKeys); /// Address for the given group key to receive external coins to. fn address(key: ::G) -> Self::Address; /// Address for the given group key to use for scheduled branches. fn branch_address(key: ::G) -> Self::Address; /// Address for the given group key to use for change. fn change_address(key: ::G) -> Self::Address; /// Get the latest block's number. async fn get_latest_block_number(&self) -> Result; /// Get a block by its number. async fn get_block(&self, number: usize) -> Result; /// Get the outputs within a block for a specific key. async fn get_outputs( &self, block: &Self::Block, key: ::G, ) -> Vec; /// Get the registered eventualities completed within this block, and any prior blocks which /// registered eventualities may have been completed in. /// /// This may panic if not fed a block greater than the tracker's block number. // TODO: get_eventuality_completions_internal + provided get_eventuality_completions for common // code async fn get_eventuality_completions( &self, eventualities: &mut EventualitiesTracker, block: &Self::Block, ) -> HashMap<[u8; 32], (usize, Self::Transaction)>; /// Returns the needed fee to fulfill this Plan at this fee rate. /// /// Returns None if this Plan isn't fulfillable (such as when the fee exceeds the input value). async fn needed_fee( &self, block_number: usize, plan_id: &[u8; 32], inputs: &[Self::Output], payments: &[Payment], change: &Option, ) -> Result, NetworkError>; /// Create a SignableTransaction for the given Plan. /// /// The expected flow is: /// 1) Call needed_fee /// 2) If the Plan is fulfillable, amortize the fee /// 3) Call signable_transaction *which MUST NOT return None if the above was done properly* async fn signable_transaction( &self, block_number: usize, plan_id: &[u8; 32], inputs: &[Self::Output], payments: &[Payment], change: &Option, ) -> Result, NetworkError>; /// Prepare a SignableTransaction for a transaction. async fn prepare_send( &self, block_number: usize, plan: Plan, operating_costs: u64, ) -> Result, NetworkError> { // Sanity check this has at least one output planned assert!((!plan.payments.is_empty()) || plan.change.is_some()); let plan_id = plan.id(); let Plan { key, inputs, mut payments, change } = plan; let theoretical_change_amount = inputs.iter().map(|input| input.amount()).sum::() - payments.iter().map(|payment| payment.amount).sum::(); let Some(tx_fee) = self.needed_fee(block_number, &plan_id, &inputs, &payments, &change).await? else { // This Plan is not fulfillable // TODO: Have Plan explicitly distinguish payments and branches in two separate Vecs? return Ok(PreparedSend { tx: None, // Have all of its branches dropped post_fee_branches: drop_branches(key, &payments), // This plan expects a change output valued at sum(inputs) - sum(outputs) // Since we can no longer create this change output, it becomes an operating cost // TODO: Look at input restoration to reduce this operating cost operating_costs: operating_costs + if change.is_some() { theoretical_change_amount } else { 0 }, }); }; // Amortize the fee over the plan's payments let (post_fee_branches, mut operating_costs) = (|| { // If we're creating a change output, letting us recoup coins, amortize the operating costs // as well let total_fee = tx_fee + if change.is_some() { operating_costs } else { 0 }; let original_outputs = payments.iter().map(|payment| payment.amount).sum::(); // If this isn't enough for the total fee, drop and move on if original_outputs < total_fee { let mut remaining_operating_costs = operating_costs; if change.is_some() { // Operating costs increase by the TX fee remaining_operating_costs += tx_fee; // Yet decrease by the payments we managed to drop remaining_operating_costs = remaining_operating_costs.saturating_sub(original_outputs); } return (drop_branches(key, &payments), remaining_operating_costs); } let initial_payment_amounts = payments.iter().map(|payment| payment.amount).collect::>(); // Amortize the transaction fee across outputs let mut remaining_fee = total_fee; // Run as many times as needed until we can successfully subtract this fee while remaining_fee != 0 { // This shouldn't be a / by 0 as these payments have enough value to cover the fee let this_iter_fee = remaining_fee / u64::try_from(payments.len()).unwrap(); let mut overage = remaining_fee % u64::try_from(payments.len()).unwrap(); for payment in &mut payments { let this_payment_fee = this_iter_fee + overage; // Only subtract the overage once overage = 0; let subtractable = payment.amount.min(this_payment_fee); remaining_fee -= subtractable; payment.amount -= subtractable; } } // If any payment is now below the dust threshold, set its value to 0 so it'll be dropped for payment in &mut payments { if payment.amount < Self::DUST { payment.amount = 0; } } // Note the branch outputs' new values let mut branch_outputs = vec![]; for (initial_amount, payment) in initial_payment_amounts.into_iter().zip(&payments) { if payment.address == Self::branch_address(key) { branch_outputs.push(PostFeeBranch { expected: initial_amount, actual: if payment.amount == 0 { None } else { Some(payment.amount) }, }); } } // Drop payments now worth 0 payments = payments .drain(..) .filter(|payment| { if payment.amount != 0 { true } else { log::debug!("dropping dust payment from plan {}", hex::encode(plan_id)); false } }) .collect(); // Sanity check the fee was successfully amortized let new_outputs = payments.iter().map(|payment| payment.amount).sum::(); assert!((new_outputs + total_fee) <= original_outputs); ( branch_outputs, if change.is_none() { // If the change is None, this had no effect on the operating costs operating_costs } else { // Since the change is some, and we successfully amortized, the operating costs were // recouped 0 }, ) })(); let Some(tx) = self.signable_transaction(block_number, &plan_id, &inputs, &payments, &change).await? else { panic!( "{}. {}: {}, {}: {:?}, {}: {:?}, {}: {:?}, {}: {}", "signable_transaction returned None for a TX we prior successfully calculated the fee for", "id", hex::encode(plan_id), "inputs", inputs, "post-amortization payments", payments, "change", change, "successfully amoritized fee", tx_fee, ) }; if change.is_some() { let on_chain_expected_change = inputs.iter().map(|input| input.amount()).sum::() - payments.iter().map(|payment| payment.amount).sum::() - tx_fee; // If the change value is less than the dust threshold, it becomes an operating cost // This may be slightly inaccurate as dropping payments may reduce the fee, raising the // change above dust // That's fine since it'd have to be in a very precarious state AND then it's over-eager in // tabulating costs if on_chain_expected_change < Self::DUST { operating_costs += theoretical_change_amount; } } Ok(PreparedSend { tx: Some(tx), post_fee_branches, operating_costs }) } /// Attempt to sign a SignableTransaction. async fn attempt_send( &self, keys: ThresholdKeys, transaction: Self::SignableTransaction, ) -> Result; /// Publish a transaction. async fn publish_transaction(&self, tx: &Self::Transaction) -> Result<(), NetworkError>; /// Get a transaction by its ID. async fn get_transaction( &self, id: &>::Id, ) -> Result; /// Confirm a plan was completed by the specified transaction. // This is allowed to take shortcuts. // This may assume an honest multisig, solely checking the inputs specified were spent. // This may solely check the outputs are equivalent *so long as it's locked to the plan ID*. fn confirm_completion(&self, eventuality: &Self::Eventuality, tx: &Self::Transaction) -> bool; /// Get a block's number by its ID. #[cfg(test)] async fn get_block_number(&self, id: &>::Id) -> usize; #[cfg(test)] async fn mine_block(&self); /// Sends to the specified address. /// Additionally mines enough blocks so that the TX is past the confirmation depth. #[cfg(test)] async fn test_send(&self, key: Self::Address) -> Self::Block; } // TODO: Move into above trait pub async fn get_latest_block_number(network: &N) -> usize { loop { match network.get_latest_block_number().await { Ok(number) => { return number; } Err(e) => { error!( "couldn't get the latest block number in main's error-free get_block. {} {}", "this should only happen if the node is offline. error: ", e ); sleep(Duration::from_secs(10)).await; } } } } pub async fn get_block(network: &N, block_number: usize) -> N::Block { loop { match network.get_block(block_number).await { Ok(block) => { return block; } Err(e) => { error!("couldn't get block {block_number} in main's error-free get_block. error: {}", e); sleep(Duration::from_secs(10)).await; } } } }