wow-btc-swap/swap/tests/testutils/mod.rs

use crate::testutils;
use bitcoin_harness::Bitcoind;
use futures::Future;
use get_port::get_port;
use libp2p::{core::Multiaddr, PeerId};
use monero_harness::{image, Monero};
use rand::rngs::OsRng;
use std::{path::PathBuf, sync::Arc};
use swap::{
    bitcoin,
    config::Config,
    database::Database,
    monero, network,
    network::transport::build,
    protocol::{alice, alice::AliceState, bob, bob::BobState},
    seed::Seed,
    SwapAmounts,
};
use tempfile::tempdir;
use testcontainers::{clients::Cli, Container};
use tracing_core::dispatcher::DefaultGuard;
use tracing_log::LogTracer;
use uuid::Uuid;

pub struct Test {
    swap_amounts: SwapAmounts,

    alice_swap_factory: AliceSwapFactory,
    bob_swap_factory: BobSwapFactory,
}

impl Test {
    pub async fn new_swap_as_alice(&self) -> alice::Swap {
        let (swap, mut event_loop) = self
            .alice_swap_factory
            .new_swap_as_alice(self.swap_amounts)
            .await;

        tokio::spawn(async move { event_loop.run().await });

        swap
    }

    pub async fn new_swap_as_bob(&self) -> bob::Swap {
        let (swap, event_loop) = self
            .bob_swap_factory
            .new_swap_as_bob(self.swap_amounts)
            .await;

        tokio::spawn(async move { event_loop.run().await });

        swap
    }

    pub async fn recover_alice_from_db(&self) -> alice::Swap {
        let (swap, mut event_loop) = self.alice_swap_factory.recover_alice_from_db().await;

        tokio::spawn(async move { event_loop.run().await });

        swap
    }

    pub async fn recover_bob_from_db(&self) -> bob::Swap {
        let (swap, event_loop) = self.bob_swap_factory.recover_bob_from_db().await;

        tokio::spawn(async move { event_loop.run().await });

        swap
    }

    pub async fn assert_alice_redeemed(&self, state: AliceState) {
        assert!(matches!(state, AliceState::BtcRedeemed));

        let btc_balance_after_swap = self
            .alice_swap_factory
            .bitcoin_wallet
            .as_ref()
            .balance()
            .await
            .unwrap();
        assert_eq!(
            btc_balance_after_swap,
            self.alice_swap_factory.starting_balances.btc + self.swap_amounts.btc
                - bitcoin::Amount::from_sat(bitcoin::TX_FEE)
        );

        let xmr_balance_after_swap = self
            .alice_swap_factory
            .monero_wallet
            .as_ref()
            .get_balance()
            .await
            .unwrap();
        assert!(
            xmr_balance_after_swap
                <= self.alice_swap_factory.starting_balances.xmr - self.swap_amounts.xmr
        );
    }

    pub async fn assert_alice_refunded(&self, state: AliceState) {
        assert!(matches!(state, AliceState::XmrRefunded));

        let btc_balance_after_swap = self
            .alice_swap_factory
            .bitcoin_wallet
            .as_ref()
            .balance()
            .await
            .unwrap();
        assert_eq!(
            btc_balance_after_swap,
            self.alice_swap_factory.starting_balances.btc
        );

        // Ensure that Alice's balance is refreshed as we use a newly created wallet
        self.alice_swap_factory
            .monero_wallet
            .as_ref()
            .inner
            .refresh()
            .await
            .unwrap();
        let xmr_balance_after_swap = self
            .alice_swap_factory
            .monero_wallet
            .as_ref()
            .get_balance()
            .await
            .unwrap();
        assert_eq!(xmr_balance_after_swap, self.swap_amounts.xmr);
    }

    pub async fn assert_alice_punished(&self, state: AliceState) {
        assert!(matches!(state, AliceState::BtcPunished));

        let btc_balance_after_swap = self
            .alice_swap_factory
            .bitcoin_wallet
            .as_ref()
            .balance()
            .await
            .unwrap();
        assert_eq!(
            btc_balance_after_swap,
            self.alice_swap_factory.starting_balances.btc + self.swap_amounts.btc
                - bitcoin::Amount::from_sat(2 * bitcoin::TX_FEE)
        );

        let xmr_balance_after_swap = self
            .alice_swap_factory
            .monero_wallet
            .as_ref()
            .get_balance()
            .await
            .unwrap();
        assert!(
            xmr_balance_after_swap
                <= self.alice_swap_factory.starting_balances.xmr - self.swap_amounts.xmr
        );
    }

