Enum NamedChain

#[non_exhaustive]
#[repr(u64)]
pub enum NamedChain {
    Mainnet = 1,
    Morden = 2,
    Ropsten = 3,
    Rinkeby = 4,
    Goerli = 5,
    Kovan = 42,
    Holesky = 17_000,
    Sepolia = 11_155_111,
    Odyssey = 911_867,
    Optimism = 10,
    OptimismKovan = 69,
    OptimismGoerli = 420,
    OptimismSepolia = 11_155_420,
    Arbitrum = 42_161,
    ArbitrumTestnet = 421_611,
    ArbitrumGoerli = 421_613,
    ArbitrumSepolia = 421_614,
    ArbitrumNova = 42_170,
    Cronos = 25,
    CronosTestnet = 338,
    Rsk = 30,
    Crab = 44,
    Darwinia = 46,
    Koi = 701,
    BinanceSmartChain = 56,
    BinanceSmartChainTestnet = 97,
    Poa = 99,
    Sokol = 77,
    Scroll = 534_352,
    ScrollSepolia = 534_351,
    Metis = 1_088,
    CfxTestnet = 71,
    Cfx = 1_030,
    Gnosis = 100,
    Polygon = 137,
    PolygonMumbai = 80_001,
    PolygonAmoy = 80_002,
    PolygonZkEvm = 1_101,
    PolygonZkEvmTestnet = 1_442,
    Fantom = 250,
    FantomTestnet = 4_002,
    Moonbeam = 1_284,
    MoonbeamDev = 1_281,
    Moonriver = 1_285,
    Moonbase = 1_287,
    Dev = 1_337,
    AnvilHardhat = 31_337,
    GravityAlphaMainnet = 1_625,
    GravityAlphaTestnetSepolia = 13_505,
    Evmos = 9_001,
    EvmosTestnet = 9_000,
    Chiado = 10_200,
    Oasis = 26_863,
    Emerald = 42_262,
    EmeraldTestnet = 42_261,
    FilecoinMainnet = 314,
    FilecoinCalibrationTestnet = 314_159,
    Avalanche = 43_114,
    AvalancheFuji = 43_113,
    Celo = 42_220,
    CeloAlfajores = 44_787,
    CeloBaklava = 62_320,
    Aurora = 1_313_161_554,
    AuroraTestnet = 1_313_161_555,
    Canto = 7_700,
    CantoTestnet = 740,
    Boba = 288,
    Base = 8_453,
    BaseGoerli = 84_531,
    BaseSepolia = 84_532,
    Syndr = 404,
    SyndrSepolia = 444_444,
    Shimmer = 148,
    InkSepolia = 763_373,
    Fraxtal = 252,
    FraxtalTestnet = 2_522,
    Blast = 81_457,
    BlastSepolia = 168_587_773,
    Linea = 59_144,
    LineaGoerli = 59_140,
    LineaSepolia = 59_141,
    ZkSync = 324,
    ZkSyncTestnet = 300,
    Mantle = 5_000,
    MantleTestnet = 5_001,
    MantleSepolia = 5_003,
    Xai = 660_279,
    XaiSepolia = 37_714_555_429,
    Viction = 88,
    Zora = 7_777_777,
    ZoraGoerli = 999,
    ZoraSepolia = 999_999_999,
    Pgn = 424,
    PgnSepolia = 58_008,
    Mode = 34_443,
    ModeSepolia = 919,
    Elastos = 20,
    KakarotSepolia = 920_637_907_288_165,
    Etherlink = 42_793,
    EtherlinkTestnet = 128_123,
    Degen = 666_666_666,
    OpBNBMainnet = 204,
    OpBNBTestnet = 5_611,
    Ronin = 2_020,
    Taiko = 167_000,
    TaikoHekla = 167_009,
    AutonomysNovaTestnet = 490_000,
    Flare = 14,
    FlareCoston2 = 114,
    Acala = 787,
    AcalaMandalaTestnet = 595,
    AcalaTestnet = 597,
    Karura = 686,
    KaruraTestnet = 596,
    Pulsechain = 369,
    PulsechainTestnet = 943,
    Immutable = 13_371,
    ImmutableTestnet = 13_473,
    SoneiumMinatoTestnet = 1_946,
    World = 480,
    WorldSepolia = 4_801,
    Iotex = 4_689,
    Core = 1_116,
    Merlin = 4_200,
    Bitlayer = 200_901,
    UnichainSepolia = 1_301,
    ApeChain = 33_139,
    Curtis = 33_111,
    SonicTestnet = 64_165,
}

An Ethereum EIP-155 chain.

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.

Mainnet = 1

Morden = 2

Ropsten = 3

Rinkeby = 4

Goerli = 5

Kovan = 42

Holesky = 17_000

Sepolia = 11_155_111

Odyssey = 911_867

Optimism = 10

OptimismKovan = 69

OptimismGoerli = 420

OptimismSepolia = 11_155_420

Arbitrum = 42_161

ArbitrumTestnet = 421_611

