Crate superchain_primitives

superchain-primitives

A set of Superchain Primitive Types.

Usage

Add this to your Cargo.toml:

[dependencies]
superchain-primitives = "0.1.0"

Example

use alloy_primitives::b256;
use superchain_primitives::BlockID;

let block_id = BlockID {
    hash: b256!("0000000000000000000000000000000000000000000000000000000000000000"),
    number: 0u64,
};
println!("Block ID: {block_id}");

Feature Flags

• serde: Implements serialization and deserialization for types.
• std: Uses standard library types.

Re-exports

• pub use predeploys::BASE_FEE_VAULT;
• pub use predeploys::BEACON_BLOCK_ROOT;
• pub use predeploys::EAS;
• pub use predeploys::GAS_PRICE_ORACLE;
• pub use predeploys::GOVERNANCE_TOKEN;
• pub use predeploys::L1_BLOCK;
• pub use predeploys::L1_BLOCK_NUMBER;
• pub use predeploys::L1_FEE_VAULT;
• pub use predeploys::L2_CROSS_DOMAIN_MESSENGER;
• pub use predeploys::L2_ERC721_BRIDGE;
• pub use predeploys::L2_STANDARD_BRIDGE;
• pub use predeploys::L2_TO_L1_MESSAGE_PASSER;
• pub use predeploys::OPTIMISM_MINTABLE_ERC20_FACTORY;
• pub use predeploys::OPTIMISM_MINTABLE_ERC721_FACTORY;
• pub use predeploys::PROXY_ADMIN;
• pub use predeploys::SCHEMA_REGISTRY;
• pub use predeploys::SEQUENCER_FEE_VAULT;
• pub use predeploys::WETH9;

Modules

• predeploys
  Contains all predeploy contract addresses.

Structs

• AddressList
  The set of network-specific contracts for a given chain.
• BlockID
  Block identifier.
• ChainConfig
  A chain configuration.
• ChainGenesis
  Chain genesis information.
• ContractImplementations
  Contract Implementations.
• Genesis
  Re-export the Genesis type from alloy_genesis. The genesis block specification.
• HardForkConfiguration
  Hardfork configuration.
• PlasmaConfig
  Plasma configuration.
• RollupConfig
  The Rollup configuration.
• Superchain
  A superchain configuration.
• SuperchainConfig
  A superchain configuration file format
• SuperchainL1Info
  Superchain L1 anchor information
• SystemConfig
  System configuration.

Enums

• SuperchainLevel
  Level of integration with the superchain.

Constants

• BASE_MAINNET_CONFIG
  The RollupConfig for Base Mainnet.
• BASE_SEPOLIA_BASE_FEE_PARAMS
  Get the base fee parameters for Base Sepolia.
• BASE_SEPOLIA_CANYON_BASE_FEE_PARAMS
  Get the base fee parameters for Base Sepolia (post Canyon).
• BASE_SEPOLIA_CONFIG
  The RollupConfig for Base Sepolia.
• BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER
  Base fee max change denominator for Base Sepolia as defined in the Optimism transaction costs doc.
• OP_BASE_FEE_PARAMS
  Get the base fee parameters for Optimism Mainnet.
• OP_CANYON_BASE_FEE_PARAMS
  Get the base fee parameters for Optimism Mainnet (post Canyon).
• OP_MAINNET_CONFIG
  The RollupConfig for OP Mainnet.
• OP_SEPOLIA_BASE_FEE_PARAMS
  Get the base fee parameters for Optimism Sepolia.
• OP_SEPOLIA_CANYON_BASE_FEE_PARAMS
  Get the base fee parameters for Optimism Sepolia (post Canyon).
• OP_SEPOLIA_CONFIG
  The RollupConfig for OP Sepolia.
• OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON
  Base fee max change denominator for Optimism Sepolia as defined in the Optimism Canyon hardfork.
• OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR
  Base fee max change denominator for Optimism Sepolia as defined in the Optimism transaction costs doc.
• OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER
  Base fee max change denominator for Optimism Sepolia as defined in the Optimism transaction costs doc.

Functions

• is_config_file
  Validates if a file is a configuration file.

Type Aliases

• AddressSet
  A set of addresses for a given contract. The key is the semver version.
• Addresses
  Map of chain IDs to their address lists.
• GenesisSystemConfigs
  Map of chain IDs to their chain’s genesis system configurations.
• Implementations
  Map of superchain names to their implementation contract semvers.
• OPChains
  Map of OPChain IDs to their ChainConfig.
• Superchains
  Map of superchain names to their configurations.