feat: add chain names & tx cache URL

Author: anna-carroll

crates/constants/src/chains/pecorino.rs

@@ -3,6 +3,8 @@
 use crate::{HostConstants, PredeployTokens, RollupConstants, SignetSystemConstants};
 use alloy::primitives::{address, Address};
 
+/// Name for the host chain.
+pub const HOST_NAME: &str = "Pecorino Host";
 /// Chain ID for the Pecorino testnet host chain.
 pub const HOST_CHAIN_ID: u64 = 3151908;
 /// Deployment height for the Pecorino testnet host chain.
@@ -30,6 +32,8 @@ pub const RU_USDT: Address = address!("0xF34326d3521F1b07d1aa63729cB14A372f8A737
 /// WBTC token for the Pecorino testnet RU chain.
 pub const RU_WBTC: Address = address!("0xE3d7066115f7d6b65F88Dff86288dB4756a7D733");
 
+/// Name for the network.
+pub const RU_NAME: &str = "Pecorino";
 /// Chain ID for the Pecorino testnet RU chain.
 pub const RU_CHAIN_ID: u64 = 14174;
 /// `Orders` contract address for the Pecorino testnet RU chain.
@@ -46,8 +50,12 @@ pub const HOST_TOKENS: PredeployTokens =
 /// RU system tokens for Pecorino.
 pub const RU_TOKENS: PredeployTokens = crate::PredeployTokens::new(RU_USDC, RU_USDT, RU_WBTC);
 
+/// The URL of the Transaction Cache endpoint.
+pub const TX_CACHE_URL: &str = "https://transactions.pecorino.signet.sh";
+
 /// Host system constants for Pecorino.
 pub const HOST: HostConstants = crate::HostConstants::new(
+    HOST_NAME,
     HOST_CHAIN_ID,
     DEPLOY_HEIGHT,
     HOST_ZENITH,
@@ -58,8 +66,14 @@ pub const HOST: HostConstants = crate::HostConstants::new(
 );
 
 /// RU system constants for Pecorino.
-pub const ROLLUP: RollupConstants =
-    crate::RollupConstants::new(RU_CHAIN_ID, RU_ORDERS, RU_PASSAGE, BASE_FEE_RECIPIENT, RU_TOKENS);
+pub const ROLLUP: RollupConstants = crate::RollupConstants::new(
+    RU_NAME,
+    RU_CHAIN_ID,
+    RU_ORDERS,
+    RU_PASSAGE,
+    BASE_FEE_RECIPIENT,
+    RU_TOKENS,
+);
 
 /// Signet system constants for Pecorino.
 pub const PECORINO: SignetSystemConstants = crate::SignetSystemConstants::new(HOST, ROLLUP);

crates/constants/src/chains/test_utils.rs

@@ -6,6 +6,8 @@ use alloy::primitives::{address, Address};
 /// Default reward address used in tests when no other is specified.
 pub const DEFAULT_REWARD_ADDRESS: Address = Address::repeat_byte(0x81);
 
+/// Name for the host chain.
+pub const HOST_NAME: &str = "Test Host";
 /// Test chain id for the host chain.
 pub const HOST_CHAIN_ID: u64 = 1;
 /// Test deployment height.
@@ -33,6 +35,8 @@ pub const RU_USDT: Address = address!("0xF34326d3521F1b07d1aa63729cB14A372f8A737
 /// Test address for predeployed WBTC
 pub const RU_WBTC: Address = address!("0xE3d7066115f7d6b65F88Dff86288dB4756a7D733");
 
+/// Name for the network.
+pub const RU_NAME: &str = "Test Rollup";
 /// Test chain id for the RU chain.
 pub const RU_CHAIN_ID: u64 = 15;
 /// Test address for the RU zenith.
@@ -48,8 +52,12 @@ pub const HOST_TOKENS: PredeployTokens = PredeployTokens::new(HOST_USDC, HOST_US
 /// RU system tokens.
 pub const RU_TOKENS: PredeployTokens = PredeployTokens::new(RU_USDC, RU_USDT, RU_WBTC);
 
+/// The URL of the Transaction Cache endpoint.
+pub const TX_CACHE_URL: &str = "localhost:8080/txcache";
+
 /// Host config
 pub const HOST: HostConstants = HostConstants::new(
+    HOST_NAME,
     HOST_CHAIN_ID,
     0,
     HOST_ZENITH,
@@ -60,8 +68,14 @@ pub const HOST: HostConstants = HostConstants::new(
 );
 
 /// Rollup config
-pub const ROLLUP: RollupConstants =
-    RollupConstants::new(RU_CHAIN_ID, RU_ORDERS, RU_PASSAGE, BASE_FEE_RECIPIENT, RU_TOKENS);
+pub const ROLLUP: RollupConstants = RollupConstants::new(
+    RU_NAME,
+    RU_CHAIN_ID,
+    RU_ORDERS,
+    RU_PASSAGE,
+    BASE_FEE_RECIPIENT,
+    RU_TOKENS,
+);
 
 /// Test constants for unit tests.
 pub const TEST_CONSTANTS: SignetSystemConstants = SignetSystemConstants::new(HOST, ROLLUP);

crates/constants/src/types/host.rs

@@ -10,6 +10,8 @@ use serde_json::Value;
 #[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct HostConstants {
+    /// Name of the host chain.
+    name: &'static str,
     /// Host chain ID.
     chain_id: u64,
     /// Height at which the host chain deployed the rollup contracts.
@@ -39,6 +41,7 @@ impl std::fmt::Display for HostConstants {
 impl HostConstants {
     /// Create a new host configuration.
     pub const fn new(
+        name: &'static str,
         chain_id: u64,
         deploy_height: u64,
         zenith: Address,
@@ -47,7 +50,7 @@ impl HostConstants {
         transactor: Address,
         tokens: PredeployTokens,
     ) -> Self {
-        Self { chain_id, deploy_height, zenith, orders, passage, transactor, tokens }
+        Self { name, chain_id, deploy_height, zenith, orders, passage, transactor, tokens }
     }
 
     /// Get the hard-coded pecorino host constants.
@@ -89,6 +92,11 @@ impl HostConstants {
             || address == self.transactor
     }
 
+    /// Get the host chain name.
+    pub const fn name(&self) -> &'static str {
+        self.name
+    }
+
     /// Get the host chain ID.
     pub const fn chain_id(&self) -> u64 {
         self.chain_id

crates/constants/src/types/rollup.rs

@@ -18,6 +18,8 @@ pub const MINTER_ADDRESS: Address = address!("00000000000000000000746f6b656e6164
 #[derive(Debug, Copy, Clone, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct RollupConstants {
+    /// The name of the network.
+    name: &'static str,
     /// Rollup chain ID.
     chain_id: u64,
     /// Address of the orders contract.
@@ -33,13 +35,14 @@ pub struct RollupConstants {
 impl RollupConstants {
     /// Create a new rollup configuration.
     pub const fn new(
+        name: &'static str,
         chain_id: u64,
         orders: Address,
         passage: Address,
         base_fee_recipient: Address,
         tokens: PredeployTokens,
     ) -> Self {
-        Self { chain_id, orders, passage, base_fee_recipient, tokens }
+        Self { name, chain_id, orders, passage, base_fee_recipient, tokens }
     }
 
     /// Get the hard-coded pecorino rollup constants.
@@ -65,6 +68,11 @@ impl RollupConstants {
         serde_json::from_value(constants.clone()).map_err(Into::into)
     }
 
+    /// Get the rollup chain name.
+    pub const fn name(&self) -> &'static str {
+        self.name
+    }
+
     /// Get the address of the orders contract.
     pub const fn orders(&self) -> Address {
         self.orders