#![allow(missing_docs)] use std::str::FromStr; use eyre::Result; use num_derive::FromPrimitive; use num_traits::FromPrimitive; use serde::{Deserialize, Serialize}; use strum::{EnumIter, EnumString}; #[derive(Debug, Clone, Deserialize, Serialize)] pub struct Address(pub bytes::Bytes); #[derive(Debug, Clone, Deserialize, Serialize)] pub struct Balance(pub num::BigInt); #[derive(Debug, Clone, Serialize, Deserialize)] pub struct ContractLocator { pub chain_name: String, pub domain: u32, pub address: Address, } impl std::fmt::Display for ContractLocator { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!( f, "{}[@{}]+contract:0x{:x}", self.chain_name, self.domain, self.address.0 ) } } #[async_trait::async_trait] pub trait Chain { /// Query the balance on a chain async fn query_balance(&self, addr: Address) -> Result; } impl From
for ethers::types::H160 { fn from(addr: Address) -> Self { ethers::types::H160::from_slice(addr.0.as_ref()) } } impl From for Address { fn from(addr: ethers::types::H160) -> Self { Address(bytes::Bytes::from(addr.as_bytes().to_owned())) } } impl From<&'_ Address> for ethers::types::H160 { fn from(addr: &Address) -> Self { ethers::types::H160::from_slice(addr.0.as_ref()) } } /// All domains supported by Hyperlane. #[derive(FromPrimitive, EnumString, strum::Display, EnumIter, PartialEq, Eq, Debug)] #[strum(serialize_all = "lowercase")] pub enum HyperlaneDomain { Ethereum = 1, Goerli = 5, Kovan = 3000, Polygon = 137, Mumbai = 80001, Avalanche = 43114, Fuji = 43113, Arbitrum = 42161, ArbitrumRinkeby = 421611, ArbitrumGoerli = 421613, Optimism = 10, OptimismKovan = 69, OptimismGoerli = 420, #[strum(serialize = "bsc")] BinanceSmartChain = 56, #[strum(serialize = "bsctestnet")] BinanceSmartChainTestnet = 97, Celo = 42220, Alfajores = 44787, MoonbaseAlpha = 1287, Moonbeam = 1284, Zksync2Testnet = 280, // -- Local test chains -- /// Test1 local chain Test1 = 13371, /// Test2 local chain Test2 = 13372, /// Test3 local chain Test3 = 13373, } impl From for u32 { fn from(domain: HyperlaneDomain) -> Self { domain as u32 } } impl TryFrom for HyperlaneDomain { type Error = eyre::Error; fn try_from(domain_id: u32) -> Result { FromPrimitive::from_u32(domain_id) .ok_or_else(|| eyre::eyre!("Unknown domain ID {domain_id}")) } } /// Types of Hyperlane domains. pub enum HyperlaneDomainType { /// A mainnet. Mainnet, /// A testnet. Testnet, /// A local chain for testing (i.e. Hardhat node). LocalTestChain, } impl HyperlaneDomain { pub fn domain_type(&self) -> HyperlaneDomainType { match self { HyperlaneDomain::Ethereum => HyperlaneDomainType::Mainnet, HyperlaneDomain::Goerli => HyperlaneDomainType::Testnet, HyperlaneDomain::Kovan => HyperlaneDomainType::Testnet, HyperlaneDomain::Polygon => HyperlaneDomainType::Mainnet, HyperlaneDomain::Mumbai => HyperlaneDomainType::Testnet, HyperlaneDomain::Avalanche => HyperlaneDomainType::Mainnet, HyperlaneDomain::Fuji => HyperlaneDomainType::Testnet, HyperlaneDomain::Arbitrum => HyperlaneDomainType::Mainnet, HyperlaneDomain::ArbitrumRinkeby => HyperlaneDomainType::Testnet, HyperlaneDomain::ArbitrumGoerli => HyperlaneDomainType::Testnet, HyperlaneDomain::Optimism => HyperlaneDomainType::Mainnet, HyperlaneDomain::OptimismKovan => HyperlaneDomainType::Testnet, HyperlaneDomain::OptimismGoerli => HyperlaneDomainType::Testnet, HyperlaneDomain::BinanceSmartChain => HyperlaneDomainType::Mainnet, HyperlaneDomain::BinanceSmartChainTestnet => HyperlaneDomainType::Testnet, HyperlaneDomain::Celo => HyperlaneDomainType::Mainnet, HyperlaneDomain::Alfajores => HyperlaneDomainType::Testnet, HyperlaneDomain::MoonbaseAlpha => HyperlaneDomainType::Testnet, HyperlaneDomain::Moonbeam => HyperlaneDomainType::Mainnet, HyperlaneDomain::Zksync2Testnet => HyperlaneDomainType::Testnet, HyperlaneDomain::Test1 => HyperlaneDomainType::LocalTestChain, HyperlaneDomain::Test2 => HyperlaneDomainType::LocalTestChain, HyperlaneDomain::Test3 => HyperlaneDomainType::LocalTestChain, } } } /// Gets the name of the chain from a domain id. /// Returns None if the domain ID is not recognized. pub fn name_from_domain_id(domain_id: u32) -> Option { HyperlaneDomain::try_from(domain_id) .ok() .map(|domain| domain.to_string()) } /// Gets the domain ID of the chain its name. /// Returns None if the chain name is not recognized. pub fn domain_id_from_name(name: &'static str) -> Option { HyperlaneDomain::from_str(name) .ok() .map(|domain| domain.into()) } #[cfg(test)] mod tests { use config::{Config, File, FileFormat}; use hyperlane_base::Settings; use std::collections::BTreeSet; use std::fs::read_to_string; use std::path::Path; use std::str::FromStr; use walkdir::WalkDir; use crate::{domain_id_from_name, name_from_domain_id, HyperlaneDomain}; /// Relative path to the `hyperlane-monorepo/rust/config/` /// directory, which is where the agent's config files /// currently live. const AGENT_CONFIG_PATH_ROOT: &str = "../config"; /// We will not include any file paths of config/settings files /// in the test suite if *any* substring of the file path matches /// against one of the strings included in the blacklist below. /// This is to ensure that e.g. when a backwards-incompatible /// change is made in config file format, and agents can't parse /// them anymore, we don't fail the test. (E.g. agents cannot /// currently parse the older files in `config/dev/` or /// `config/testnet`. const BLACKLISTED_DIRS: &[&str] = &[ // Ignore only-local names of fake chains used by // e.g. test suites. "test/test_config.json", ]; fn is_blacklisted(path: &Path) -> bool { BLACKLISTED_DIRS .iter() .any(|x| path.to_str().unwrap().contains(x)) } #[derive(Clone, Debug, Ord, PartialEq, PartialOrd, Eq, Hash)] struct ChainCoordinate { name: String, domain: u32, } fn config_paths(root: &Path) -> Vec { WalkDir::new(root) .min_depth(2) .into_iter() .filter_map(|x| x.ok()) .map(|x| x.into_path()) .filter(|x| !is_blacklisted(x)) .map(|x| x.into_os_string()) .filter_map(|x| x.into_string().ok()) .collect() } /// Provides a vector of parsed `hyperlane_base::Settings` objects /// built from all of the version-controlled agent configuration files. /// This is purely a utility to allow us to test a handful of critical /// properties related to those configs and shouldn't be used outside /// of a test env. This test simply tries to do some sanity checks /// against the integrity of that data. fn hyperlane_settings() -> Vec { let root = Path::new(AGENT_CONFIG_PATH_ROOT); let paths = config_paths(root); let files: Vec = paths .iter() .filter_map(|x| read_to_string(x).ok()) .collect(); paths .iter() .zip(files.iter()) .map(|(p, f)| { Config::builder() .add_source(File::from_str(f.as_str(), FileFormat::Json)) .build() .unwrap() .try_deserialize() .unwrap_or_else(|e| { panic!("!cfg({}): {:?}: {}", p, e, f); }) }) .collect() } fn chain_name_domain_records() -> BTreeSet { hyperlane_settings() .iter() .flat_map(|x: &Settings| { x.chain.chains.iter().map(|(_, v)| ChainCoordinate { name: v.name.clone(), domain: v.domain.parse().unwrap(), }) }) .collect() } #[test] fn agent_json_config_consistency_checks() { // TODO(webbhorn): Also verify with this functionality // we have entries for all of the Gelato contract // addresses we need hardcoded in the binary for now. // Verify that the hard-coded, macro-maintained // mapping in `hyperlane-core/src/chain.rs` named // by the macro `domain_and_chain` is complete // and in agreement with our on-disk json-based // configuration data. let chain_coords = chain_name_domain_records(); for ChainCoordinate { name, domain } in chain_coords.iter() { assert_eq!( HyperlaneDomain::try_from(domain.to_owned()) .unwrap() .to_string(), name.to_owned() ); assert_eq!( u32::from(HyperlaneDomain::from_str(name).unwrap()), domain.to_owned() ); } } #[test] fn domain_strings() { assert_eq!( HyperlaneDomain::from_str("ethereum").unwrap(), HyperlaneDomain::Ethereum, ); assert_eq!( HyperlaneDomain::Ethereum.to_string(), "ethereum".to_string(), ); } #[test] fn domain_ids() { assert_eq!( HyperlaneDomain::try_from(1).unwrap(), HyperlaneDomain::Ethereum, ); assert_eq!(u32::from(HyperlaneDomain::Ethereum), 1); } #[test] fn test_name_from_domain_id() { assert_eq!(name_from_domain_id(1), Some("ethereum".into()),); assert_eq!(name_from_domain_id(0xf00u32), None,); } #[test] fn test_domain_id_from_name() { assert_eq!(domain_id_from_name("ethereum"), Some(1),); assert_eq!(domain_id_from_name("foo"), None,); } }