2020-09-28 06:18:50 +00:00
|
|
|
#![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;
|
|
|
|
|
2021-02-22 01:32:15 +00:00
|
|
|
use crate::image::{
|
|
|
|
MONEROD_DAEMON_CONTAINER_NAME, MONEROD_DEFAULT_NETWORK, MONEROD_RPC_PORT, WALLET_RPC_PORT,
|
2020-09-28 06:18:50 +00:00
|
|
|
};
|
2021-01-21 00:20:57 +00:00
|
|
|
use anyhow::{anyhow, bail, Result};
|
2021-02-22 01:32:15 +00:00
|
|
|
use monero_rpc::{
|
|
|
|
monerod,
|
|
|
|
wallet::{self, GetAddress, Refreshed, Transfer},
|
|
|
|
};
|
2021-01-21 00:20:57 +00:00
|
|
|
use std::time::Duration;
|
|
|
|
use testcontainers::{clients::Cli, core::Port, Container, Docker, RunArgs};
|
|
|
|
use tokio::time;
|
2020-09-28 06:18:50 +00:00
|
|
|
|
|
|
|
/// 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;
|
|
|
|
|
2020-11-01 23:02:28 +00:00
|
|
|
#[derive(Clone, Debug)]
|
2020-10-20 01:18:27 +00:00
|
|
|
pub struct Monero {
|
2020-11-02 05:00:35 +00:00
|
|
|
monerod: Monerod,
|
|
|
|
wallets: Vec<MoneroWalletRpc>,
|
|
|
|
}
|
|
|
|
impl<'c> Monero {
|
|
|
|
/// Starts a new regtest monero container setup consisting out of 1 monerod
|
2021-03-02 23:56:49 +00:00
|
|
|
/// 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`
|
2020-11-02 05:00:35 +00:00
|
|
|
pub async fn new(
|
|
|
|
cli: &'c Cli,
|
|
|
|
additional_wallets: Vec<String>,
|
|
|
|
) -> Result<(Self, Vec<Container<'c, Cli, image::Monero>>)> {
|
2021-03-02 23:56:49 +00:00
|
|
|
let prefix = format!("{}_", random_prefix());
|
2020-11-03 00:21:44 +00:00
|
|
|
let monerod_name = format!("{}{}", prefix, MONEROD_DAEMON_CONTAINER_NAME);
|
|
|
|
let network = format!("{}{}", prefix, MONEROD_DEFAULT_NETWORK);
|
2020-11-02 05:00:35 +00:00
|
|
|
|
2021-03-02 23:56:49 +00:00
|
|
|
tracing::info!("Starting monerod: {}", monerod_name);
|
2020-11-02 05:00:35 +00:00
|
|
|
let (monerod, monerod_container) = Monerod::new(cli, monerod_name, network)?;
|
|
|
|
let mut containers = vec![monerod_container];
|
|
|
|
let mut wallets = vec![];
|
|
|
|
|
2021-03-02 23:56:49 +00:00
|
|
|
let miner = "miner";
|
|
|
|
tracing::info!("Starting miner wallet: {}", miner);
|
2020-11-02 07:58:52 +00:00
|
|
|
let (miner_wallet, miner_container) = MoneroWalletRpc::new(cli, &miner, &monerod).await?;
|
2020-11-02 05:00:35 +00:00
|
|
|
|
|
|
|
wallets.push(miner_wallet);
|
|
|
|
containers.push(miner_container);
|
|
|
|
for wallet in additional_wallets.iter() {
|
2021-03-02 23:56:49 +00:00
|
|
|
tracing::info!("Starting wallet: {}", wallet);
|
2020-11-02 07:58:52 +00:00
|
|
|
let (wallet, container) = MoneroWalletRpc::new(cli, &wallet, &monerod).await?;
|
2020-11-02 05:00:35 +00:00
|
|
|
wallets.push(wallet);
|
|
|
|
containers.push(container);
|
|
|
|
}
|
|
|
|
|
2021-03-02 23:56:49 +00:00
|
|
|
Ok((Self { monerod, wallets }, containers))
|
2020-11-02 05:00:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
pub fn monerod(&self) -> &Monerod {
|
|
|
|
&self.monerod
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn wallet(&self, name: &str) -> Result<&MoneroWalletRpc> {
|
|
|
|
let wallet = self
|
|
|
|
.wallets
|
|
|
|
.iter()
|
2020-11-02 07:58:52 +00:00
|
|
|
.find(|wallet| wallet.name.eq(&name))
|
2020-11-02 05:00:35 +00:00
|
|
|
.ok_or_else(|| anyhow!("Could not find wallet container."))?;
|
|
|
|
|
|
|
|
Ok(wallet)
|
|
|
|
}
|
|
|
|
|
2020-11-03 00:46:25 +00:00
|
|
|
pub async fn init(&self, wallet_amount: Vec<(&str, u64)>) -> Result<()> {
|
2020-11-02 10:12:38 +00:00
|
|
|
let miner_wallet = self.wallet("miner")?;
|
|
|
|
let miner_address = miner_wallet.address().await?.address;
|
|
|
|
|
|
|
|
// generate the first 70 as bulk
|
|
|
|
let monerod = &self.monerod;
|
2020-12-09 23:10:23 +00:00
|
|
|
let res = monerod.client().generate_blocks(70, &miner_address).await?;
|
|
|
|
tracing::info!("Generated {:?} blocks", res.blocks.len());
|
2020-11-02 10:12:38 +00:00
|
|
|
miner_wallet.refresh().await?;
|
|
|
|
|
2020-11-03 00:46:25 +00:00
|
|
|
for (wallet, amount) in wallet_amount.iter() {
|
|
|
|
if *amount > 0 {
|
|
|
|
let wallet = self.wallet(wallet)?;
|
|
|
|
let address = wallet.address().await?.address;
|
|
|
|
miner_wallet.transfer(&address, *amount).await?;
|
|
|
|
tracing::info!("Funded {} wallet with {}", wallet.name, amount);
|
2020-11-03 00:49:53 +00:00
|
|
|
monerod.client().generate_blocks(10, &miner_address).await?;
|
2020-11-03 00:46:25 +00:00
|
|
|
wallet.refresh().await?;
|
|
|
|
}
|
2020-11-02 10:12:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
monerod.start_miner(&miner_address).await?;
|
|
|
|
|
|
|
|
tracing::info!("Waiting for miner wallet to catch up...");
|
2020-11-30 20:41:22 +00:00
|
|
|
let block_height = monerod.client().get_block_count().await?;
|
|
|
|
miner_wallet
|
|
|
|
.wait_for_wallet_height(block_height)
|
|
|
|
.await
|
|
|
|
.unwrap();
|
2020-11-02 10:12:38 +00:00
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
2020-11-02 05:00:35 +00:00
|
|
|
}
|
|
|
|
|
2020-11-03 01:25:22 +00:00
|
|
|
fn random_prefix() -> String {
|
|
|
|
use rand::Rng;
|
|
|
|
const CHARSET: &[u8] = b"abcdefghijklmnopqrstuvwxyz";
|
|
|
|
const LEN: usize = 4;
|
|
|
|
let mut rng = rand::thread_rng();
|
|
|
|
|
|
|
|
let prefix: String = (0..LEN)
|
|
|
|
.map(|_| {
|
|
|
|
let idx = rng.gen_range(0, CHARSET.len());
|
|
|
|
CHARSET[idx] as char
|
|
|
|
})
|
|
|
|
.collect();
|
|
|
|
prefix
|
|
|
|
}
|
|
|
|
|
2020-11-02 05:00:35 +00:00
|
|
|
#[derive(Clone, Debug)]
|
|
|
|
pub struct Monerod {
|
2020-11-01 23:02:28 +00:00
|
|
|
rpc_port: u16,
|
|
|
|
name: String,
|
2020-11-02 05:00:35 +00:00
|
|
|
network: String,
|
2020-09-28 06:18:50 +00:00
|
|
|
}
|
|
|
|
|
2020-11-02 05:00:35 +00:00
|
|
|
#[derive(Clone, Debug)]
|
|
|
|
pub struct MoneroWalletRpc {
|
|
|
|
rpc_port: u16,
|
|
|
|
name: String,
|
|
|
|
network: String,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'c> Monerod {
|
2020-09-28 06:18:50 +00:00
|
|
|
/// Starts a new regtest monero container.
|
2020-11-02 05:00:35 +00:00
|
|
|
fn new(
|
|
|
|
cli: &'c Cli,
|
|
|
|
name: String,
|
|
|
|
network: String,
|
|
|
|
) -> Result<(Self, Container<'c, Cli, image::Monero>)> {
|
2020-10-23 00:28:58 +00:00
|
|
|
let monerod_rpc_port: u16 =
|
|
|
|
port_check::free_local_port().ok_or_else(|| anyhow!("Could not retrieve free port"))?;
|
2020-09-28 06:18:50 +00:00
|
|
|
|
2021-02-16 06:09:09 +00:00
|
|
|
let image = image::Monero::default();
|
2020-10-29 01:52:29 +00:00
|
|
|
let run_args = RunArgs::default()
|
2020-11-02 05:00:35 +00:00
|
|
|
.with_name(name.clone())
|
2021-02-16 06:09:09 +00:00
|
|
|
.with_network(network.clone())
|
|
|
|
.with_mapped_port(Port {
|
|
|
|
local: monerod_rpc_port,
|
|
|
|
internal: MONEROD_RPC_PORT,
|
|
|
|
});
|
2020-11-01 23:02:28 +00:00
|
|
|
let docker = cli.run_with_args(image, run_args);
|
|
|
|
|
|
|
|
Ok((
|
|
|
|
Self {
|
|
|
|
rpc_port: monerod_rpc_port,
|
2020-11-02 05:00:35 +00:00
|
|
|
name,
|
|
|
|
network,
|
2020-11-01 23:02:28 +00:00
|
|
|
},
|
|
|
|
docker,
|
|
|
|
))
|
|
|
|
}
|
|
|
|
|
2020-11-03 00:49:53 +00:00
|
|
|
pub fn client(&self) -> monerod::Client {
|
2020-11-02 05:00:35 +00:00
|
|
|
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<()> {
|
2020-11-03 00:49:53 +00:00
|
|
|
let monerod = self.client();
|
2020-11-02 10:12:38 +00:00
|
|
|
let _ = tokio::spawn(mine(monerod, miner_wallet_address.to_string()));
|
2020-11-02 05:00:35 +00:00
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'c> MoneroWalletRpc {
|
2020-11-02 03:42:08 +00:00
|
|
|
/// Starts a new wallet container which is attached to
|
|
|
|
/// MONEROD_DEFAULT_NETWORK and MONEROD_DAEMON_CONTAINER_NAME
|
2020-11-02 05:00:35 +00:00
|
|
|
async fn new(
|
2020-11-01 23:02:28 +00:00
|
|
|
cli: &'c Cli,
|
|
|
|
name: &str,
|
2020-11-02 05:00:35 +00:00
|
|
|
monerod: &Monerod,
|
2020-11-01 23:02:28 +00:00
|
|
|
) -> 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"))?;
|
|
|
|
|
2020-11-02 05:00:35 +00:00
|
|
|
let daemon_address = format!("{}:{}", monerod.name, MONEROD_RPC_PORT);
|
2021-02-16 06:09:09 +00:00
|
|
|
let image = image::Monero::wallet(&name, daemon_address);
|
2020-11-01 23:02:28 +00:00
|
|
|
|
2020-11-02 05:00:35 +00:00
|
|
|
let network = monerod.network.clone();
|
2020-11-01 23:02:28 +00:00
|
|
|
let run_args = RunArgs::default()
|
|
|
|
.with_name(name)
|
2021-02-16 06:09:09 +00:00
|
|
|
.with_network(network.clone())
|
|
|
|
.with_mapped_port(Port {
|
|
|
|
local: wallet_rpc_port,
|
|
|
|
internal: WALLET_RPC_PORT,
|
|
|
|
});
|
2020-10-29 01:52:29 +00:00
|
|
|
let docker = cli.run_with_args(image, run_args);
|
2020-09-28 06:18:50 +00:00
|
|
|
|
2020-11-01 23:02:28 +00:00
|
|
|
// create new wallet
|
|
|
|
wallet::Client::localhost(wallet_rpc_port)
|
|
|
|
.create_wallet(name)
|
|
|
|
.await
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
Ok((
|
|
|
|
Self {
|
|
|
|
rpc_port: wallet_rpc_port,
|
|
|
|
name: name.to_string(),
|
2020-11-02 05:00:35 +00:00
|
|
|
network,
|
2020-11-01 23:02:28 +00:00
|
|
|
},
|
|
|
|
docker,
|
|
|
|
))
|
2020-09-28 06:18:50 +00:00
|
|
|
}
|
|
|
|
|
2020-11-03 00:49:53 +00:00
|
|
|
pub fn client(&self) -> wallet::Client {
|
2020-11-01 23:02:28 +00:00
|
|
|
wallet::Client::localhost(self.rpc_port)
|
|
|
|
}
|
2020-09-28 06:18:50 +00:00
|
|
|
|
2020-11-01 23:02:28 +00:00
|
|
|
// 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;
|
2020-11-03 00:49:53 +00:00
|
|
|
while self.client().block_height().await?.height < height {
|
2020-11-01 23:02:28 +00:00
|
|
|
if retry >= 30 {
|
|
|
|
// ~30 seconds
|
|
|
|
bail!("Wallet could not catch up with monerod after 30 retries.")
|
|
|
|
}
|
2021-01-15 05:58:16 +00:00
|
|
|
time::sleep(Duration::from_millis(WAIT_WALLET_SYNC_MILLIS)).await;
|
2020-11-01 23:02:28 +00:00
|
|
|
retry += 1;
|
|
|
|
}
|
|
|
|
Ok(())
|
|
|
|
}
|
2020-11-02 03:42:08 +00:00
|
|
|
|
|
|
|
/// Sends amount to address
|
|
|
|
pub async fn transfer(&self, address: &str, amount: u64) -> Result<Transfer> {
|
2020-11-03 00:49:53 +00:00
|
|
|
self.client().transfer(0, amount, address).await
|
2020-11-02 03:42:08 +00:00
|
|
|
}
|
2020-11-01 23:02:28 +00:00
|
|
|
|
2020-11-02 05:00:35 +00:00
|
|
|
pub async fn address(&self) -> Result<GetAddress> {
|
2020-11-03 00:49:53 +00:00
|
|
|
self.client().get_address(0).await
|
2020-11-02 05:00:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
pub async fn balance(&self) -> Result<u64> {
|
2020-11-03 00:49:53 +00:00
|
|
|
self.client().refresh().await?;
|
|
|
|
self.client().get_balance(0).await
|
2020-11-02 05:00:35 +00:00
|
|
|
}
|
2020-11-02 10:12:38 +00:00
|
|
|
|
|
|
|
pub async fn refresh(&self) -> Result<Refreshed> {
|
2020-11-03 00:49:53 +00:00
|
|
|
self.client().refresh().await
|
2020-11-02 10:12:38 +00:00
|
|
|
}
|
2020-11-02 05:00:35 +00:00
|
|
|
}
|
2020-11-01 23:02:28 +00:00
|
|
|
/// Mine a block ever BLOCK_TIME_SECS seconds.
|
|
|
|
async fn mine(monerod: monerod::Client, reward_address: String) -> Result<()> {
|
|
|
|
loop {
|
2021-01-15 05:58:16 +00:00
|
|
|
time::sleep(Duration::from_secs(BLOCK_TIME_SECS)).await;
|
2020-11-01 23:02:28 +00:00
|
|
|
monerod.generate_blocks(1, &reward_address).await?;
|
|
|
|
}
|
2020-09-28 06:18:50 +00:00
|
|
|
}
|