LumeWeb
/
ethers-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor: pending txns don't wait to poll futures until interval elapses (#49)

This commit is contained in:
James Prestwich 2020-07-09 23:59:29 -07:00 committed by GitHub
parent d0f1752db0
commit 320ab276de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
ethers-providers/src/pending_transaction.rs
View File

@ -63,16 +63,18 @@ impl<'a, P: JsonRpcClient> Future for PendingTransaction<'a, P> {
let this = self.project(); let this = self.project();
match this.state { match this.state {
PendingTxState::GettingReceipt(fut) => { PendingTxState::PausedGettingReceipt => {
// Wait the polling period so that we do not spam the chain when no // Wait the polling period so that we do not spam the chain when no
// new block has been mined // new block has been mined
let _ready = futures_util::ready!(this.interval.poll_next_unpin(ctx)); let _ready = futures_util::ready!(this.interval.poll_next_unpin(ctx));
let fut = Box::pin(this.provider.get_transaction_receipt(*this.tx_hash));
*this.state = PendingTxState::GettingReceipt(fut)
}
PendingTxState::GettingReceipt(fut) => {
if let Ok(receipt) = futures_util::ready!(fut.as_mut().poll(ctx)) { if let Ok(receipt) = futures_util::ready!(fut.as_mut().poll(ctx)) {
*this.state = PendingTxState::CheckingReceipt(Box::new(receipt)) *this.state = PendingTxState::CheckingReceipt(Box::new(receipt))
} else { } else {
let fut = Box::pin(this.provider.get_transaction_receipt(*this.tx_hash)); *this.state = PendingTxState::PausedGettingReceipt
*this.state = PendingTxState::GettingReceipt(fut)
} }
} }
PendingTxState::CheckingReceipt(receipt) => { PendingTxState::CheckingReceipt(receipt) => {
@ -91,11 +93,18 @@ impl<'a, P: JsonRpcClient> Future for PendingTransaction<'a, P> {
return Poll::Ready(Ok(receipt)); return Poll::Ready(Ok(receipt));
} }
} }
PendingTxState::GettingBlockNumber(fut, receipt) => { PendingTxState::PausedGettingBlockNumber(receipt) => {
// Wait the polling period so that we do not spam the chain when no // Wait the polling period so that we do not spam the chain when no
// new block has been mined // new block has been mined
let _ready = futures_util::ready!(this.interval.poll_next_unpin(ctx)); let _ready = futures_util::ready!(this.interval.poll_next_unpin(ctx));
// we need to re-instantiate the get_block_number future so that
// we poll again
let fut = Box::pin(this.provider.get_block_number());
*this.state = PendingTxState::GettingBlockNumber(fut, receipt.clone());
return Poll::Pending;
}
PendingTxState::GettingBlockNumber(fut, receipt) => {
// Wait for the interval // Wait for the interval
let inclusion_block = receipt let inclusion_block = receipt
.block_number .block_number
@ -110,11 +119,7 @@ impl<'a, P: JsonRpcClient> Future for PendingTransaction<'a, P> {
*this.state = PendingTxState::Completed; *this.state = PendingTxState::Completed;
return Poll::Ready(Ok(receipt)); return Poll::Ready(Ok(receipt));
} else { } else {
// we need to re-instantiate the get_block_number future so that *this.state = PendingTxState::PausedGettingBlockNumber(receipt.clone())
// we poll again
let fut = Box::pin(this.provider.get_block_number());
*this.state = PendingTxState::GettingBlockNumber(fut, receipt.clone());
return Poll::Pending;
} }
} }
PendingTxState::Completed => { PendingTxState::Completed => {
@ -163,9 +168,15 @@ type PinBoxFut<'a, T> = Pin<Box<dyn Future<Output = Result<T, ProviderError>> +
// We box the TransactionReceipts to keep the enum small. // We box the TransactionReceipts to keep the enum small.
enum PendingTxState<'a> { enum PendingTxState<'a> {
/// Waiting for interval to elapse before calling API again
PausedGettingReceipt,
/// Polling the blockchain for the receipt /// Polling the blockchain for the receipt
GettingReceipt(PinBoxFut<'a, TransactionReceipt>), GettingReceipt(PinBoxFut<'a, TransactionReceipt>),
/// Waiting for interval to elapse before calling API again
PausedGettingBlockNumber(Box<TransactionReceipt>),
/// Polling the blockchain for the current block number /// Polling the blockchain for the current block number
GettingBlockNumber(PinBoxFut<'a, U64>, Box<TransactionReceipt>), GettingBlockNumber(PinBoxFut<'a, U64>, Box<TransactionReceipt>),
@ -182,7 +193,9 @@ impl<'a> fmt::Debug for PendingTxState<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let state = match self { let state = match self {
PendingTxState::GettingReceipt(_) => "GettingReceipt", PendingTxState::GettingReceipt(_) => "GettingReceipt",
PendingTxState::PausedGettingReceipt => "PausedGettingReceipt",
PendingTxState::GettingBlockNumber(_, _) => "GettingBlockNumber", PendingTxState::GettingBlockNumber(_, _) => "GettingBlockNumber",
PendingTxState::PausedGettingBlockNumber(_) => "PausedGettingBlockNumber",
PendingTxState::CheckingReceipt(_) => "CheckingReceipt", PendingTxState::CheckingReceipt(_) => "CheckingReceipt",
PendingTxState::Completed => "Completed", PendingTxState::Completed => "Completed",
}; };