    pub async fn assert_bob_redeemed(&self, state: BobState) {
        let lock_tx_id = if let BobState::XmrRedeemed { tx_lock_id } = state {
            tx_lock_id
        } else {
            panic!("Bob in unexpected state");
        };

        let lock_tx_bitcoin_fee = self
            .bob_swap_factory
            .bitcoin_wallet
            .transaction_fee(lock_tx_id)
            .await
            .unwrap();

        let btc_balance_after_swap = self
            .bob_swap_factory
            .bitcoin_wallet
            .as_ref()
            .balance()
            .await
            .unwrap();
        assert_eq!(
            btc_balance_after_swap,
            self.bob_swap_factory.starting_balances.btc
                - self.swap_amounts.btc
                - lock_tx_bitcoin_fee
        );

        // Ensure that Bob's balance is refreshed as we use a newly created wallet
        self.bob_swap_factory
            .monero_wallet
            .as_ref()
            .inner
            .refresh()
            .await
            .unwrap();
        let xmr_balance_after_swap = self
            .bob_swap_factory
            .monero_wallet
            .as_ref()
            .get_balance()
            .await
            .unwrap();
        assert_eq!(
            xmr_balance_after_swap,
            self.bob_swap_factory.starting_balances.xmr + self.swap_amounts.xmr
        );
    }

    pub async fn assert_bob_refunded(&self, state: BobState) {
        let lock_tx_id = if let BobState::BtcRefunded(state4) = state {
            state4.tx_lock_id()
        } else {
            panic!("Bob in unexpected state");
        };
        let lock_tx_bitcoin_fee = self
            .bob_swap_factory
            .bitcoin_wallet
            .transaction_fee(lock_tx_id)
            .await
            .unwrap();

        let btc_balance_after_swap = self
            .bob_swap_factory
            .bitcoin_wallet
            .as_ref()
            .balance()
            .await
            .unwrap();

        let alice_submitted_cancel = btc_balance_after_swap
            == self.bob_swap_factory.starting_balances.btc
                - lock_tx_bitcoin_fee
                - bitcoin::Amount::from_sat(bitcoin::TX_FEE);

        let bob_submitted_cancel = btc_balance_after_swap
            == self.bob_swap_factory.starting_balances.btc
                - lock_tx_bitcoin_fee
                - bitcoin::Amount::from_sat(2 * bitcoin::TX_FEE);

        // The cancel tx can be submitted by both Alice and Bob.
        // Since we cannot be sure who submitted it we have to assert accordingly
        assert!(alice_submitted_cancel || bob_submitted_cancel);

        let xmr_balance_after_swap = self
            .bob_swap_factory
            .monero_wallet
            .as_ref()
            .get_balance()
            .await
            .unwrap();
        assert_eq!(
            xmr_balance_after_swap,
            self.bob_swap_factory.starting_balances.xmr
        );
    }

    pub async fn assert_bob_punished(&self, state: BobState) {
        let lock_tx_id = if let BobState::BtcPunished { tx_lock_id } = state {
            tx_lock_id
        } else {
            panic!("Bob in unexpected state");
        };

        let lock_tx_bitcoin_fee = self
            .bob_swap_factory
            .bitcoin_wallet
            .transaction_fee(lock_tx_id)
            .await
            .unwrap();

        let btc_balance_after_swap = self
            .bob_swap_factory
            .bitcoin_wallet
            .as_ref()
            .balance()
            .await
            .unwrap();
        assert_eq!(
            btc_balance_after_swap,
            self.bob_swap_factory.starting_balances.btc
                - self.swap_amounts.btc
                - lock_tx_bitcoin_fee
        );

        let xmr_balance_after_swap = self
            .bob_swap_factory
            .monero_wallet
            .as_ref()
            .get_balance()
            .await
            .unwrap();
        assert_eq!(
            xmr_balance_after_swap,
            self.bob_swap_factory.starting_balances.xmr
        );
    }
}

