immutables

Documentation

Index

• type DeploymentResults
  • func BuildL2(constructors []deployer.Constructor) (DeploymentResults, error)
  • func BuildOptimism(immutable ImmutableConfig) (DeploymentResults, error)
• type ImmutableConfig
  • func (i ImmutableConfig) Check() error
• type ImmutableValues

Types

type DeploymentResults

type DeploymentResults map[string]hexutil.Bytes

DeploymentResults represents the output of deploying each of the contracts so that the immutables can be set properly in the bytecode.

func BuildL2

func BuildL2(constructors []deployer.Constructor) (DeploymentResults, error)

BuildL2 will deploy contracts to a simulated backend so that their immutables can be properly set. The bytecode returned in the results is suitable to be inserted into the state via state surgery.

func BuildOptimism

func BuildOptimism(immutable ImmutableConfig) (DeploymentResults, error)

BuildOptimism will deploy the L2 predeploys so that their immutables are set correctly.

type ImmutableConfig

type ImmutableConfig map[string]ImmutableValues

ImmutableConfig represents the immutable configuration for the L2 predeploy contracts.

func (ImmutableConfig) Check

func (i ImmutableConfig) Check() error

Check does a sanity check that the specific values that Optimism uses are set inside of the ImmutableConfig.

type ImmutableValues

type ImmutableValues map[string]any

ImmutableValues represents the values to be set in immutable code. The key is the name of the variable and the value is the value to set in immutable code.