ethers-rs/ethers-providers/tests/provider.rs

#![allow(unused_braces)]
use ethers::providers::{
    gas_oracle::{EthGasStation, Etherchain, Etherscan, GasCategory, GasNow, GasOracle},
    Http, Provider,
};
use std::{convert::TryFrom, time::Duration};

#[cfg(not(feature = "celo"))]
mod eth_tests {
    use super::*;
    use ethers::{
        providers::JsonRpcClient,
        types::{BlockId, TransactionRequest, H256},
        utils::{parse_ether, Ganache},
    };

    #[tokio::test]
    async fn non_existing_data_works() {
        let provider = Provider::<Http>::try_from(
            "https://rinkeby.infura.io/v3/c60b0bb42f8a4c6481ecd229eddaca27",
        )
        .unwrap();

        assert!(provider
            .get_transaction(H256::zero())
            .await
            .unwrap()
            .is_none());
        assert!(provider
            .get_transaction_receipt(H256::zero())
            .await
            .unwrap()
            .is_none());
        assert!(provider
            .get_block(BlockId::Hash(H256::zero()))
            .await
            .unwrap()
            .is_none());
        assert!(provider
            .get_block_with_txs(BlockId::Hash(H256::zero()))
            .await
            .unwrap()
            .is_none());
    }

    // Without TLS this would error with "TLS Support not compiled in"
    #[test]
    #[cfg(any(feature = "async-std-tls", feature = "tokio-tls"))]
    fn ssl_websocket() {
        // this is extremely ugly but I couldn't figure out a better way of having
        // a shared async test for both runtimes
        #[cfg(feature = "async-std-tls")]
        let block_on = async_std::task::block_on;
        #[cfg(feature = "tokio-tls")]
        let mut runtime = tokio::runtime::Runtime::new().unwrap();
        #[cfg(feature = "tokio-tls")]
        let mut block_on = |x| runtime.block_on(x);

        use ethers::providers::Ws;
        block_on(async move {
            let ws = Ws::connect("wss://rinkeby.infura.io/ws/v3/c60b0bb42f8a4c6481ecd229eddaca27")
                .await
                .unwrap();
            let provider = Provider::new(ws);
            let _number = provider.get_block_number().await.unwrap();
        });
    }

    #[tokio::test]
    #[cfg(feature = "tokio-runtime")]
    async fn watch_blocks_websocket() {
        use ethers::{
            providers::{StreamExt, Ws},
            types::H256,
        };

        let ganache = Ganache::new().block_time(2u64).spawn();
        let (ws, _) = async_tungstenite::tokio::connect_async(ganache.ws_endpoint())
            .await
            .unwrap();
        let provider = Provider::new(Ws::new(ws)).interval(Duration::from_millis(500u64));

        let stream = provider.watch_blocks().await.unwrap().stream();

        let _blocks = stream.take(3usize).collect::<Vec<H256>>().await;
        let _number = provider.get_block_number().await.unwrap();
    }

    #[tokio::test]
    async fn pending_txs_with_confirmations_ganache() {
        let ganache = Ganache::new().block_time(2u64).spawn();
        let provider = Provider::<Http>::try_from(ganache.endpoint())
            .unwrap()
            .interval(Duration::from_millis(500u64));
        generic_pending_txs_test(provider).await;
    }

    #[tokio::test]
    #[cfg(any(feature = "tokio-runtime", feature = "tokio-tls"))]
    async fn websocket_pending_txs_with_confirmations_ganache() {
        use ethers::providers::Ws;
        let ganache = Ganache::new().block_time(2u64).spawn();
        let ws = Ws::connect(ganache.ws_endpoint()).await.unwrap();
        let provider = Provider::new(ws);
        generic_pending_txs_test(provider).await;
    }