pub async fn init<T, F>(testfn: T)
where
    T: Fn(Test) -> F,
    F: Future<Output = ()>,
{
    let cli = Cli::default();

    let _guard = init_tracing();

    let (monero, containers) = testutils::init_containers(&cli).await;

    let swap_amounts = SwapAmounts {
        btc: bitcoin::Amount::from_sat(1_000_000),
        xmr: monero::Amount::from_piconero(1_000_000_000_000),
    };

    let config = Config::regtest();

    let alice_starting_balances = StartingBalances {
        xmr: swap_amounts.xmr * 10,
        btc: bitcoin::Amount::ZERO,
    };
    let alice_swap_factory = AliceSwapFactory::new(
        config,
        Uuid::new_v4(),
        &monero,
        &containers.bitcoind,
        alice_starting_balances,
    )
    .await;

    let bob_starting_balances = StartingBalances {
        xmr: monero::Amount::ZERO,
        btc: swap_amounts.btc * 10,
    };

    let bob_swap_factory = BobSwapFactory::new(
        config,
        Uuid::new_v4(),
        &monero,
        &containers.bitcoind,
        bob_starting_balances,
        alice_swap_factory.listen_address(),
        alice_swap_factory.peer_id(),
    )
    .await;

    let test = Test {
        swap_amounts,
        alice_swap_factory,
        bob_swap_factory,
    };

    testfn(test).await
}

pub struct AliceSwapFactory {
    listen_address: Multiaddr,
    peer_id: PeerId,

    seed: Seed,
    db_path: PathBuf,
    swap_id: Uuid,

    bitcoin_wallet: Arc<bitcoin::Wallet>,
    monero_wallet: Arc<monero::Wallet>,
    config: Config,
    starting_balances: StartingBalances,
}

impl AliceSwapFactory {
    async fn new(
        config: Config,
        swap_id: Uuid,
        monero: &Monero,
        bitcoind: &Bitcoind<'_>,
        starting_balances: StartingBalances,
    ) -> Self {
        let port = get_port().expect("Failed to find a free port");

        let listen_address: Multiaddr = format!("/ip4/127.0.0.1/tcp/{}", port)
            .parse()
            .expect("failed to parse Alice's address");

        let seed = Seed::random().unwrap();

        let db_path = tempdir().unwrap().path().to_path_buf();

        let (bitcoin_wallet, monero_wallet) =
            init_wallets("alice", bitcoind, monero, starting_balances.clone(), config).await;

        // TODO: This should be done by changing the production code
        let network_seed = network::Seed::new(seed);
        let identity = network_seed.derive_libp2p_identity();
        let peer_id = PeerId::from(identity.public());

        Self {
            seed,
            db_path,
            listen_address,
            peer_id,
            swap_id,
            bitcoin_wallet,
            monero_wallet,
            config,
            starting_balances,
        }
    }

    pub async fn new_swap_as_alice(
        &self,
        swap_amounts: SwapAmounts,
    ) -> (alice::Swap, alice::EventLoop) {
        let initial_state = init_alice_state(
            swap_amounts.btc,
            swap_amounts.xmr,
            self.bitcoin_wallet.clone(),
            self.config,
        )
        .await;

        let (event_loop, event_loop_handle) =
            init_alice_event_loop(self.listen_address.clone(), self.seed);

        let db = Database::open(self.db_path.as_path()).unwrap();
        (
            alice::Swap {
                event_loop_handle,
                bitcoin_wallet: self.bitcoin_wallet.clone(),
                monero_wallet: self.monero_wallet.clone(),
                config: self.config,
                db,
                state: initial_state,
                swap_id: self.swap_id,
            },
            event_loop,
        )
    }

    pub async fn recover_alice_from_db(&self) -> (alice::Swap, alice::EventLoop) {
        // reopen the existing database
        let db = Database::open(self.db_path.clone().as_path()).unwrap();

        let resume_state =
            if let swap::database::Swap::Alice(state) = db.get_state(self.swap_id).unwrap() {
                state.into()
            } else {
                unreachable!()
            };

        let (event_loop, event_loop_handle) =
            init_alice_event_loop(self.listen_address.clone(), self.seed);

        (
            alice::Swap {
                state: resume_state,
                event_loop_handle,
                bitcoin_wallet: self.bitcoin_wallet.clone(),
                monero_wallet: self.monero_wallet.clone(),
                config: self.config,
                swap_id: self.swap_id,
                db,
            },
            event_loop,
        )
    }

