more cleanup and readme updates

- removes some unused env vars

Author: dylanlott

README.md

@@ -20,43 +20,35 @@ The following environment variables are exposed to configure the Builder:
 # Builder Configs for Pecorino Test Net
 HOST_CHAIN_ID="3151908"
 RU_CHAIN_ID="14174"
+
+# Transaction Pool Configs
+TX_POOL_URL="http://pool.url.here/" # trailing slash is required
+
+# RPC Endpoints
 HOST_RPC_URL="https://host-rpc.pecorino.signet.sh"
+RU_RPC_URL="https://rpc.pecorino.signet.sh"
+TX_POOL_URL=""
 TX_BROADCAST_URLS="" # trailing slash is required - set to none for test net configuration
+
+# Contract configurations
 ZENITH_ADDRESS="0xbe45611502116387211D28cE493D6Fb3d192bc4E"
+BUILDER_HELPER_ADDRESS="0xb393416A722Fd48C3b0a9ab5fC2512Ef0c55e4CA"
+
+# Misc.
 QUINCEY_URL="http://sequencer.pecorino.signet.sh/signBlock"
 BUILDER_PORT="8080"
-INCOMING_TRANSACTIONS_BUFFER="10"
-BLOCK_CONFIRMATION_BUFFER="10"
+SEQUENCER_KEY=""
+BUILDER_KEY=""
 BUILDER_REWARDS_ADDRESS="BUILDER_REWARDS_ADDRESS_HERE"
-ROLLUP_BLOCK_GAS_LIMIT="30000000"
-CONCURRENCY_LIMIT=10 # Concurrency parameter for simulation
-# Pecorino Slot Timing Configuration
+ROLLUP_BLOCK_GAS_LIMIT=""
+CONCURRENCY_LIMIT=""
+
+# Pecorino Slot Timing Configurations
 SLOT_OFFSET="4"
 SLOT_DURATION="12"
 START_TIMESTAMP="1740681556"