    #[tokio::test]
    async fn gas_oracle() {
        // initialize and fetch gas estimates from EthGasStation
        let eth_gas_station_oracle = EthGasStation::new(None);
        let data_1 = eth_gas_station_oracle.fetch().await;
        assert!(data_1.is_ok());

        let api_key = std::env::var("ETHERSCAN_API_KEY").unwrap();
        let api_key = Some(api_key.as_str());

        // initialize and fetch gas estimates from Etherscan
        // since etherscan does not support `fastest` category, we expect an error
        let etherscan_oracle = Etherscan::new(api_key).category(GasCategory::Fastest);
        let data_2 = etherscan_oracle.fetch().await;
        assert!(data_2.is_err());

        // but fetching the `standard` gas price should work fine
        let etherscan_oracle_2 = Etherscan::new(api_key).category(GasCategory::SafeLow);

        let data_3 = etherscan_oracle_2.fetch().await;
        assert!(data_3.is_ok());

        // initialize and fetch gas estimates from Etherchain
        let etherchain_oracle = Etherchain::new().category(GasCategory::Fast);
        let data_4 = etherchain_oracle.fetch().await;
        assert!(data_4.is_ok());

        // initialize and fetch gas estimates from SparkPool
        let gas_now_oracle = GasNow::new().category(GasCategory::Fastest);
        let data_5 = gas_now_oracle.fetch().await;
        assert!(data_5.is_ok());
    }

    async fn generic_pending_txs_test<P: JsonRpcClient>(provider: Provider<P>) {
        let accounts = provider.get_accounts().await.unwrap();

        let tx = TransactionRequest::pay(accounts[0], parse_ether(1u64).unwrap()).from(accounts[0]);
        let tx_hash = provider.send_transaction(tx).await.unwrap();
        let pending_tx = provider.pending_transaction(tx_hash);
        let receipt = pending_tx.confirmations(5).await.unwrap();

        // got the correct receipt
        assert_eq!(receipt.transaction_hash, tx_hash);
    }
}

#[cfg(feature = "celo")]
mod celo_tests {
    use super::*;
    use ethers::types::{Randomness, H256};
    use futures_util::stream::StreamExt;
    use rustc_hex::FromHex;

    #[tokio::test]
    // https://alfajores-blockscout.celo-testnet.org/tx/0x544ea96cddb16aeeaedaf90885c1e02be4905f3eb43d6db3f28cac4dbe76a625/internal_transactions
    async fn get_transaction() {
        let provider =
            Provider::<Http>::try_from("https://alfajores-forno.celo-testnet.org").unwrap();

        let tx_hash = "c8496681d0ade783322980cce00c89419fce4b484635d9e09c79787a0f75d450"
            .parse::<H256>()
            .unwrap();
        let tx = provider.get_transaction(tx_hash).await.unwrap().unwrap();
        assert!(tx.gateway_fee_recipient.is_none());
        assert_eq!(tx.gateway_fee.unwrap(), 0.into());
        assert_eq!(tx.hash, tx_hash);
        assert_eq!(tx.block_number.unwrap(), 447181.into())
    }

    #[tokio::test]
    async fn get_block() {
        let provider =
            Provider::<Http>::try_from("https://alfajores-forno.celo-testnet.org").unwrap();

        let block = provider.get_block(447254).await.unwrap().unwrap();
        assert_eq!(
            block.randomness,
            Randomness {
                committed: "003e12deb86292844274493e9ab6e57ed1e276202c16799d97af723eb0d3253f"
                    .from_hex::<Vec<u8>>()
                    .unwrap()
                    .into(),
                revealed: "1333b3b45e0385da48a01b4459aeda7607867ef6a41167cfdeefa49b9fdce6d7"
                    .from_hex::<Vec<u8>>()
                    .unwrap()
                    .into(),
            }
        );
    }

    #[tokio::test]
    async fn watch_blocks() {
        let provider = Provider::<Http>::try_from("https://alfajores-forno.celo-testnet.org")
            .unwrap()
            .interval(Duration::from_millis(2000u64));

        let stream = provider.watch_blocks().await.unwrap().stream();

        let _blocks = stream.take(3usize).collect::<Vec<H256>>().await;
    }
}