#![warn( unused_extern_crates, missing_debug_implementations, missing_copy_implementations, rust_2018_idioms, clippy::cast_possible_truncation, clippy::cast_sign_loss, clippy::fallible_impl_from, clippy::cast_precision_loss, clippy::cast_possible_wrap, clippy::dbg_macro )] #![forbid(unsafe_code)] //! # monero-harness //! //! A simple lib to start a monero container (incl. monerod and //! monero-wallet-rpc). Provides initialisation methods to generate blocks, //! create and fund accounts, and start a continuous mining task mining blocks //! every BLOCK_TIME_SECS seconds. //! //! Also provides standalone JSON RPC clients for monerod and monero-wallet-rpc. pub mod image; use crate::image::{ MONEROD_DAEMON_CONTAINER_NAME, MONEROD_DEFAULT_NETWORK, MONEROD_RPC_PORT, WALLET_RPC_PORT, }; use anyhow::{anyhow, bail, Result}; use monero_rpc::{ monerod, monerod::MonerodRpc as _, wallet::{self, GetAddress, MoneroWalletRpc as _, Refreshed, Transfer}, }; use std::time::Duration; use testcontainers::{clients::Cli, core::Port, Container, Docker, RunArgs}; use tokio::time; /// How often we mine a block. const BLOCK_TIME_SECS: u64 = 1; /// Poll interval when checking if the wallet has synced with monerod. const WAIT_WALLET_SYNC_MILLIS: u64 = 1000; #[derive(Clone, Debug)] pub struct Monero { monerod: Monerod, wallets: Vec, } impl<'c> Monero { /// Starts a new regtest monero container setup consisting out of 1 monerod /// node and n wallets. The docker container and network will be prefixed /// with a randomly generated `prefix`. One miner wallet is started /// automatically. /// monerod container name is: `prefix`_`monerod` /// network is: `prefix`_`monero` /// miner wallet container name is: `miner` pub async fn new( cli: &'c Cli, additional_wallets: Vec<&'static str>, ) -> Result<(Self, Vec>)> { let prefix = format!("{}_", random_prefix()); let monerod_name = format!("{}{}", prefix, MONEROD_DAEMON_CONTAINER_NAME); let network = format!("{}{}", prefix, MONEROD_DEFAULT_NETWORK); tracing::info!("Starting monerod: {}", monerod_name); let (monerod, monerod_container) = Monerod::new(cli, monerod_name, network)?; let mut containers = vec![monerod_container]; let mut wallets = vec![]; let miner = "miner"; tracing::info!("Starting miner wallet: {}", miner); let (miner_wallet, miner_container) = MoneroWalletRpc::new(cli, &miner, &monerod, prefix.clone()).await?; wallets.push(miner_wallet); containers.push(miner_container); for wallet in additional_wallets.iter() { tracing::info!("Starting wallet: {}", wallet); let (wallet, container) = MoneroWalletRpc::new(cli, &wallet, &monerod, prefix.clone()).await?; wallets.push(wallet); containers.push(container); } Ok((Self { monerod, wallets }, containers)) } pub fn monerod(&self) -> &Monerod { &self.monerod } pub fn wallet(&self, name: &str) -> Result<&MoneroWalletRpc> { let wallet = self .wallets .iter() .find(|wallet| wallet.name.eq(&name)) .ok_or_else(|| anyhow!("Could not find wallet container."))?; Ok(wallet) } pub async fn init_miner(&self) -> Result<()> { let miner_wallet = self.wallet("miner")?; let miner_address = miner_wallet.address().await?.address; // generate the first 70 as bulk let monerod = &self.monerod; let res = monerod .client() .generateblocks(70, miner_address.clone()) .await?; tracing::info!("Generated {:?} blocks", res.blocks.len()); miner_wallet.refresh().await?; Ok(()) } pub async fn init_wallet(&self, name: &str, amount_in_outputs: Vec) -> Result<()> { let miner_wallet = self.wallet("miner")?; let miner_address = miner_wallet.address().await?.address; let monerod = &self.monerod; let wallet = self.wallet(name)?; let address = wallet.address().await?.address; for amount in amount_in_outputs { if amount > 0 { miner_wallet.transfer(&address, amount).await?; tracing::info!("Funded {} wallet with {}", wallet.name, amount); monerod .client() .generateblocks(10, miner_address.clone()) .await?; wallet.refresh().await?; } } Ok(()) } pub async fn start_miner(&self) -> Result<()> { let miner_wallet = self.wallet("miner")?; let miner_address = miner_wallet.address().await?.address; let monerod = &self.monerod; monerod.start_miner(&miner_address).await?; tracing::info!("Waiting for miner wallet to catch up..."); let block_height = monerod.client().get_block_count().await?.count; miner_wallet .wait_for_wallet_height(block_height) .await .unwrap(); Ok(()) } pub async fn init_and_start_miner(&self) -> Result<()> { self.init_miner().await?; self.start_miner().await?; Ok(()) } } fn random_prefix() -> String { use rand::Rng; rand::thread_rng() .sample_iter(rand::distributions::Alphanumeric) .take(4) .collect() } #[derive(Clone, Debug)] pub struct Monerod { rpc_port: u16, name: String, network: String, } #[derive(Clone, Debug)] pub struct MoneroWalletRpc { rpc_port: u16, name: String, network: String, } impl<'c> Monerod { /// Starts a new regtest monero container. fn new( cli: &'c Cli, name: String, network: String, ) -> Result<(Self, Container<'c, Cli, image::Monero>)> { let monerod_rpc_port: u16 = port_check::free_local_port().ok_or_else(|| anyhow!("Could not retrieve free port"))?; let image = image::Monero::default(); let run_args = RunArgs::default() .with_name(name.clone()) .with_network(network.clone()) .with_mapped_port(Port { local: monerod_rpc_port, internal: MONEROD_RPC_PORT, }); let docker = cli.run_with_args(image, run_args); Ok(( Self { rpc_port: monerod_rpc_port, name, network, }, docker, )) } pub fn client(&self) -> monerod::Client { monerod::Client::localhost(self.rpc_port) } /// Spawns a task to mine blocks in a regular interval to the provided /// address pub async fn start_miner(&self, miner_wallet_address: &str) -> Result<()> { let monerod = self.client(); let _ = tokio::spawn(mine(monerod, miner_wallet_address.to_string())); Ok(()) } } impl<'c> MoneroWalletRpc { /// Starts a new wallet container which is attached to /// MONEROD_DEFAULT_NETWORK and MONEROD_DAEMON_CONTAINER_NAME async fn new( cli: &'c Cli, name: &str, monerod: &Monerod, prefix: String, ) -> Result<(Self, Container<'c, Cli, image::Monero>)> { let wallet_rpc_port: u16 = port_check::free_local_port().ok_or_else(|| anyhow!("Could not retrieve free port"))?; let daemon_address = format!("{}:{}", monerod.name, MONEROD_RPC_PORT); let image = image::Monero::wallet(&name, daemon_address); let network = monerod.network.clone(); let run_args = RunArgs::default() // prefix the container name so we can run multiple tests .with_name(format!("{}{}", prefix, name)) .with_network(network.clone()) .with_mapped_port(Port { local: wallet_rpc_port, internal: WALLET_RPC_PORT, }); let docker = cli.run_with_args(image, run_args); // create new wallet wallet::Client::localhost(wallet_rpc_port) .create_wallet(name.to_owned(), "English".to_owned()) .await .unwrap(); Ok(( Self { rpc_port: wallet_rpc_port, name: name.to_string(), network, }, docker, )) } pub fn client(&self) -> wallet::Client { wallet::Client::localhost(self.rpc_port) } // It takes a little while for the wallet to sync with monerod. pub async fn wait_for_wallet_height(&self, height: u32) -> Result<()> { let mut retry: u8 = 0; while self.client().get_height().await?.height < height { if retry >= 30 { // ~30 seconds bail!("Wallet could not catch up with monerod after 30 retries.") } time::sleep(Duration::from_millis(WAIT_WALLET_SYNC_MILLIS)).await; retry += 1; } Ok(()) } /// Sends amount to address pub async fn transfer(&self, address: &str, amount: u64) -> Result { Ok(self.client().transfer_single(0, amount, address).await?) } pub async fn address(&self) -> Result { Ok(self.client().get_address(0).await?) } pub async fn balance(&self) -> Result { self.client().refresh().await?; let balance = self.client().get_balance(0).await?.balance; Ok(balance) } pub async fn refresh(&self) -> Result { Ok(self.client().refresh().await?) } } /// Mine a block ever BLOCK_TIME_SECS seconds. async fn mine(monerod: monerod::Client, reward_address: String) -> Result<()> { loop { time::sleep(Duration::from_secs(BLOCK_TIME_SECS)).await; monerod.generateblocks(1, reward_address.clone()).await?; } }