ArbitrumGoerli = 421_613

ArbitrumSepolia = 421_614

ArbitrumNova = 42_170

Cronos = 25

CronosTestnet = 338

Rsk = 30

Crab = 44

Darwinia = 46

Koi = 701

BinanceSmartChain = 56

Note the correct name for BSC should be BNB Smart Chain due to the rebranding: https://www.bnbchain.org/en/blog/bsc-is-now-bnb-chain-the-infrastructure-for-the-metafi-universe We keep Binance Smart Chain for backward compatibility, and the enum could be renamed in the future release.

BinanceSmartChainTestnet = 97

Poa = 99

Sokol = 77

Scroll = 534_352

ScrollSepolia = 534_351

Metis = 1_088

CfxTestnet = 71

Cfx = 1_030

Gnosis = 100

Polygon = 137

PolygonMumbai = 80_001

PolygonAmoy = 80_002

PolygonZkEvm = 1_101

PolygonZkEvmTestnet = 1_442

Fantom = 250

FantomTestnet = 4_002

Moonbeam = 1_284

MoonbeamDev = 1_281

Moonriver = 1_285

Moonbase = 1_287

Dev = 1_337

AnvilHardhat = 31_337

GravityAlphaMainnet = 1_625

GravityAlphaTestnetSepolia = 13_505

Evmos = 9_001

EvmosTestnet = 9_000

Chiado = 10_200

Oasis = 26_863

Emerald = 42_262

EmeraldTestnet = 42_261

FilecoinMainnet = 314

FilecoinCalibrationTestnet = 314_159

Avalanche = 43_114

AvalancheFuji = 43_113

Celo = 42_220

CeloAlfajores = 44_787

CeloBaklava = 62_320

Aurora = 1_313_161_554

AuroraTestnet = 1_313_161_555

Canto = 7_700

CantoTestnet = 740

Boba = 288

Base = 8_453

BaseGoerli = 84_531

BaseSepolia = 84_532

Syndr = 404

SyndrSepolia = 444_444

Shimmer = 148

InkSepolia = 763_373

Fraxtal = 252

FraxtalTestnet = 2_522

Blast = 81_457

BlastSepolia = 168_587_773

Linea = 59_144

LineaGoerli = 59_140

LineaSepolia = 59_141

ZkSync = 324

ZkSyncTestnet = 300

Mantle = 5_000

MantleTestnet = 5_001

MantleSepolia = 5_003

Xai = 660_279

XaiSepolia = 37_714_555_429

Viction = 88

Zora = 7_777_777

ZoraGoerli = 999

ZoraSepolia = 999_999_999

Pgn = 424

PgnSepolia = 58_008

Mode = 34_443

ModeSepolia = 919

Elastos = 20

KakarotSepolia = 920_637_907_288_165

Etherlink = 42_793

EtherlinkTestnet = 128_123

Degen = 666_666_666

OpBNBMainnet = 204

OpBNBTestnet = 5_611

Ronin = 2_020

Taiko = 167_000

TaikoHekla = 167_009

AutonomysNovaTestnet = 490_000

Flare = 14

FlareCoston2 = 114

Acala = 787

AcalaMandalaTestnet = 595

AcalaTestnet = 597

Karura = 686

KaruraTestnet = 596

Pulsechain = 369

PulsechainTestnet = 943

Immutable = 13_371

ImmutableTestnet = 13_473

SoneiumMinatoTestnet = 1_946

World = 480

WorldSepolia = 4_801

Iotex = 4_689

Core = 1_116

Merlin = 4_200

Bitlayer = 200_901

UnichainSepolia = 1_301

ApeChain = 33_139

Curtis = 33_111

SonicTestnet = 64_165

Implementations

impl NamedChain

pub fn as_str(&self) -> &'static str

Returns the string representation of the chain.

pub const fn is_ethereum(&self) -> bool

Returns true if this chain is Ethereum or an Ethereum testnet.

pub const fn is_optimism(self) -> bool

Returns true if the chain contains Optimism configuration.

pub const fn is_arbitrum(self) -> bool

Returns true if the chain contains Arbitrum configuration.

pub const fn average_blocktime_hint(self) -> Option<Duration>

Returns the chain’s average blocktime, if applicable.

It can be beneficial to know the average blocktime to adjust the polling of an HTTP provider for example.

Note: this is not an accurate average, but is rather a sensible default derived from blocktime charts such as Etherscan’s or Polygonscan’s.

Examples

use alloy_chains::NamedChain;
use std::time::Duration;

assert_eq!(NamedChain::Mainnet.average_blocktime_hint(), Some(Duration::from_millis(12_000)),);
assert_eq!(NamedChain::Optimism.average_blocktime_hint(), Some(Duration::from_millis(2_000)),);

pub const fn is_legacy(self) -> bool

Returns whether the chain implements EIP-1559 (with the type 2 EIP-2718 transaction type).

Examples

use alloy_chains::NamedChain;

