feat(providers): Log methods for PendingTransaction (#884)

* feat(providers): Log method for PendingTransaction

* feat(poviders): Add PendingTransaction inspect() method

* Apply suggestions from code review

Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
This commit is contained in:
wolflo 2022-02-08 15:55:35 -07:00 committed by GitHub
parent 67271eba68
commit b657e47e6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 0 deletions

View File

@ -25,6 +25,32 @@ use wasm_timer::Delay;
/// once the transaction has enough `confirmations`. The default number of confirmations /// once the transaction has enough `confirmations`. The default number of confirmations
/// is 1, but may be adjusted with the `confirmations` method. If the transaction does not /// is 1, but may be adjusted with the `confirmations` method. If the transaction does not
/// have enough confirmations or is not mined, the future will stay in the pending state. /// have enough confirmations or is not mined, the future will stay in the pending state.
///```
/// use ethers_providers::{Provider, Http, Middleware};
/// use ethers_core::types::TransactionRequest;
/// use ethers_core::utils::Ganache;
/// use std::convert::TryFrom;
///
/// # #[tokio::main(flavor = "current_thread")]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let ganache = Ganache::new().spawn();
/// # let client = Provider::<Http>::try_from(ganache.endpoint()).unwrap();
/// # let accounts = client.get_accounts().await?;
/// # let from = accounts[0];
/// # let to = accounts[1];
/// # let balance_before = client.get_balance(to, None).await?;
/// let tx = TransactionRequest::new().to(to).value(1000).from(from);
/// let receipt = client
/// .send_transaction(tx, None)
/// .await? // PendingTransaction<_>
/// .log_msg("Pending transfer hash") // print pending tx hash with message
/// .await?; // Result<Option<TransactionReceipt>, _>
/// # let _ = receipt;
/// # let balance_after = client.get_balance(to, None).await?;
/// # assert_eq!(balance_after, balance_before + 1000);
/// # Ok(())
/// # }
/// ```
#[pin_project] #[pin_project]
pub struct PendingTransaction<'a, P> { pub struct PendingTransaction<'a, P> {
tx_hash: TxHash, tx_hash: TxHash,
@ -78,6 +104,29 @@ impl<'a, P: JsonRpcClient> PendingTransaction<'a, P> {
} }
} }
impl<'a, P> PendingTransaction<'a, P> {
/// Allows inspecting the content of a pending transaction in a builder-like way to avoid
/// more verbose calls, e.g.:
/// `let mined = token.transfer(recipient, amt).send().await?.inspect(|tx| println!(".{}", *tx)).await?;`
pub fn inspect<F>(self, mut f: F) -> Self
where
F: FnMut(&Self),
{
f(&self);
self
}
/// Logs the pending transaction hash along with a custom message before it.
pub fn log_msg<S: std::fmt::Display>(self, msg: S) -> Self {
self.inspect(|s| println!("{}: {:?}", msg, *s))
}
/// Logs the pending transaction's hash
pub fn log(self) -> Self {
self.inspect(|s| println!("Pending hash: {:?}", *s))
}
}
macro_rules! rewake_with_new_state { macro_rules! rewake_with_new_state {
($ctx:ident, $this:ident, $new_state:expr) => { ($ctx:ident, $this:ident, $new_state:expr) => {
*$this.state = $new_state; *$this.state = $new_state;