"""Network data entities for Arbitrum SDK.
This module defines the data structures and functions for managing Arbitrum network
configurations, including core bridge contracts, token bridges, and network metadata.
The module maintains a registry of known Arbitrum networks and provides utilities for
network management and information retrieval.
"""
import dataclasses
from dataclasses import dataclass
from typing import Any, Dict, List, Optional, Type, TypeVar, Union, cast
from eth_typing import HexAddress
from web3 import Web3
from web3.constants import ADDRESS_ZERO
from arbitrum_py.data_entities.constants import (
ARB1_NITRO_GENESIS_L2_BLOCK,
SEVEN_DAYS_IN_SECONDS,
)
from arbitrum_py.data_entities.errors import ArbSdkError
from arbitrum_py.data_entities.signer_or_provider import (
SignerOrProvider,
SignerProviderUtils,
)
from arbitrum_py.utils.helper import CaseDict, load_contract
T = TypeVar("T", bound="ArbitrumNetwork")
[docs]@dataclass
class EthBridge(CaseDict):
"""Core bridging contracts for an Arbitrum chain.
Contains addresses of the fundamental contracts that enable L1<->L2 communication
and state verification.
Attributes:
bridge: Main bridge contract for cross-chain messaging
inbox: Contract that accepts messages from L1 to L2
sequencerInbox: Contract for sequencer's special inbox
outbox: Contract for L2->L1 message execution
rollup: Core rollup contract managing the chain
classicOutboxes: Optional mapping of old outbox addresses to version numbers
"""
bridge: HexAddress
inbox: HexAddress
sequencerInbox: HexAddress
outbox: HexAddress
rollup: HexAddress
classicOutboxes: Optional[Dict[HexAddress, int]] = None
[docs]@dataclass
class TokenBridge(CaseDict):
"""Token bridging contracts for an Arbitrum chain.
Contains addresses of contracts that enable bridging of various token types
between parent and child chains.
Attributes:
parentGatewayRouter: Router on parent chain for token gateway selection
childGatewayRouter: Router on child chain for token gateway selection
parentErc20Gateway: Standard ERC20 gateway on parent chain
childErc20Gateway: Standard ERC20 gateway on child chain
parentCustomGateway: Custom token gateway on parent chain
childCustomGateway: Custom token gateway on child chain
parentWethGateway: WETH gateway on parent chain
childWethGateway: WETH gateway on child chain
parentWeth: WETH token on parent chain
childWeth: WETH token on child chain
parentProxyAdmin: Optional proxy admin on parent chain
childProxyAdmin: Optional proxy admin on child chain
parentMultiCall: Multicall contract on parent chain
childMultiCall: Multicall contract on child chain
"""
parentGatewayRouter: HexAddress
childGatewayRouter: HexAddress
parentErc20Gateway: HexAddress
childErc20Gateway: HexAddress
parentCustomGateway: HexAddress
childCustomGateway: HexAddress
parentWethGateway: HexAddress
childWethGateway: HexAddress
parentWeth: HexAddress
childWeth: HexAddress
parentProxyAdmin: Optional[HexAddress] = None
childProxyAdmin: Optional[HexAddress] = None
parentMultiCall: HexAddress = ADDRESS_ZERO
childMultiCall: HexAddress = ADDRESS_ZERO
[docs]@dataclass
class Teleporter(CaseDict):
"""Teleporter contracts for cross-chain message forwarding.
Contains addresses of contracts that enable direct message forwarding between
chains in the Arbitrum ecosystem.
Attributes:
l1Teleporter: Teleporter contract on L1/parent chain
l2ForwarderFactory: Factory for creating message forwarders on L2/child chain
"""
l1Teleporter: HexAddress
l2ForwarderFactory: HexAddress
[docs]@dataclass
class ArbitrumNetwork(CaseDict):
"""Represents an Arbitrum chain configuration.
Contains all the information needed to interact with an Arbitrum chain,
including bridge contracts, chain identifiers, and network metadata.
Attributes:
name: Name of the chain
chainId: Chain ID of this network
parentChainId: Chain ID of the parent chain
ethBridge: Core bridging contract addresses
confirmPeriodBlocks: Challenge window in L1 blocks
isCustom: Whether this is a user-registered network
tokenBridge: Optional token bridging contract addresses
teleporter: Optional teleporter contract addresses
isTestnet: Whether this is a testnet
explorerUrl: Optional block explorer URL
retryableLifetimeSeconds: Optional retryable ticket lifetime
nativeToken: Optional native token address (None for ETH)
isBold: Optional flag for Bold upgrade status
"""
name: str
chainId: int
parentChainId: int
ethBridge: EthBridge
confirmPeriodBlocks: int
isCustom: bool
tokenBridge: Optional[TokenBridge] = None
teleporter: Optional[Teleporter] = None
isTestnet: bool = True
explorerUrl: Optional[str] = None
retryableLifetimeSeconds: Optional[int] = None
nativeToken: Optional[HexAddress] = None
isBold: Optional[bool] = None
# A global dictionary storing all recognized networks by chain ID
networks: Dict[int, ArbitrumNetwork] = {}
# Pre-populate some known mainnet bridging addresses
mainnet_token_bridge = TokenBridge(
parentGatewayRouter="0x72Ce9c846789fdB6fC1f34aC4AD25Dd9ef7031ef",
childGatewayRouter="0x5288c571Fd7aD117beA99bF60FE0846C4E84F933",
parentErc20Gateway="0xa3A7B6F88361F48403514059F1F16C8E78d60EeC",
childErc20Gateway="0x09e9222E96E7B4AE2a407B98d48e330053351EEe",
parentCustomGateway="0xcEe284F754E854890e311e3280b767F80797180d",
childCustomGateway="0x096760F208390250649E3e8763348E783AEF5562",
parentWethGateway="0xd92023E9d9911199a6711321D1277285e6d4e2db",
childWethGateway="0x6c411aD3E74De3E7Bd422b94A27770f5B86C623B",
parentWeth="0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
childWeth="0x82aF49447D8a07e3bd95BD0d56f35241523fBab1",
parentProxyAdmin="0x9aD46fac0Cf7f790E5be05A0F15223935A0c0aDa",
childProxyAdmin="0xd570aCE65C43af47101fC6250FD6fC63D1c22a86",
parentMultiCall="0x5ba1e12693dc8f9c48aad8770482f4739beed696",
childMultiCall="0x842eC2c7D803033Edf55E478F461FC547Bc54EB2",
)
mainnet_eth_bridge = EthBridge(
bridge="0x8315177aB297bA92A06054cE80a67Ed4DBd7ed3a",
inbox="0x4Dbd4fc535Ac27206064B68FfCf827b0A60BAB3f",
sequencerInbox="0x1c479675ad559DC151F6Ec7ed3FbF8ceE79582B6",
outbox="0x0B9857ae2D4A3DBe74ffE1d7DF045bb7F96E4840",
rollup="0x5eF0D09d1E6204141B4d37530808eD19f60FBa35",
classicOutboxes={
"0x667e23ABd27E623c11d4CC00ca3EC4d0bD63337a": 0,
"0x760723CD2e632826c38Fef8CD438A4CC7E7E1A40": 30,
},
)
# Register known networks
networks[42161] = ArbitrumNetwork(
name="Arbitrum One",
chainId=42161,
parentChainId=1,
ethBridge=mainnet_eth_bridge,
tokenBridge=mainnet_token_bridge,
teleporter=Teleporter(
l1Teleporter="0xCBd9c6e310D6AaDeF9F025f716284162F0158992",
l2ForwarderFactory="0x791d2AbC6c3A459E13B9AdF54Fb5e97B7Af38f87",
),
confirmPeriodBlocks=45818,
isCustom=False,
isTestnet=False,
explorerUrl="https://arbiscan.io",
retryableLifetimeSeconds=SEVEN_DAYS_IN_SECONDS,
nativeToken=None,
)
# Additional networks, e.g. Arbitrum Nova, testnets, etc.
networks[42170] = ArbitrumNetwork(
name="Arbitrum Nova",
chainId=42170,
parentChainId=1,
ethBridge=EthBridge(
bridge="0xC1Ebd02f738644983b6C4B2d440b8e77DdE276Bd",
inbox="0xc4448b71118c9071Bcb9734A0EAc55D18A153949",
sequencerInbox="0x211E1c4c7f1bF5351Ac850Ed10FD68CFfCF6c21b",
outbox="0xD4B80C3D7240325D18E645B49e6535A3Bf95cc58",
rollup="0xFb209827c58283535b744575e11953DCC4bEAD88",
),
tokenBridge=TokenBridge(
parentGatewayRouter="0xC840838Bc438d73C16c2f8b22D2Ce3669963cD48",
childGatewayRouter="0x21903d3F8176b1a0c17E953Cd896610Be9fFDFa8",
parentErc20Gateway="0xB2535b988dcE19f9D71dfB22dB6da744aCac21bf",
childErc20Gateway="0xcF9bAb7e53DDe48A6DC4f286CB14e05298799257",
parentCustomGateway="0x23122da8C581AA7E0d07A36Ff1f16F799650232f",
childCustomGateway="0xbf544970E6BD77b21C6492C281AB60d0770451F4",
parentWethGateway="0xE4E2121b479017955Be0b175305B35f312330BaE",
childWethGateway="0x7626841cB6113412F9c88D3ADC720C9FAC88D9eD",
parentWeth="0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
childWeth="0x722E8BdD2ce80A4422E880164f2079488e115365",
parentProxyAdmin="0xa8f7DdEd54a726eB873E98bFF2C95ABF2d03e560",
childProxyAdmin="0xada790b026097BfB36a5ed696859b97a96CEd92C",
parentMultiCall="0x8896D23AfEA159a5e9b72C9Eb3DC4E2684A38EA3",
childMultiCall="0x5e1eE626420A354BbC9a95FeA1BAd4492e3bcB86",
),
teleporter=Teleporter(
l1Teleporter="0xCBd9c6e310D6AaDeF9F025f716284162F0158992",
l2ForwarderFactory="0x791d2AbC6c3A459E13B9AdF54Fb5e97B7Af38f87",
),
confirmPeriodBlocks=45818,
isCustom=False,
isTestnet=False,
)
networks[421614] = ArbitrumNetwork(
name="Arbitrum Rollup Sepolia Testnet",
chainId=421614,
parentChainId=11155111,
ethBridge=EthBridge(
bridge="0x38f918D0E9F1b721EDaA41302E399fa1B79333a9",
inbox="0xaAe29B0366299461418F5324a79Afc425BE5ae21",
sequencerInbox="0x6c97864CE4bEf387dE0b3310A44230f7E3F1be0D",
outbox="0x65f07C7D521164a4d5DaC6eB8Fac8DA067A3B78F",
rollup="0xd80810638dbDF9081b72C1B33c65375e807281C8",
),
tokenBridge=TokenBridge(
parentGatewayRouter="0xcE18836b233C83325Cc8848CA4487e94C6288264",
childGatewayRouter="0x9fDD1C4E4AA24EEc1d913FABea925594a20d43C7",
parentErc20Gateway="0x902b3E5f8F19571859F4AB1003B960a5dF693aFF",
childErc20Gateway="0x6e244cD02BBB8a6dbd7F626f05B2ef82151Ab502",
parentCustomGateway="0xba2F7B6eAe1F9d174199C5E4867b563E0eaC40F3",
childCustomGateway="0x8Ca1e1AC0f260BC4dA7Dd60aCA6CA66208E642C5",
parentWethGateway="0xA8aD8d7e13cbf556eE75CB0324c13535d8100e1E",
childWethGateway="0xCFB1f08A4852699a979909e22c30263ca249556D",
parentWeth="0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9",
childWeth="0x980B62Da83eFf3D4576C647993b0c1D7faf17c73",
parentProxyAdmin="0xDBFC2FfB44A5D841aB42b0882711ed6e5A9244b0",
childProxyAdmin="0x715D99480b77A8d9D603638e593a539E21345FdF",
parentMultiCall="0xded9AD2E65F3c4315745dD915Dbe0A4Df61b2320",
childMultiCall="0xA115146782b7143fAdB3065D86eACB54c169d092",
),
teleporter=Teleporter(
l1Teleporter="0x9E86BbF020594D7FFe05bF32EEDE5b973579A968",
l2ForwarderFactory="0x88feBaFBb4E36A4E7E8874E4c9Fd73A9D59C2E7c",
),
confirmPeriodBlocks=20,
isCustom=False,
isTestnet=True,
)
# Additional networks, e.g. Arbitrum Nova, testnets, etc.
# networks[42170], networks[421614], etc. defined similarly...
[docs]def get_arbitrum_networks() -> List[ArbitrumNetwork]:
"""Returns all registered Arbitrum networks.
Returns a list of all Arbitrum networks known to the SDK, including both
default networks and any custom networks registered by the user.
Returns:
List of ArbitrumNetwork objects
"""
return list(networks.values())
[docs]def is_parent_network(parent_chain_or_chain_id: Union[ArbitrumNetwork, int]) -> bool:
"""Determines if a chain is a parent of any other chain.
A chain is considered a parent if any other chain references it as its
parentChainId. The chain could be an L1 or an L2 chain.
Args:
parent_chain_or_chain_id: Either an ArbitrumNetwork object or chain ID
Returns:
True if the chain is a parent of any other chain, False otherwise
"""
parent_chain_id = (
parent_chain_or_chain_id.chainId
if isinstance(parent_chain_or_chain_id, ArbitrumNetwork)
else parent_chain_or_chain_id
)
return any(net.parentChainId == parent_chain_id for net in get_arbitrum_networks())
[docs]def get_children_for_network(parent_chain_or_chain_id: Union[ArbitrumNetwork, int]) -> List[ArbitrumNetwork]:
"""Returns all child chains for a given chain.
Finds all Arbitrum networks that have the specified chain as their parent.
Args:
parent_chain_or_chain_id: Either an ArbitrumNetwork object or chain ID
Returns:
List of ArbitrumNetwork objects that are children of the given chain
"""
parent_chain_id = (
parent_chain_or_chain_id.chainId
if isinstance(parent_chain_or_chain_id, ArbitrumNetwork)
else parent_chain_or_chain_id
)
return [c for c in get_arbitrum_networks() if c.parentChainId == parent_chain_id]
[docs]def get_arbitrum_network(provider_or_chain_id: Union[SignerOrProvider, Web3, int]) -> Union[ArbitrumNetwork, None]:
"""Returns the Arbitrum network for a provider or chain ID.
If given a chain ID, looks up the network directly. If given a provider,
gets the chain ID from the provider first.
Args:
provider_or_chain_id: Either a chain ID or a provider/signer
Returns:
The matching ArbitrumNetwork or None if not found
Raises:
ArbSdkError: If the chain is not a recognized Arbitrum chain
"""
if isinstance(provider_or_chain_id, int):
return get_arbitrum_network_by_chain_id(provider_or_chain_id)
else:
return get_arbitrum_network_by_provider(SignerProviderUtils.get_provider_or_throw(provider_or_chain_id))
[docs]def get_arbitrum_network_by_chain_id(chain_id: int) -> ArbitrumNetwork:
"""Returns an Arbitrum network by its chain ID.
Args:
chain_id: The chain ID to look up
Returns:
The matching ArbitrumNetwork
Raises:
ArbSdkError: If no network is found for the chain ID
"""
net = next((n for n in get_arbitrum_networks() if n.chainId == chain_id), None)
if not net:
raise ArbSdkError(f"Unrecognized network {chain_id}.")
return net
[docs]def get_arbitrum_network_by_provider(provider: Union[SignerOrProvider, Web3]) -> ArbitrumNetwork:
"""Returns an Arbitrum network for a provider.
Gets the chain ID from the provider and looks up the corresponding network.
Args:
provider: A provider or signer connected to an Arbitrum chain
Returns:
The matching ArbitrumNetwork
Raises:
ArbSdkError: If the provider's chain is not a recognized Arbitrum chain
"""
return get_arbitrum_network_by_chain_id(SignerProviderUtils.get_provider_or_throw(provider).eth.chain_id)
[docs]def get_native_token(bridge: HexAddress, provider: Union[SignerOrProvider, Web3]) -> HexAddress:
"""Gets the native token address from a bridge contract.
Attempts to call nativeToken() on the bridge contract. Returns ADDRESS_ZERO
if the call fails or the contract doesn't implement the method.
Args:
bridge: Address of the bridge contract
provider: Provider for making the contract call
Returns:
The native token address or ADDRESS_ZERO
"""
try:
provider = SignerProviderUtils.get_provider_or_throw(provider)
bridge_contract = load_contract(
provider=provider,
contract_name="IERC20Bridge",
address=bridge,
)
return cast(HexAddress, bridge_contract.functions.nativeToken().call())
except:
return cast(HexAddress, ADDRESS_ZERO)
[docs]def register_custom_arbitrum_network(
network: ArbitrumNetwork, options: Optional[Dict[str, bool]] = None
) -> ArbitrumNetwork:
"""Registers a custom Arbitrum network.
Adds a user-defined network to the SDK's network registry. The network
must have isCustom=True.
Args:
network: The ArbitrumNetwork to register
options: Optional dict with:
- throwIfAlreadyRegistered (bool): If True, raises an error if the
network is already registered
Returns:
The registered ArbitrumNetwork
Raises:
ArbSdkError: If network.isCustom is False or if the network is already
registered and throwIfAlreadyRegistered is True
"""
if isinstance(network, dict):
network = dict_to_arbitrum_network_instance(network)
elif not isinstance(network, ArbitrumNetwork):
raise ArbSdkError("Network must be an instance of ArbitrumNetwork or a dictionary.")
if not network.isCustom:
raise ArbSdkError(f"Custom network {network.chainId} must have isCustom flag set to true")
if network.chainId in networks:
throw = options.get("throwIfAlreadyRegistered", False) if options else False
if throw:
raise ArbSdkError(f"Network with chain ID {network.chainId} already registered.")
return networks[network.chainId]
networks[network.chainId] = network
return network
[docs]def dict_to_arbitrum_network_instance(data: Union[Dict[str, Any], CaseDict]) -> ArbitrumNetwork:
"""Converts a dictionary to an ArbitrumNetwork instance.
Creates a properly typed ArbitrumNetwork instance from a dictionary,
handling nested objects like EthBridge and TokenBridge.
Args:
data: Dict or CaseDict containing network data
Returns:
An ArbitrumNetwork instance with all fields properly typed
Example:
>>> network = dict_to_arbitrum_network_instance({
... 'chainId': 42161,
... 'eth_bridge': {...},
... 'tokenBridge': existing_token_bridge_instance,
... })
"""
def convert_to_instance(value: Any, target_class: Type) -> Any:
"""Recursively convert value to appropriate class instance"""
if isinstance(value, target_class):
return value
if isinstance(value, (dict, CaseDict)):
# Convert to dict if CaseDict
value_dict = value.to_dict() if isinstance(value, CaseDict) else value
# Get class fields excluding methods and private attrs
fields = {f.name for f in dataclasses.fields(target_class)}
# Normalize and filter input data to match class fields
normalized_data = {}
for field in fields:
# Try different case variations
for key in [field, CaseDict.snake_to_camel(field), CaseDict.camel_to_snake(field)]:
if key in value_dict:
field_type = target_class.__annotations__.get(field)
field_value = value_dict[key]
# Recursively convert nested objects
if dataclasses.is_dataclass(field_type) and field_value is not None:
normalized_data[field] = convert_to_instance(field_value, field_type)
else:
normalized_data[field] = field_value
break
return target_class(**normalized_data)
return value
return convert_to_instance(data, ArbitrumNetwork)
[docs]def create_network_state_handler() -> Dict[str, Any]:
"""Creates a handler for managing network state.
Returns a dictionary containing functions to manage the network registry,
particularly useful for testing and development.
Returns:
Dict with:
- resetNetworksToDefault: Function to reset networks to initial state
"""
initial_networks = networks.copy()
def reset_networks_to_default() -> None:
networks.clear()
networks.update(initial_networks)
return {"resetNetworksToDefault": reset_networks_to_default}
[docs]def get_nitro_genesis_block(arbitrum_chain_or_chain_id: Union[ArbitrumNetwork, int]) -> int:
"""Gets the Nitro genesis block for a chain.
Returns the block number where the Nitro upgrade was activated for a chain.
For Arbitrum One this is ARB1_NITRO_GENESIS_L2_BLOCK, for others it's 0.
Args:
arbitrum_chain_or_chain_id: Either an ArbitrumNetwork or chain ID
Returns:
The Nitro genesis block number
"""
chain_id = (
arbitrum_chain_or_chain_id.chainId
if isinstance(arbitrum_chain_or_chain_id, ArbitrumNetwork)
else arbitrum_chain_or_chain_id
)
return ARB1_NITRO_GENESIS_L2_BLOCK if chain_id == 42161 else 0
[docs]def get_multicall_address(provider_or_chain_id: Union[SignerOrProvider, Web3, int]) -> HexAddress:
"""Gets the multicall contract address for a chain.
Looks up the multicall address in the chain's token bridge configuration.
If not found, checks if any chain references this as a parent and returns
that chain's parent multicall address.
Args:
provider_or_chain_id: Either a chain ID or provider
Returns:
The multicall contract address
Raises:
ValueError: If the chain is not recognized
"""
chain_id = (
provider_or_chain_id
if isinstance(provider_or_chain_id, int)
else SignerProviderUtils.get_provider_or_throw(provider_or_chain_id).eth.chain_id
)
# If the chain is recognized in 'networks'
chain = next((c for c in get_arbitrum_networks() if c.chainId == chain_id), None)
if chain:
assert_arbitrum_network_has_token_bridge(chain)
return chain.tokenBridge.childMultiCall # Return the child chain's multicall
# If not recognized, see if any chain references this chain as its parent
child_chain = next((c for c in get_arbitrum_networks() if c.parentChainId == chain_id), None)
if not child_chain:
raise ValueError(f"Failed to retrieve Multicall address for chain: {chain_id}")
assert_arbitrum_network_has_token_bridge(child_chain)
return child_chain.tokenBridge.parentMultiCall
[docs]def map_l2_network_token_bridge_to_token_bridge(input_bridge) -> TokenBridge:
"""
Maps the older L2Network.tokenBridge object (SDK v3) to the new v4 TokenBridge format.
:param input_bridge: The legacy object with fields like l1GatewayRouter, l2GatewayRouter, etc.
:return: A new TokenBridge dataclass instance reflecting the updated naming conventions.
"""
return TokenBridge(
parentGatewayRouter=input_bridge["l1GatewayRouter"],
childGatewayRouter=input_bridge["l2GatewayRouter"],
parentErc20Gateway=input_bridge["l1ERC20Gateway"],
childErc20Gateway=input_bridge["l2ERC20Gateway"],
parentCustomGateway=input_bridge["l1CustomGateway"],
childCustomGateway=input_bridge["l2CustomGateway"],
parentWethGateway=input_bridge["l1WethGateway"],
childWethGateway=input_bridge["l2WethGateway"],
parentWeth=input_bridge["l1Weth"],
childWeth=input_bridge["l2Weth"],
parentProxyAdmin=input_bridge["l1ProxyAdmin"],
childProxyAdmin=input_bridge["l2ProxyAdmin"],
parentMultiCall=input_bridge["l1MultiCall"],
childMultiCall=input_bridge["l2Multicall"],
)
[docs]def map_l2_network_to_arbitrum_network(l2_network: Dict[str, Any]) -> ArbitrumNetwork:
"""
Maps the old L2Network object (SDK v3) to a new ArbitrumNetwork (SDK v4).
Retains other fields while renaming chainID -> chainId, partnerChainID -> parentChainId, etc.
:param l2_network: The old L2Network object as a dictionary
:return: A new ArbitrumNetwork instance
"""
# Start by copying all properties
mapped_network = l2_network.copy()
# Rename specific fields
if "chainID" in mapped_network:
mapped_network["chainId"] = mapped_network.pop("chainID")
if "partnerChainID" in mapped_network:
mapped_network["parentChainId"] = mapped_network.pop("partnerChainID")
# Map tokenBridge field
if "tokenBridge" in mapped_network and mapped_network["tokenBridge"] is not None:
mapped_network["tokenBridge"] = map_l2_network_token_bridge_to_token_bridge(mapped_network["tokenBridge"])
# Convert ethBridge dict to EthBridge dataclass
if "ethBridge" in mapped_network and isinstance(mapped_network["ethBridge"], dict):
mapped_network["ethBridge"] = EthBridge(**mapped_network["ethBridge"])
# Convert teleporter dict to Teleporter dataclass if present
if "teleporter" in mapped_network and isinstance(mapped_network["teleporter"], dict):
mapped_network["teleporter"] = Teleporter(**mapped_network["teleporter"])
# Create and return the ArbitrumNetwork instance
return dict_to_arbitrum_network_instance(mapped_network)
[docs]def assert_arbitrum_network_has_token_bridge(network: ArbitrumNetwork) -> None:
"""Asserts that a network has token bridge configuration.
Args:
network: The ArbitrumNetwork to check
Raises:
ArbSdkError: If the network does not have a token bridge configuration
"""
if not network or not network.tokenBridge:
raise ArbSdkError(f"Network {network.name} does not have token bridge configuration")
[docs]def is_arbitrum_network_native_token_ether(network: ArbitrumNetwork) -> bool:
"""Checks if a network uses ETH as its native token.
A network uses ETH as its native token if nativeToken is None or ADDRESS_ZERO.
Otherwise, it uses an ERC20 token from the parent chain.
Args:
network: The ArbitrumNetwork to check
Returns:
True if the network uses ETH as its native token, False otherwise
"""
return (network.nativeToken is None) or (network.nativeToken == ADDRESS_ZERO)
# Create and expose our state handler
network_handler = create_network_state_handler()
reset_networks_to_default = network_handler["resetNetworksToDefault"]