-# Transaction Pool Configs
-TX_POOL_URL="http://pool.url.here/" # trailing slash is required
-TX_POOL_POLL_INTERVAL="5" # seconds
-TX_POOL_CACHE_DURATION="600" # seconds
 ```
 
-## API
-
-### SignRequest
-
-Sign request example payload:
-
-```json
-{
-  "hostBlockNumber": "0x0",
-  "hostChainId": "0x1",
-  "ruChainId": "0x2",
-  "gasLimit": "0x5",
-  "ruRewardAddress": "0x0606060606060606060606060606060606060606",
-  "contents": "0x0707070707070707070707070707070707070707070707070707070707070707"
-}
-```
- 
 ## Transaction Sender
 
 The builder includes a `transaction-sender` for sending miniscule transactions for the purpose of testing the rollup block construction process. The `transaction-sender` is located in `bin/submit-transaction.rs`.
@@ -67,10 +59,22 @@ It requires a key to sign the transactions and a funded wallet.
 
 The `transaction-sender` also has a set of configurable environment variables listed below.
 
-```
+```sh
 RPC_URL="" # The URL of the RPC endpoint of the node you're sending the transaction to.
 RECIPIENT_ADDRESS="" # The address the submitter addresses the transaction to.
 SLEEP_TIME="" # The time to wait before sending another transaction, in seconds.
 SIGNER_CHAIN_ID=""
-SIGNER_KEY="" # 
-```
+SIGNER_KEY=""
+```
+
+## Testing
+
+### F
+
+In order to test the `builder`, one must build and deploy an image in the target network with a provisioned key. 
+
+1. Build a docker image with your changes 
+2. Push the image to the image repository
+3. Update the image in the deployment
+4. Assert and confirm expected behavior
+

src/config.rs

@@ -55,47 +55,65 @@ pub type HostProvider = FillProvider<
 /// chain.
 #[derive(Debug, Clone, FromEnv)]
 pub struct BuilderConfig {
-    /// The chain ID of the host chain
+    /// The chain ID of the host chain.
     #[from_env(var = "HOST_CHAIN_ID", desc = "The chain ID of the host chain")]
     pub host_chain_id: u64,
-    /// The chain ID of the rollup chain
+    
+    /// The chain ID of the rollup chain.
     #[from_env(var = "RU_CHAIN_ID", desc = "The chain ID of the rollup chain")]
     pub ru_chain_id: u64,
+    
     /// URL for Host RPC node.
     #[from_env(var = "HOST_RPC_URL", desc = "URL for Host RPC node", infallible)]
     pub host_rpc_url: Cow<'static, str>,
+    
     /// URL for the Rollup RPC node.
     #[from_env(var = "ROLLUP_RPC_URL", desc = "URL for Rollup RPC node", infallible)]
     pub ru_rpc_url: Cow<'static, str>,
-    /// Additional RPC URLs to which to broadcast transactions.
-    /// NOTE: should not include the host_rpc_url value
+    
+    /// URL of the tx pool to poll for incoming transactions.
+    #[from_env(
+        var = "TX_POOL_URL",
+        desc = "URL of the tx pool to poll for incoming transactions",
+        infallible
+    )]
+    pub tx_pool_url: Cow<'static, str>,
+
+    /// Additional RPC URLs to which the builder should broadcast transactions.
+    /// * Should not include the `HOST_RPC_URL` value, as that is already sent to by default.
+    /// * Setting this can incur `already known` errors.
     #[from_env(
         var = "TX_BROADCAST_URLS",
         desc = "Additional RPC URLs to which the builder broadcasts transactions",
         infallible,
         optional
     )]
     pub tx_broadcast_urls: Vec<Cow<'static, str>>,
-    /// address of the Zenith contract on Host.
+    
+    /// Address of the Zenith contract on Host.
     #[from_env(var = "ZENITH_ADDRESS", desc = "address of the Zenith contract on Host")]
     pub zenith_address: Address,
-    /// address of the Builder Helper contract on Host.
+    
+    /// Address of the Builder Helper contract on Host.
     #[from_env(
         var = "BUILDER_HELPER_ADDRESS",
         desc = "address of the Builder Helper contract on Host"
     )]
     pub builder_helper_address: Address,
+    
     /// URL for remote Quincey Sequencer server to sign blocks.
-    /// Disregarded if a sequencer_signer is configured.
+    /// NB: Disregarded if a sequencer_signer is configured.
     #[from_env(
         var = "QUINCEY_URL",
         desc = "URL for remote Quincey Sequencer server to sign blocks",
         infallible
     )]
     pub quincey_url: Cow<'static, str>,
+
     /// Port for the Builder server.
     #[from_env(var = "BUILDER_PORT", desc = "Port for the Builder server")]
     pub builder_port: u16,
+    
     /// Key to access Sequencer Wallet - AWS Key ID _OR_ local private key.
     /// Set IFF using local Sequencer signing instead of remote Quincey signing.
     #[from_env(
@@ -105,13 +123,15 @@ pub struct BuilderConfig {
         optional
     )]
     pub sequencer_key: Option<String>,
+
     /// Key to access Builder transaction submission wallet - AWS Key ID _OR_ local private key.
     #[from_env(
         var = "BUILDER_KEY",
         desc = "Key to access Builder transaction submission wallet - AWS Key ID _OR_ local private key",
         infallible
     )]
     pub builder_key: String,
+
     /// Buffer in seconds in which the `submitBlock` transaction must confirm on the Host chain.
     #[from_env(
         var = "BLOCK_CONFIRMATION_BUFFER",
@@ -125,23 +145,11 @@ pub struct BuilderConfig {
         desc = "Address on Rollup to which Builder will receive user transaction fees"
     )]
     pub builder_rewards_address: Address,
+    
     /// Gas limit for RU block.
     /// NOTE: a "smart" builder would determine this programmatically by simulating the block.
     #[from_env(var = "ROLLUP_BLOCK_GAS_LIMIT", desc = "Gas limit for RU block")]
     pub rollup_block_gas_limit: u64,
-    /// URL of the tx pool to poll for incoming transactions.
-    #[from_env(
-        var = "TX_POOL_URL",
-        desc = "URL of the tx pool to poll for incoming transactions",
-        infallible
-    )]
-    pub tx_pool_url: Cow<'static, str>,
-    /// Duration in seconds transactions can live in the tx-pool cache.
-    #[from_env(
-        var = "TX_POOL_CACHE_DURATION",
-        desc = "Duration in seconds transactions can live in the tx-pool cache"
-    )]
-    pub tx_pool_cache_duration: u64,
 
     /// Oauth2 configuration for the builder to connect to init4 services.
     pub oauth: OAuthConfig,

src/test_utils.rs

@@ -29,11 +29,9 @@ pub fn setup_test_config() -> Result<BuilderConfig> {
         builder_port: 8080,
         sequencer_key: None,
         builder_key: "0000000000000000000000000000000000000000000000000000000000000000".into(),
-        block_confirmation_buffer: 1,
         builder_rewards_address: Address::default(),
         rollup_block_gas_limit: 3_000_000_000,
         tx_pool_url: "http://localhost:9000/".into(),
-        tx_pool_cache_duration: 5,
         oauth: OAuthConfig {
             oauth_client_id: "some_client_id".into(),
             oauth_client_secret: "some_client_secret".into(),