Modular etherman

[arnaubennassar]

This discussion suggest changes to be done in the etherman package for it to become more flexible, and enable alt implementations and/or different functionalities

Decoupling base functionality

The main problem with the Etherman is that is coupled to the underlaying SCs. This makes it incompatible if there is another network using different SCs

To fix this a potential solution would be to make the etherman a composition of:

• Base functionality: the non-SC specific functionality that the Etherman has
• SC functionality: one package per SC so it's easier to compose and re-use

package baseetherman // etherman/baseetherman/baseetherman.go

type BaseEtherman struct {
	EthClient             ethereumClient // implement basic Ethereum functionality
    // Remove SC specific part!!
	// ZkEVM                 *polygonzkevm.Polygonzkevm
	// GlobalExitRootManager *polygonzkevmglobalexitroot.Polygonzkevmglobalexitroot
	// Matic                 *matic.Matic
	// SCAddresses           []common.Address

	GasProviders externalGasProviders

	l1Cfg L1Config
	auth  map[common.Address]bind.TransactOpts // empty in case of read-only client
}

// Implemetn the ethereumClient interface:
//	ethereum.ChainReader
//	ethereum.ChainStateReader
//	ethereum.ContractCaller
//	ethereum.GasEstimator
//	ethereum.GasPricer
//	ethereum.LogFilterer
//	ethereum.TransactionReader
//	ethereum.TransactionSender

// Implement other non SC specific methods:
func (etherMan *BaseEtherman) WaitTxToBeMined(ctx context.Context, tx *types.Transaction, timeout time.Duration) (bool, error)

func (etherMan *BaseEtherman) CurrentNonce(ctx context.Context, account common.Address) (uint64, error)

func (etherMan *BaseEtherman) SuggestedGasPrice(ctx context.Context) (*big.Int, error)

func (etherMan *BaseEtherman) EstimateGas(ctx context.Context, from common.Address, to *common.Address, value *big.Int, data []byte) (uint64, error)

func (etherMan *BaseEtherman) CheckTxWasMined(ctx context.Context, txHash common.Hash) (bool, *types.Receipt, error)

func (etherMan *BaseEtherman) SignTx(ctx context.Context, sender common.Address, tx *types.Transaction) (*types.Transaction, error)

func (etherMan *BaseEtherman) GetRevertMessage(ctx context.Context, tx *types.Transaction) (string, error)

func (etherMan *BaseEtherman) AddOrReplaceAuth(auth bind.TransactOpts) error

func (etherMan *BaseEtherman) LoadAuthFromKeyStore(path, password string) (*bind.TransactOpts, error)

// -----
package zkevm // etherman/zkevm/zkevm.go

type ZkEVM struct {
    // ...
}

func New(/*...*/) ZkEVM {
    return ZkEVM{}
}

// Implements zkEVM related methods
func (z *ZkEVM) sequenceBatches(opts bind.TransactOpts, sequences []ethmanTypes.Sequence) (*types.Transaction, error) 
// ...

// -----

package matic // etherman/baseetherman/matic.go

type Matic struct {
    // ...
}

func New(/*...*/) Matic {
    return Matic{}
}

// Implements Matic related methods
func (m *Matic) ApproveMatic(ctx context.Context, account common.Address, maticAmount *big.Int, to common.Address) (*types.Transaction, error)
// ...

// -----
// Do the same for GlobalExitRootManager
// -----

package etherman // etherman/etherman.go

type Etherman struct {
    baseetherman.BaseEtherman

    zkevm.ZkEVM                 
    globalexitrootmanager.GlobalExitRootManager 
    matic.Matic                 
    SCAddresses           []common.Address
}