    pub fn peer_id(&self) -> PeerId {
        self.peer_id.clone()
    }

    pub fn listen_address(&self) -> Multiaddr {
        self.listen_address.clone()
    }
}

pub struct BobSwapFactory {
    db_path: PathBuf,
    swap_id: Uuid,

    bitcoin_wallet: Arc<bitcoin::Wallet>,
    monero_wallet: Arc<monero::Wallet>,
    config: Config,
    starting_balances: StartingBalances,

    alice_connect_address: Multiaddr,
    alice_connect_peer_id: PeerId,
}

impl BobSwapFactory {
    #[allow(clippy::too_many_arguments)]
    async fn new(
        config: Config,
        swap_id: Uuid,
        monero: &Monero,
        bitcoind: &Bitcoind<'_>,
        starting_balances: StartingBalances,
        alice_connect_address: Multiaddr,
        alice_connect_peer_id: PeerId,
    ) -> Self {
        let db_path = tempdir().unwrap().path().to_path_buf();

        let (bitcoin_wallet, monero_wallet) =
            init_wallets("bob", bitcoind, monero, starting_balances.clone(), config).await;

        Self {
            db_path,
            swap_id,
            bitcoin_wallet,
            monero_wallet,
            config,
            starting_balances,
            alice_connect_address,
            alice_connect_peer_id,
        }
    }

    pub async fn new_swap_as_bob(&self, swap_amounts: SwapAmounts) -> (bob::Swap, bob::EventLoop) {
        let initial_state = init_bob_state(
            swap_amounts.btc,
            swap_amounts.xmr,
            self.bitcoin_wallet.clone(),
            self.config,
        )
        .await;

        let (event_loop, event_loop_handle) = init_bob_event_loop(
            self.alice_connect_peer_id.clone(),
            self.alice_connect_address.clone(),
        );

        let db = Database::open(self.db_path.as_path()).unwrap();

        (
            bob::Swap {
                state: initial_state,
                event_loop_handle,
                db,
                bitcoin_wallet: self.bitcoin_wallet.clone(),
                monero_wallet: self.monero_wallet.clone(),
                swap_id: self.swap_id,
            },
            event_loop,
        )
    }

    pub async fn recover_bob_from_db(&self) -> (bob::Swap, bob::EventLoop) {
        // reopen the existing database
        let db = Database::open(self.db_path.clone().as_path()).unwrap();

        let resume_state =
            if let swap::database::Swap::Bob(state) = db.get_state(self.swap_id).unwrap() {
                state.into()
            } else {
                unreachable!()
            };

        let (event_loop, event_loop_handle) = init_bob_event_loop(
            self.alice_connect_peer_id.clone(),
            self.alice_connect_address.clone(),
        );

        (
            bob::Swap {
                state: resume_state,
                event_loop_handle,
                db,
                bitcoin_wallet: self.bitcoin_wallet.clone(),
                monero_wallet: self.monero_wallet.clone(),
                swap_id: self.swap_id,
            },
            event_loop,
        )
    }
}

#[derive(Debug, Clone)]
struct StartingBalances {
    pub xmr: monero::Amount,
    pub btc: bitcoin::Amount,
}

async fn init_containers(cli: &Cli) -> (Monero, Containers<'_>) {
    let bitcoind = Bitcoind::new(&cli, "0.19.1").unwrap();
    let _ = bitcoind.init(5).await;
    let (monero, monerods) = Monero::new(&cli, None, vec!["alice".to_string(), "bob".to_string()])
        .await
        .unwrap();

    (monero, Containers { bitcoind, monerods })
}

async fn init_wallets(
    name: &str,
    bitcoind: &Bitcoind<'_>,
    monero: &Monero,
    starting_balances: StartingBalances,
    config: Config,
) -> (Arc<bitcoin::Wallet>, Arc<monero::Wallet>) {
    monero
        .init(vec![(name, starting_balances.xmr.as_piconero())])
        .await
        .unwrap();

    let xmr_wallet = Arc::new(swap::monero::Wallet {
        inner: monero.wallet(name).unwrap().client(),
        network: config.monero_network,
    });

    let btc_wallet = Arc::new(
        swap::bitcoin::Wallet::new(name, bitcoind.node_url.clone(), config.bitcoin_network)
            .await
            .unwrap(),
    );

    if starting_balances.btc != bitcoin::Amount::ZERO {
        bitcoind
            .mint(
                btc_wallet.inner.new_address().await.unwrap(),
                starting_balances.btc,
            )
            .await
            .unwrap();
    }

    (btc_wallet, xmr_wallet)
}

