Directory Restructure (#1163)

* Move tests -> testing

* Directory restructure

* Update Cargo.toml during restructure

* Update Makefile during restructure

* Fix arbitrary path

testing/eth1_test_rig/src/ganache.rs

@@ -0,0 +1,163 @@
+use futures::compat::Future01CompatExt;
+use serde_json::json;
+use std::io::prelude::*;
+use std::io::BufReader;
+use std::net::TcpListener;
+use std::process::{Child, Command, Stdio};
+use std::sync::Arc;
+use std::time::{Duration, Instant};
+use web3::{
+    transports::{EventLoopHandle, Http},
+    Transport, Web3,
+};
+
+/// How long we will wait for ganache to indicate that it is ready.
+const GANACHE_STARTUP_TIMEOUT_MILLIS: u64 = 10_000;
+
+/// Provides a dedicated `ganachi-cli` instance with a connected `Web3` instance.
+///
+/// Requires that `ganachi-cli` is installed and available on `PATH`.
+pub struct GanacheInstance {
+    pub port: u16,
+    child: Child,
+    _event_loop: Arc<EventLoopHandle>,
+    pub web3: Web3<Http>,
+}
+
+impl GanacheInstance {
+    /// Start a new `ganache-cli` process, waiting until it indicates that it is ready to accept
+    /// RPC connections.
+    pub fn new() -> Result<Self, String> {
+        let port = unused_port()?;
+
+        let mut child = Command::new("ganache-cli")
+            .stdout(Stdio::piped())
+            .arg("--defaultBalanceEther")
+            .arg("1000000000")
+            .arg("--gasLimit")
+            .arg("1000000000")
+            .arg("--accounts")
+            .arg("10")
+            .arg("--port")
+            .arg(format!("{}", port))
+            .arg("--mnemonic")
+            .arg("\"vast thought differ pull jewel broom cook wrist tribe word before omit\"")
+            .spawn()
+            .map_err(|e| {
+                format!(
+                    "Failed to start ganache-cli. \
+                     Is it ganache-cli installed and available on $PATH? Error: {:?}",
+                    e
+                )
+            })?;
+
+        let stdout = child
+            .stdout
+            .ok_or_else(|| "Unable to get stdout for ganache child process")?;
+
+        let start = Instant::now();
+        let mut reader = BufReader::new(stdout);
+        loop {
+            if start + Duration::from_millis(GANACHE_STARTUP_TIMEOUT_MILLIS) <= Instant::now() {
+                break Err(
+                    "Timed out waiting for ganache to start. Is ganache-cli installed?".to_string(),
+                );
+            }
+
+            let mut line = String::new();
+            if let Err(e) = reader.read_line(&mut line) {
+                break Err(format!("Failed to read line from ganache process: {:?}", e));
+            } else if line.starts_with("Listening on") {
+                break Ok(());
+            } else {
+                continue;
+            }
+        }?;
+
+        let (event_loop, transport) = Http::new(&endpoint(port)).map_err(|e| {
+            format!(
+                "Failed to start HTTP transport connected to ganache: {:?}",
+                e
+            )
+        })?;
+        let web3 = Web3::new(transport);
+
+        child.stdout = Some(reader.into_inner());
+
+        Ok(Self {
+            child,
+            port,
+            _event_loop: Arc::new(event_loop),
+            web3,
+        })
+    }
+
+    /// Returns the endpoint that this instance is listening on.
+    pub fn endpoint(&self) -> String {
+        endpoint(self.port)
+    }
+
+    /// Increase the timestamp on future blocks by `increase_by` seconds.
+    pub async fn increase_time(&self, increase_by: u64) -> Result<(), String> {
+        self.web3
+            .transport()
+            .execute("evm_increaseTime", vec![json!(increase_by)])
+            .compat()
+            .await
+            .map(|_json_value| ())
+            .map_err(|e| format!("Failed to increase time on EVM (is this ganache?): {:?}", e))
+    }
+
+    /// Returns the current block number, as u64
+    pub async fn block_number(&self) -> Result<u64, String> {
+        self.web3
+            .eth()
+            .block_number()
+            .compat()
+            .await
+            .map(|v| v.as_u64())
+            .map_err(|e| format!("Failed to get block number: {:?}", e))
+    }
+
+    /// Mines a single block.
+    pub async fn evm_mine(&self) -> Result<(), String> {
+        self.web3
+            .transport()
+            .execute("evm_mine", vec![])
+            .compat()
+            .await
+            .map(|_| ())
+            .map_err(|_| {
+                "utils should mine new block with evm_mine (only works with ganache-cli!)"
+                    .to_string()
+            })
+    }
+}
+
+fn endpoint(port: u16) -> String {
+    format!("http://localhost:{}", port)
+}
+
+/// A bit of hack to find an unused TCP port.
+///
+/// Does not guarantee that the given port is unused after the function exists, just that it was
+/// unused before the function started (i.e., it does not reserve a port).
+pub fn unused_port() -> Result<u16, String> {
+    let listener = TcpListener::bind("127.0.0.1:0")
+        .map_err(|e| format!("Failed to create TCP listener to find unused port: {:?}", e))?;
+
+    let local_addr = listener.local_addr().map_err(|e| {
+        format!(
+            "Failed to read TCP listener local_addr to find unused port: {:?}",
+            e
+        )
+    })?;
+
+    Ok(local_addr.port())
+}
+
+impl Drop for GanacheInstance {
+    fn drop(&mut self) {
+        let _ = self.child.kill();
+    }
+}

testing/eth1_test_rig/src/lib.rs

@@ -0,0 +1,298 @@
+//! Provides utilities for deploying and manipulating the eth2 deposit contract on the eth1 chain.
+//!
+//! Presently used with [`ganache-cli`](https://github.com/trufflesuite/ganache-cli) to simulate
+//! the deposit contract for testing beacon node eth1 integration.
+//!
+//! Not tested to work with actual clients (e.g., geth). It should work fine, however there may be
+//! some initial issues.
+mod ganache;
+
+use deposit_contract::{
+    encode_eth1_tx_data, testnet, ABI, BYTECODE, CONTRACT_DEPLOY_GAS, DEPOSIT_GAS,
+};
+use futures::compat::Future01CompatExt;
+use ganache::GanacheInstance;
+use std::time::Duration;
+use tokio::time::delay_for;
+use types::DepositData;
+use types::{test_utils::generate_deterministic_keypair, EthSpec, Hash256, Keypair, Signature};
+use web3::contract::{Contract, Options};
+use web3::transports::Http;
+use web3::types::{Address, TransactionRequest, U256};
+use web3::Web3;
+
+pub const DEPLOYER_ACCOUNTS_INDEX: usize = 0;
+pub const DEPOSIT_ACCOUNTS_INDEX: usize = 0;
+
+/// Provides a dedicated ganache-cli instance with the deposit contract already deployed.
+pub struct GanacheEth1Instance {
+    pub ganache: GanacheInstance,
+    pub deposit_contract: DepositContract,
+}
+
+impl GanacheEth1Instance {
+    pub async fn new() -> Result<Self, String> {
+        let ganache = GanacheInstance::new()?;
+        DepositContract::deploy(ganache.web3.clone(), 0, None)
+            .await
+            .map(|deposit_contract| Self {
+                ganache,
+                deposit_contract,
+            })
+    }
+
+    pub fn endpoint(&self) -> String {
+        self.ganache.endpoint()
+    }
+
+    pub fn web3(&self) -> Web3<Http> {
+        self.ganache.web3.clone()
+    }
+}
+
+/// Deploys and provides functions for the eth2 deposit contract, deployed on the eth1 chain.
+#[derive(Clone, Debug)]
+pub struct DepositContract {
+    web3: Web3<Http>,
+    contract: Contract<Http>,
+}
+
+impl DepositContract {
+    pub async fn deploy(
+        web3: Web3<Http>,
+        confirmations: usize,
+        password: Option<String>,
+    ) -> Result<Self, String> {
+        Self::deploy_bytecode(web3, confirmations, BYTECODE, ABI, password).await
+    }
+
+    pub async fn deploy_testnet(
+        web3: Web3<Http>,
+        confirmations: usize,
+        password: Option<String>,
+    ) -> Result<Self, String> {
+        Self::deploy_bytecode(
+            web3,
+            confirmations,
+            testnet::BYTECODE,
+            testnet::ABI,
+            password,
+        )
+        .await
+    }
+
+    async fn deploy_bytecode(
+        web3: Web3<Http>,
+        confirmations: usize,
+        bytecode: &[u8],
+        abi: &[u8],
+        password: Option<String>,
+    ) -> Result<Self, String> {
+        let address = deploy_deposit_contract(
+            web3.clone(),
+            confirmations,
+            bytecode.to_vec(),
+            abi.to_vec(),
+            password,
+        )
+        .await
+        .map_err(|e| {
+            format!(
+                "Failed to deploy contract: {}. Is scripts/ganache_tests_node.sh running?.",
+                e
+            )
+        })?;
+        Contract::from_json(web3.clone().eth(), address, ABI)
+            .map_err(|e| format!("Failed to init contract: {:?}", e))
+            .map(move |contract| Self { contract, web3 })
+    }
+
+    /// The deposit contract's address in `0x00ab...` format.
+    pub fn address(&self) -> String {
+        format!("0x{:x}", self.contract.address())
+    }
+
+    /// A helper to return a fully-formed `DepositData`. Does not submit the deposit data to the
+    /// smart contact.
+    pub fn deposit_helper<E: EthSpec>(
+        &self,
+        keypair: Keypair,
+        withdrawal_credentials: Hash256,
+        amount: u64,
+    ) -> DepositData {
+        let mut deposit = DepositData {
+            pubkey: keypair.pk.into(),
+            withdrawal_credentials,
+            amount,
+            signature: Signature::empty_signature().into(),
+        };
+
+        deposit.signature = deposit.create_signature(&keypair.sk, &E::default_spec());
+
+        deposit
+    }
+
+    /// Creates a random, valid deposit and submits it to the deposit contract.
+    ///
+    /// The keypairs are created randomly and destroyed.
+    pub async fn deposit_random<E: EthSpec>(&self) -> Result<(), String> {
+        let keypair = Keypair::random();
+
+        let mut deposit = DepositData {
+            pubkey: keypair.pk.into(),
+            withdrawal_credentials: Hash256::zero(),
+            amount: 32_000_000_000,
+            signature: Signature::empty_signature().into(),
+        };
+
+        deposit.signature = deposit.create_signature(&keypair.sk, &E::default_spec());
+
+        self.deposit(deposit).await
+    }
+
+    /// Perfoms a blocking deposit.
+    pub async fn deposit(&self, deposit_data: DepositData) -> Result<(), String> {
+        self.deposit_async(deposit_data)
+            .await
+            .map_err(|e| format!("Deposit failed: {:?}", e))
+    }
+
+    pub async fn deposit_deterministic_async<E: EthSpec>(
+        &self,
+        keypair_index: usize,
+        amount: u64,
+    ) -> Result<(), String> {
+        let keypair = generate_deterministic_keypair(keypair_index);
+
+        let mut deposit = DepositData {
+            pubkey: keypair.pk.into(),
+            withdrawal_credentials: Hash256::zero(),
+            amount,
+            signature: Signature::empty_signature().into(),
+        };
+
+        deposit.signature = deposit.create_signature(&keypair.sk, &E::default_spec());
+
+        self.deposit_async(deposit).await
+    }
+
+    /// Performs a non-blocking deposit.
+    pub async fn deposit_async(&self, deposit_data: DepositData) -> Result<(), String> {
+        let from = self
+            .web3
+            .eth()
+            .accounts()
+            .compat()
+            .await
+            .map_err(|e| format!("Failed to get accounts: {:?}", e))
+            .and_then(|accounts| {
+                accounts
+                    .get(DEPOSIT_ACCOUNTS_INDEX)
+                    .cloned()
+                    .ok_or_else(|| "Insufficient accounts for deposit".to_string())
+            })?;
+        let tx_request = TransactionRequest {
+            from,
+            to: Some(self.contract.address()),
+            gas: Some(U256::from(DEPOSIT_GAS)),
+            gas_price: None,
+            value: Some(from_gwei(deposit_data.amount)),
+            // Note: the reason we use this `TransactionRequest` instead of just using the
+            // function in `self.contract` is so that the `eth1_tx_data` function gets used
+            // during testing.
+            //
+            // It's important that `eth1_tx_data` stays correct and does not suffer from
+            // code-rot.
+            data: encode_eth1_tx_data(&deposit_data).map(Into::into).ok(),
+            nonce: None,
+            condition: None,
+        };
+
+        self.web3
+            .eth()
+            .send_transaction(tx_request)
+            .compat()
+            .await
+            .map_err(|e| format!("Failed to call deposit fn: {:?}", e))?;
+        Ok(())
+    }
+
+    /// Peforms many deposits, each preceded by a delay.
+    pub async fn deposit_multiple(&self, deposits: Vec<DelayThenDeposit>) -> Result<(), String> {
+        for deposit in deposits.into_iter() {
+            delay_for(deposit.delay).await;
+            self.deposit_async(deposit.deposit).await?;
+        }
+        Ok(())
+    }
+}
+
+/// Describes a deposit and a delay that should should precede it's submission to the deposit
+/// contract.
+#[derive(Clone)]
+pub struct DelayThenDeposit {
+    /// Wait this duration ...
+    pub delay: Duration,
+    /// ... then submit this deposit.
+    pub deposit: DepositData,
+}
+
+fn from_gwei(gwei: u64) -> U256 {
+    U256::from(gwei) * U256::exp10(9)
+}
+
+/// Deploys the deposit contract to the given web3 instance using the account with index
+/// `DEPLOYER_ACCOUNTS_INDEX`.
+async fn deploy_deposit_contract(
+    web3: Web3<Http>,
+    confirmations: usize,
+    bytecode: Vec<u8>,
+    abi: Vec<u8>,
+    password_opt: Option<String>,
+) -> Result<Address, String> {
+    let bytecode = String::from_utf8(bytecode).expect("bytecode must be valid utf8");
+
+    let from_address = web3
+        .eth()
+        .accounts()
+        .compat()
+        .await
+        .map_err(|e| format!("Failed to get accounts: {:?}", e))
+        .and_then(|accounts| {
+            accounts
+                .get(DEPLOYER_ACCOUNTS_INDEX)
+                .cloned()
+                .ok_or_else(|| "Insufficient accounts for deployer".to_string())
+        })?;
+
+    let deploy_address = if let Some(password) = password_opt {
+        let result = web3
+            .personal()
+            .unlock_account(from_address, &password, None)
+            .compat()
+            .await;
+        match result {
+            Ok(true) => return Ok(from_address),
+            Ok(false) => return Err("Eth1 node refused to unlock account".to_string()),
+            Err(e) => return Err(format!("Eth1 unlock request failed: {:?}", e)),
+        };
+    } else {
+        from_address
+    };
+
+    let pending_contract = Contract::deploy(web3.eth(), &abi)
+        .map_err(|e| format!("Unable to build contract deployer: {:?}", e))?
+        .confirmations(confirmations)
+        .options(Options {
+            gas: Some(U256::from(CONTRACT_DEPLOY_GAS)),
+            ..Options::default()
+        })
+        .execute(bytecode, (), deploy_address)
+        .map_err(|e| format!("Failed to execute deployment: {:?}", e))?;
+
+    pending_contract
+        .compat()
+        .await
+        .map(|contract| contract.address())
+        .map_err(|e| format!("Unable to resolve pending contract: {:?}", e))
+}