assert!(!NamedChain::Mainnet.is_legacy());
assert!(NamedChain::Celo.is_legacy());

pub const fn supports_shanghai(self) -> bool

Returns whether the chain supports the Shanghai hardfork.

pub const fn is_testnet(self) -> bool

Returns whether the chain is a testnet.

pub const fn native_currency_symbol(self) -> Option<&'static str>

Returns the symbol of the chain’s native currency.

pub const fn etherscan_urls(self) -> Option<(&'static str, &'static str)>

Returns the chain’s blockchain explorer and its API (Etherscan and Etherscan-like) URLs.

Returns (API_URL, BASE_URL).

All URLs have no trailing /

Examples

use alloy_chains::NamedChain;

assert_eq!(
    NamedChain::Mainnet.etherscan_urls(),
    Some(("https://api.etherscan.io/api", "https://etherscan.io"))
);
assert_eq!(
    NamedChain::Avalanche.etherscan_urls(),
    Some(("https://api.snowtrace.io/api", "https://snowtrace.io"))
);
assert_eq!(NamedChain::AnvilHardhat.etherscan_urls(), None);

pub const fn etherscan_api_key_name(self) -> Option<&'static str>

Returns the chain’s blockchain explorer’s API key environment variable’s default name.

Examples

use alloy_chains::NamedChain;

assert_eq!(NamedChain::Mainnet.etherscan_api_key_name(), Some("ETHERSCAN_API_KEY"));
assert_eq!(NamedChain::AnvilHardhat.etherscan_api_key_name(), None);

pub fn etherscan_api_key(self) -> Option<String>

Available on crate feature std only.

Returns the chain’s blockchain explorer’s API key, from the environment variable with the name specified in etherscan_api_key_name.

Examples

use alloy_chains::NamedChain;

let chain = NamedChain::Mainnet;
std::env::set_var(chain.etherscan_api_key_name().unwrap(), "KEY");
assert_eq!(chain.etherscan_api_key().as_deref(), Some("KEY"));

pub fn public_dns_network_protocol(self) -> Option<String>

Returns the address of the public DNS node list for the given chain.

See also https://github.com/ethereum/discv4-dns-lists.

pub const fn wrapped_native_token(self) -> Option<Address>

Returns the address of the most popular wrapped native token address for this chain, if it exists.

Example:

use alloy_chains::NamedChain;
use alloy_primitives::address;

let chain = NamedChain::Mainnet;
assert_eq!(
    chain.wrapped_native_token(),
    Some(address!("C02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"))
);

Trait Implementations

impl AsRef<str> for NamedChain

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NamedChain

fn clone(&self) -> NamedChain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NamedChain

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

Formats the value using the given formatter.

impl Default for NamedChain

fn default() -> Self

Returns the “default value” for a type.

impl Display for NamedChain

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

Formats the value using the given formatter.

impl EnumCount for NamedChain

const COUNT: usize = 129usize

impl<'_derivative_strum> From<&'_derivative_strum NamedChain> for &'static str

fn from(x: &'_derivative_strum NamedChain) -> &'static str

Converts to this type from the input type.

impl From<NamedChain> for &'static str

fn from(x: NamedChain) -> &'static str

Converts to this type from the input type.

impl From<NamedChain> for Chain

fn from(id: NamedChain) -> Self

Converts to this type from the input type.

impl From<NamedChain> for i128

fn from(chain: NamedChain) -> Self

Converts to this type from the input type.

impl From<NamedChain> for i64

fn from(chain: NamedChain) -> Self

Converts to this type from the input type.

impl From<NamedChain> for u128

fn from(chain: NamedChain) -> Self

Converts to this type from the input type.

impl From<NamedChain> for u64

fn from(chain: NamedChain) -> Self

Converts to this type from the input type.

impl FromStr for NamedChain

type Err = ParseError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for NamedChain

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

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 IntoEnumIterator for NamedChain

type Iterator = NamedChainIter

fn iter() -> NamedChainIter

impl Ord for NamedChain

fn cmp(&self, other: &NamedChain) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<u64> for NamedChain

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for NamedChain

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<u64> for NamedChain

fn partial_cmp(&self, other: &u64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for NamedChain

fn partial_cmp(&self, other: &NamedChain) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for NamedChain

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<NamedChain, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Chain> for NamedChain

type Error = <NamedChain as TryFrom<u64>>::Error

The type returned in the event of a conversion error.

fn try_from(chain: Chain) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i8> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(number: u64) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFrom<u8> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for NamedChain

type Error = TryFromPrimitiveError<NamedChain>

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFromPrimitive for NamedChain

const NAME: &'static str = "NamedChain"

type Primitive = u64

type Error = TryFromPrimitiveError<NamedChain>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl VariantArray for NamedChain

const VARIANTS: &'static [Self] = _

impl VariantNames for NamedChain

const VARIANTS: &'static [&'static str] = _

Names of the variants of this enum

impl Copy for NamedChain

impl Eq for NamedChain

impl StructuralPartialEq for NamedChain