async fn init_alice_state(
    btc_to_swap: bitcoin::Amount,
    xmr_to_swap: monero::Amount,
    alice_btc_wallet: Arc<bitcoin::Wallet>,
    config: Config,
) -> AliceState {
    let rng = &mut OsRng;

    let amounts = SwapAmounts {
        btc: btc_to_swap,
        xmr: xmr_to_swap,
    };

    let a = bitcoin::SecretKey::new_random(rng);
    let s_a = cross_curve_dleq::Scalar::random(rng);
    let v_a = monero::PrivateViewKey::new_random(rng);
    let redeem_address = alice_btc_wallet.as_ref().new_address().await.unwrap();
    let punish_address = redeem_address.clone();
    let state0 = alice::State0::new(
        a,
        s_a,
        v_a,
        amounts.btc,
        amounts.xmr,
        config.bitcoin_cancel_timelock,
        config.bitcoin_punish_timelock,
        redeem_address,
        punish_address,
    );

    AliceState::Started { amounts, state0 }
}

fn init_alice_event_loop(
    listen: Multiaddr,
    seed: Seed,
) -> (
    alice::event_loop::EventLoop,
    alice::event_loop::EventLoopHandle,
) {
    let alice_behaviour = alice::Behaviour::new(network::Seed::new(seed));
    let alice_transport = build(alice_behaviour.identity()).unwrap();
    alice::event_loop::EventLoop::new(alice_transport, alice_behaviour, listen).unwrap()
}

async fn init_bob_state(
    btc_to_swap: bitcoin::Amount,
    xmr_to_swap: monero::Amount,
    bob_btc_wallet: Arc<bitcoin::Wallet>,
    config: Config,
) -> BobState {
    let amounts = SwapAmounts {
        btc: btc_to_swap,
        xmr: xmr_to_swap,
    };

    let refund_address = bob_btc_wallet.new_address().await.unwrap();
    let state0 = bob::State0::new(
        &mut OsRng,
        btc_to_swap,
        xmr_to_swap,
        config.bitcoin_cancel_timelock,
        config.bitcoin_punish_timelock,
        refund_address,
        config.monero_finality_confirmations,
    );

    BobState::Started { state0, amounts }
}

fn init_bob_event_loop(
    alice_peer_id: PeerId,
    alice_addr: Multiaddr,
) -> (bob::event_loop::EventLoop, bob::event_loop::EventLoopHandle) {
    let seed = Seed::random().unwrap();
    let bob_behaviour = bob::Behaviour::new(network::Seed::new(seed));
    let bob_transport = build(bob_behaviour.identity()).unwrap();
    bob::event_loop::EventLoop::new(bob_transport, bob_behaviour, alice_peer_id, alice_addr)
        .unwrap()
}

// This is just to keep the containers alive
#[allow(dead_code)]
struct Containers<'a> {
    bitcoind: Bitcoind<'a>,
    monerods: Vec<Container<'a, Cli, image::Monero>>,
}

/// Utility function to initialize logging in the test environment.
/// Note that you have to keep the `_guard` in scope after calling in test:
///
/// ```rust
/// let _guard = init_tracing();
/// ```
fn init_tracing() -> DefaultGuard {
    // converts all log records into tracing events
    // Note: Make sure to initialize without unwrapping, otherwise this causes
    // trouble when running multiple tests.
    let _ = LogTracer::init();

    let global_filter = tracing::Level::WARN;
    let swap_filter = tracing::Level::DEBUG;
    let xmr_btc_filter = tracing::Level::DEBUG;
    let monero_harness_filter = tracing::Level::INFO;
    let bitcoin_harness_filter = tracing::Level::INFO;

    use tracing_subscriber::util::SubscriberInitExt as _;
    tracing_subscriber::fmt()
        .with_env_filter(format!(
            "{},swap={},xmr_btc={},monero_harness={},bitcoin_harness={}",
            global_filter,
            swap_filter,
            xmr_btc_filter,
            monero_harness_filter,
            bitcoin_harness_filter,
        ))
        .set_default()
}