Enum Chain 

#[non_exhaustive]
pub enum Chain {
    Ethereum,
    Starknet,
    ZkSync,
    Arbitrum,
    Base,
    Bsc,
    Unichain,
    Polygon,
    Custom(CustomChainId),
}

A blockchain Tycho indexes or simulates over.

Built-in chains are first-class variants: their config (id, native token, block time, TVL tiers) is compile-time and total, so they never fail to resolve. Custom is the escape hatch for a chain a self-hoster runs without upstreaming a variant — its config lives in the process-wide registry (see chain_config) rather than in the enum.

Custom wraps a CustomChainId whose inner name is private, so a Chain::Custom can only be built through the crate’s registry-validating constructors (Chain::custom, Chain::from_str, From<dto::Chain>) — it cannot be fabricated directly. Because the registry is set-once, a validated Chain::Custom stays resolvable for its whole lifetime, so the config accessors only panic on an unreachable invariant; Chain::try_id and its siblings expose non-panicking variants. The one reachable failure is decoding wire data for a chain the local registry lacks (From<dto::Chain>), which panics at the decode boundary.

Prefer adding a first-class variant for any chain Tycho officially supports; reserve Custom for the self-host case. Full rationale in the custom-chain decision record.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ethereum

Starknet

ZkSync

Arbitrum

Base

Bsc

Unichain

Polygon

Custom(CustomChainId)

User-defined chain resolved via the chain_config registry; see the enum docs.

Implementations

impl Chain

pub fn builtin_from_str(s: &str) -> Option<Chain>

Parses only the built-in chains, ignoring any custom-chain registry.

pub fn custom(name: &str) -> Result<Chain, ChainConfigError>

Builds a custom-chain identity, validating that name has a config in the chain registry. Returns ChainConfigError::UnknownChain when it is absent so typos never silently become custom chains.

impl Chain

pub fn id(&self) -> u64

Returns the numeric chain id. Panics if a custom chain has no registered config — an unreachable invariant for a validly-constructed Chain::Custom; use Chain::try_id for a non-panicking variant.

pub fn try_id(&self) -> Result<u64, ChainConfigError>

Returns the numeric chain id, or ChainConfigError::UnknownChain when a custom chain has no registered config.

pub fn default_tvl_threshold(&self, tier: TvlThresholdTier) -> f64

Returns a default TVL threshold in native token units for the given tier.

Values are approximate and target a USD-equivalent range, not a precise conversion. Native token prices used: ETH ~$2,000, POL ~$0.10, BNB ~$630. These prices are volatile, and used as a reference. They should not be updated often, unless big price movements occour, making an update necessary.

Panics if a custom chain has no registered config; use Chain::try_default_tvl_threshold for a non-panicking variant.

pub fn try_default_tvl_threshold( &self, tier: TvlThresholdTier, ) -> Result<f64, ChainConfigError>

Like Chain::default_tvl_threshold but returns ChainConfigError::UnknownChain when a custom chain has no registered config.

pub fn native_token(&self) -> Token

Returns the native token for the chain. Panics if a custom chain has no registered config; use Chain::try_native_token for a non-panicking variant.

pub fn try_native_token(&self) -> Result<Token, ChainConfigError>

Like Chain::native_token but returns ChainConfigError::UnknownChain when a custom chain has no registered config.

pub fn wrapped_native_token(&self) -> Token

Returns the wrapped native token for the chain. Panics if a custom chain has no registered config; use Chain::try_wrapped_native_token for a non-panicking variant.

pub fn try_wrapped_native_token(&self) -> Result<Token, ChainConfigError>

Like Chain::wrapped_native_token but returns ChainConfigError::UnknownChain when a custom chain has no registered config.

pub fn block_time_secs(&self) -> u64

Returns the expected block time in seconds for the chain. Panics if a custom chain has no registered config; use Chain::try_block_time_secs for a non-panicking variant.

pub fn try_block_time_secs(&self) -> Result<u64, ChainConfigError>

Like Chain::block_time_secs but returns ChainConfigError::UnknownChain when a custom chain has no registered config.

Trait Implementations

impl Clone for Chain

fn clone(&self) -> Chain

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Chain

impl Debug for Chain

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl DeepSizeOf for Chain

fn deep_size_of_children(&self, _context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl Default for Chain

fn default() -> Chain

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Chain

fn deserialize<__D>( __deserializer: __D, ) -> Result<Chain, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Chain

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Chain

impl From<Chain> for Chain

fn from(value: Chain) -> Chain

Converts to this type from the input type.

impl From<Chain> for Chain

fn from(value: Chain) -> Chain

Converts to this type from the input type.

impl FromStr for Chain

fn from_str(s: &str) -> Result<Chain, <Chain as FromStr>::Err>

Resolves a chain name. Built-in chains parse directly; any other name is accepted only if it is registered in the global chain config registry, otherwise ChainConfigError::UnknownChain is returned so typos never silently become custom chains.

type Err = ChainConfigError

The associated error which can be returned from parsing.

impl Hash for Chain

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Chain

fn eq(&self, other: &Chain) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Chain

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Chain