cast/cmd/
find_block.rs

1use crate::Cast;
2use alloy_provider::Provider;
3use clap::Parser;
4use eyre::Result;
5use foundry_cli::{
6    opts::RpcOpts,
7    utils::{self, LoadConfig},
8};
9use futures::join;
10
11/// CLI arguments for `cast find-block`.
12#[derive(Clone, Debug, Parser)]
13pub struct FindBlockArgs {
14    /// The UNIX timestamp to search for, in seconds.
15    timestamp: u64,
16
17    #[command(flatten)]
18    rpc: RpcOpts,
19}
20
21impl FindBlockArgs {
22    pub async fn run(self) -> Result<()> {
23        let Self { timestamp, rpc } = self;
24
25        let ts_target = timestamp;
26        let config = rpc.load_config()?;
27        let provider = utils::get_provider(&config)?;
28
29        let last_block_num = provider.get_block_number().await?;
30        let cast_provider = Cast::new(provider);
31
32        let res = join!(cast_provider.timestamp(last_block_num), cast_provider.timestamp(1));
33        let ts_block_latest: u64 = res.0?.to();
34        let ts_block_1: u64 = res.1?.to();
35
36        let block_num = if ts_block_latest < ts_target {
37            // If the most recent block's timestamp is below the target, return it
38            last_block_num
39        } else if ts_block_1 > ts_target {
40            // If the target timestamp is below block 1's timestamp, return that
41            1
42        } else {
43            // Otherwise, find the block that is closest to the timestamp
44            let mut low_block = 1_u64; // block 0 has a timestamp of 0: https://github.com/ethereum/go-ethereum/issues/17042#issuecomment-559414137
45            let mut high_block = last_block_num;
46            let mut matching_block = None;
47            while high_block > low_block && matching_block.is_none() {
48                // Get timestamp of middle block (this approach approach to avoids overflow)
49                let high_minus_low_over_2 = high_block
50                    .checked_sub(low_block)
51                    .ok_or_else(|| eyre::eyre!("unexpected underflow"))
52                    .unwrap()
53                    .checked_div(2_u64)
54                    .unwrap();
55                let mid_block = high_block.checked_sub(high_minus_low_over_2).unwrap();
56                let ts_mid_block = cast_provider.timestamp(mid_block).await?.to::<u64>();
57
58                // Check if we've found a match or should keep searching
59                if ts_mid_block == ts_target {
60                    matching_block = Some(mid_block)
61                } else if high_block.checked_sub(low_block).unwrap() == 1_u64 {
62                    // The target timestamp is in between these blocks. This rounds to the
63                    // highest block if timestamp is equidistant between blocks
64                    let res = join!(
65                        cast_provider.timestamp(high_block),
66                        cast_provider.timestamp(low_block)
67                    );
68                    let ts_high: u64 = res.0.unwrap().to();
69                    let ts_low: u64 = res.1.unwrap().to();
70                    let high_diff = ts_high.checked_sub(ts_target).unwrap();
71                    let low_diff = ts_target.checked_sub(ts_low).unwrap();
72                    let is_low = low_diff < high_diff;
73                    matching_block = if is_low { Some(low_block) } else { Some(high_block) }
74                } else if ts_mid_block < ts_target {
75                    low_block = mid_block;
76                } else {
77                    high_block = mid_block;
78                }
79            }
80            matching_block.unwrap_or(low_block)
81        };
82        sh_println!("{block_num}")?;
83
84        Ok(())
85    }
86}