txallowlist

Documentation

Index

• Constants
• Variables
• func GetTxAllowListStatus(stateDB contract.StateDB, address common.Address) allowlist.Role
• func SetTxAllowListStatus(stateDB contract.StateDB, address common.Address, role allowlist.Role)
• type Config
  • func NewConfig(blockTimestamp *uint64, admins []common.Address, enableds []common.Address, ...) *Config
  • func NewDisableConfig(blockTimestamp *uint64) *Config
  • func (c *Config) Equal(cfg precompileconfig.Config) bool
  • func (c *Config) Key() string
  • func (c *Config) Verify(chainConfig precompileconfig.ChainConfig) error

Constants

const ConfigKey = "txAllowListConfig"

ConfigKey is the key used in json config files to specify this precompile config. must be unique across all precompiles.

Variables

var ContractAddress = common.HexToAddress("0x0200000000000000000000000000000000000002")

var Module = modules.Module{
	ConfigKey:    ConfigKey,
	Address:      ContractAddress,
	Contract:     TxAllowListPrecompile,
	Configurator: &configurator{},
}

var TxAllowListPrecompile contract.StatefulPrecompiledContract = allowlist.CreateAllowListPrecompile(ContractAddress)

Singleton StatefulPrecompiledContract for W/R access to the tx allow list.

Functions

func GetTxAllowListStatus

func GetTxAllowListStatus(stateDB contract.StateDB, address common.Address) allowlist.Role

GetTxAllowListStatus returns the role of [address] for the tx allow list.

func SetTxAllowListStatus

func SetTxAllowListStatus(stateDB contract.StateDB, address common.Address, role allowlist.Role)

SetTxAllowListStatus sets the permissions of [address] to [role] for the tx allow list. assumes [role] has already been verified as valid.

Types

type Config

type Config struct {
	allowlist.AllowListConfig
	precompileconfig.Upgrade
}

Config implements the StatefulPrecompileConfig interface while adding in the TxAllowList specific precompile config.

func NewConfig

func NewConfig(blockTimestamp *uint64, admins []common.Address, enableds []common.Address, managers []common.Address) *Config

NewConfig returns a config for a network upgrade at [blockTimestamp] that enables TxAllowList with the given [admins], [enableds] and [managers] as members of the allowlist.

func NewDisableConfig

func NewDisableConfig(blockTimestamp *uint64) *Config

NewDisableConfig returns config for a network upgrade at [blockTimestamp] that disables TxAllowList.

func (*Config) Equal

func (c *Config) Equal(cfg precompileconfig.Config) bool

Equal returns true if [cfg] is a [*TxAllowListConfig] and it has been configured identical to [c].

func (*Config) Key

func (c *Config) Key() string

func (*Config) Verify

func (c *Config) Verify(chainConfig precompileconfig.ChainConfig) error