|
| 1 | +use crate::block_data::BlockExtractor; |
| 2 | +use init4_bin_base::utils::calc::SlotCalculator; |
| 3 | +use reth::transaction_pool::TransactionPool; |
| 4 | +#[cfg(feature = "test-utils")] |
| 5 | +use url::Url; |
| 6 | + |
| 7 | +/// Errors that can occur while building the [`BlockExtractor`] with a |
| 8 | +/// [`BlockExtractorBuilder`]. |
| 9 | +#[derive(Debug, thiserror::Error)] |
| 10 | +pub enum BuilderError { |
| 11 | + /// The transaction pool was not provided. |
| 12 | + #[error("transaction pool is required")] |
| 13 | + MissingPool, |
| 14 | + /// The explorer URL was not provided or could not be parsed. |
| 15 | + #[error("explorer URL is required and must be valid")] |
| 16 | + MissingExplorerUrl, |
| 17 | + /// The URL provided was invalid. |
| 18 | + #[error("invalid URL provided")] |
| 19 | + Url(#[from] url::ParseError), |
| 20 | + /// The client was not provided. |
| 21 | + #[error("client is required")] |
| 22 | + MissingClient, |
| 23 | + /// The client failed to build. |
| 24 | + #[error("failed to build client: {0}")] |
| 25 | + Client(#[from] reqwest::Error), |
| 26 | + /// The slot calculator was not provided. |
| 27 | + #[error("slot calculator is required")] |
| 28 | + MissingSlotCalculator, |
| 29 | +} |
| 30 | + |
| 31 | +/// Builder for the [`BlockExtractor`]. |
| 32 | +#[derive(Debug, Default, Clone)] |
| 33 | +pub struct BlockExtractorBuilder<Pool> { |
| 34 | + pool: Option<Pool>, |
| 35 | + explorer_url: Option<String>, |
| 36 | + client: Option<reqwest::Client>, |
| 37 | + cl_url: Option<String>, |
| 38 | + pylon_url: Option<String>, |
| 39 | + slot_calculator: Option<SlotCalculator>, |
| 40 | +} |
| 41 | + |
| 42 | +impl<Pool> BlockExtractorBuilder<Pool> { |
| 43 | + /// Set the transaction pool to use for the extractor. |
| 44 | + pub fn with_pool<P2>(self, pool: P2) -> BlockExtractorBuilder<P2> { |
| 45 | + BlockExtractorBuilder { |
| 46 | + pool: Some(pool), |
| 47 | + explorer_url: self.explorer_url, |
| 48 | + client: self.client, |
| 49 | + cl_url: self.cl_url, |
| 50 | + pylon_url: self.pylon_url, |
| 51 | + slot_calculator: self.slot_calculator, |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | + /// Set the transaction pool to use a mock test pool. |
| 56 | + #[cfg(feature = "test-utils")] |
| 57 | + pub fn with_test_pool( |
| 58 | + self, |
| 59 | + ) -> BlockExtractorBuilder<reth_transaction_pool::test_utils::TestPool> { |
| 60 | + self.with_pool(reth_transaction_pool::test_utils::testing_pool()) |
| 61 | + } |
| 62 | + |
| 63 | + /// Set the blob explorer URL to use for the extractor. This will be used |
| 64 | + /// to construct a [`foundry_blob_explorers::Client`]. |
| 65 | + pub fn with_explorer_url(mut self, explorer_url: &str) -> Self { |
| 66 | + self.explorer_url = Some(explorer_url.to_string()); |
| 67 | + self |
| 68 | + } |
| 69 | + |
| 70 | + /// Set the [`reqwest::Client`] to use for the extractor. This client will |
| 71 | + /// be used to make requests to the blob explorer, and the CL and Pylon URLs |
| 72 | + /// if provided. |
| 73 | + pub fn with_client(mut self, client: reqwest::Client) -> Self { |
| 74 | + self.client = Some(client); |
| 75 | + self |
| 76 | + } |
| 77 | + |
| 78 | + /// Set the [`reqwest::Client`] via a [reqwest::ClientBuilder]. This |
| 79 | + /// function will immediately build the client and return an error if it |
| 80 | + /// fails. |
| 81 | + /// |
| 82 | + /// This client will be used to make requests to the blob explorer, and the |
| 83 | + /// CL and Pylon URLs if provided. |
| 84 | + pub fn with_client_builder(self, client: reqwest::ClientBuilder) -> Result<Self, BuilderError> { |
| 85 | + client.build().map(|client| self.with_client(client)).map_err(Into::into) |
| 86 | + } |
| 87 | + |
| 88 | + /// Set the CL URL to use for the extractor. |
| 89 | + pub fn with_cl_url(mut self, cl_url: &str) -> Result<Self, BuilderError> { |
| 90 | + self.cl_url = Some(cl_url.to_string()); |
| 91 | + Ok(self) |
| 92 | + } |
| 93 | + |
| 94 | + /// Set the Pylon URL to use for the extractor. |
| 95 | + pub fn with_pylon_url(mut self, pylon_url: &str) -> Result<Self, BuilderError> { |
| 96 | + self.pylon_url = Some(pylon_url.to_string()); |
| 97 | + Ok(self) |
| 98 | + } |
| 99 | + |
| 100 | + /// Set the slot calculator to use for the extractor. |
| 101 | + pub fn with_slot_calculator( |
| 102 | + mut self, |
| 103 | + slot_calculator: SlotCalculator, |
| 104 | + ) -> BlockExtractorBuilder<Pool> { |
| 105 | + self.slot_calculator = Some(slot_calculator); |
| 106 | + self |
| 107 | + } |
| 108 | + |
| 109 | + /// Set the slot calculator to use for the extractor, using the Pecornino |
| 110 | + /// host configuration. |
| 111 | + pub fn with_pecornino_slots(mut self) -> BlockExtractorBuilder<Pool> { |
| 112 | + self.slot_calculator = Some(SlotCalculator::pecorino_host()); |
| 113 | + self |
| 114 | + } |
| 115 | +} |
| 116 | + |
| 117 | +impl<Pool: TransactionPool> BlockExtractorBuilder<Pool> { |
| 118 | + /// Build the [`BlockExtractor`] with the provided parameters. |
| 119 | + pub fn build(self) -> Result<BlockExtractor<Pool>, BuilderError> { |
| 120 | + let pool = self.pool.ok_or(BuilderError::MissingPool)?; |
| 121 | + |
| 122 | + let explorer_url = self.explorer_url.ok_or(BuilderError::MissingExplorerUrl)?; |
| 123 | + |
| 124 | + let cl_url = self.cl_url.map(parse_url).transpose()?; |
| 125 | + |
| 126 | + let pylon_url = self.pylon_url.map(parse_url).transpose()?; |
| 127 | + |
| 128 | + let client = self.client.ok_or(BuilderError::MissingClient)?; |
| 129 | + |
| 130 | + let explorer = |
| 131 | + foundry_blob_explorers::Client::new_with_client(explorer_url, client.clone()); |
| 132 | + |
| 133 | + let slot_calculator = self.slot_calculator.ok_or(BuilderError::MissingSlotCalculator)?; |
| 134 | + |
| 135 | + Ok(BlockExtractor::new(pool, explorer, client, cl_url, pylon_url, slot_calculator)) |
| 136 | + } |
| 137 | +} |
| 138 | + |
| 139 | +fn parse_url(url: String) -> Result<Url, BuilderError> { |
| 140 | + Url::parse(url.as_ref()).map_err(BuilderError::Url) |
| 141 | +} |
0 commit comments