chore: refactor mcms evm sequences and operations (#82)

Moves EVM related sequences and operations to the legacy/mcms directory.
Performs some renaming and refactoring to make the code more readable.

Author: jkongie

legacy/mcms/changesets/deploy_mcms_with_timelock.go

@@ -13,8 +13,8 @@ import (
 
 	cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils"
 
+	evmchangesets "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/changesets"
 	"github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"
-	evmchangesets "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm/changesets"
 	solchangesets "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/solana/changesets"
 	opsevm "github.com/smartcontractkit/cld-changesets/pkg/family/evm/operations"
 
@@ -138,7 +138,7 @@ func DeployMCMSWithTimelockV2(
 				if s != nil {
 					chainstate = s[chainSel]
 				}
-				reports, err := evmchangesets.DeployMCMSWithTimelockContractsEVM(env, env.BlockChains.EVMChains()[chainSel], newAddresses, cfg, chainstate)
+				reports, err := evmchangesets.DeployMCMSWithTimelockContracts(env, env.BlockChains.EVMChains()[chainSel], newAddresses, cfg, chainstate)
 				mu.Lock()
 				allReports = append(allReports, reports...)
 				mu.Unlock()

legacy/mcms/changesets/firedrill.go

@@ -91,7 +91,7 @@ func (MCMSSignFireDrillChangeset) Apply(e cldf.Environment, cfg FireDrillConfig)
 	deps := mcops.FireDrillDeps{Environment: e}
 	input := mcops.FireDrillInput{TimelockCfg: cfg.TimelockCfg, Selectors: cfg.Selectors}
 
-	report, err := fwops.ExecuteOperation[mcops.FireDrillInput, mcops.FireDrillOutput, mcops.FireDrillDeps](
+	report, err := fwops.ExecuteOperation(
 		e.OperationsBundle,
 		mcops.BuildMCMSFiredrillProposalOp,
 		deps,

legacy/mcms/changesets/transfer_to_mcms_with_timelock.go

@@ -8,22 +8,21 @@ import (
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
+
 	owner_helpers "github.com/smartcontractkit/ccip-owner-contracts/pkg/gethwrappers"
+	cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
 	mcmscontracts "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/contracts/mcms"
+	cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils"
+	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
+	"github.com/smartcontractkit/chainlink-evm/gethwrappers/shared/generated/initial/burn_mint_erc677"
 	mcmslib "github.com/smartcontractkit/mcms"
 	"github.com/smartcontractkit/mcms/sdk"
 	"github.com/smartcontractkit/mcms/sdk/evm"
 	mcmstypes "github.com/smartcontractkit/mcms/types"
 
-	evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"
-	seqs "github.com/smartcontractkit/cld-changesets/pkg/family/evm/sequences"
-
-	cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
-	cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils"
-	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
-	"github.com/smartcontractkit/chainlink-evm/gethwrappers/shared/generated/initial/burn_mint_erc677"
-
+	seqevm "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/sequences"
 	"github.com/smartcontractkit/cld-changesets/legacy/mcms/proposeutils"
+	evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"
 )
 
 type TransferToMCMSWithTimelockConfig struct {
@@ -135,11 +134,11 @@ func TransferToMCMSWithTimelockV2(
 		e.Logger.Infof("timelock on chain %d is %s, proposer is %s", chainSelector, timelockAddr, proposerAddr)
 		inspectorPerChain[chainSelector] = evm.NewInspector(evmChains[chainSelector].Client)
 
-		seqReport, err := operations.ExecuteSequence(e.OperationsBundle, seqs.SeqTransferToMCMSWithTimelockV2,
-			seqs.SeqTransferToMCMSWithTimelockV2Deps{
+		seqReport, err := operations.ExecuteSequence(e.OperationsBundle, seqevm.SeqTransferToMCMSWithTimelock,
+			seqevm.SeqTransferToMCMSWithTimelockDeps{
 				Chain: evmChains[chainSelector],
 			},
-			seqs.SeqTransferToMCMSWithTimelockV2Input{
+			seqevm.SeqTransferToMCMSWithTimelockInput{
 				ChainSelector:       chainSelector,
 				Timelock:            common.HexToAddress(timelockAddr),
 				Contracts:           contracts,

…/changesets/deploy_mcms_with_timelock.go …/changesets/deploy_mcms_with_timelock.golegacy/pkg/family/evm/changesets/deploy_mcms_with_timelock.go renamed to legacy/mcms/internal/family/evm/changesets/deploy_mcms_with_timelock.go legacy/pkg/family/evm/changesets/deploy_mcms_with_timelock.go renamed to legacy/mcms/internal/family/evm/changesets/deploy_mcms_with_timelock.go

@@ -1,27 +1,19 @@
 package changesets
 
 import (
-	"context"
-	"errors"
-	"fmt"
-	"math"
-	"math/big"
-	"slices"
-
-	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
+
 	bindings "github.com/smartcontractkit/ccip-owner-contracts/pkg/gethwrappers"
 	cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm"
 	cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
 	mcmscontracts "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/contracts/mcms"
 	cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils"
 	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
-	"github.com/spf13/cast"
 
-	"github.com/smartcontractkit/cld-changesets/internal/mcmsrole"
+	opevm "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/operations"
+	seqevm "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/sequences"
 	evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"
-	opsevm "github.com/smartcontractkit/cld-changesets/pkg/family/evm/operations"
-	seqs "github.com/smartcontractkit/cld-changesets/pkg/family/evm/sequences"
+	oputils "github.com/smartcontractkit/cld-changesets/pkg/family/evm/operations"
 )
 
 // DeployMCMSOption is a function that modifies a TypeAndVersion before or after deployment.
@@ -43,12 +35,14 @@ type MCMSWithTimelockEVMDeploy struct {
 	CallProxy *cldf.ContractDeploy[*bindings.CallProxy]
 }
 
-// DeployMCMSWithTimelockContractsEVM deploys an MCMS for
+// DeployMCMSWithTimelockContracts deploys an MCMS for
 // each of the timelock roles Bypasser, ProposerMcm, Canceller on an EVM chain.
 // MCMS contracts for the given configuration
 // as well as the timelock. It's not necessarily the only way to use
 // the timelock and MCMS, but its reasonable pattern.
-func DeployMCMSWithTimelockContractsEVM(
+//
+// This is a deployment helper invoked by DeployMCMSWithTimelock, not a standalone Changeset.
+func DeployMCMSWithTimelockContracts(
 	env cldf.Environment,
 	chain cldf_evm.Chain,
 	ab cldf.AddressBook,
@@ -72,7 +66,7 @@ func DeployMCMSWithTimelockContractsEVM(
 		callProxy = state.CallProxy
 	}
 	if bypasser == nil {
-		seqInput := seqs.SeqDeployMCMWithConfigInput{
+		seqInput := seqevm.SeqDeployMCMWithConfigInput{
 			ContractType:   mcmscontracts.BypasserManyChainMultisig,
 			MCMConfig:      config.Bypasser,
 			ChainSelector:  chain.Selector,
@@ -81,7 +75,7 @@ func DeployMCMSWithTimelockContractsEVM(
 
 		report, err := operations.ExecuteSequence(
 			env.OperationsBundle,
-			seqs.SeqEVMDeployMCMWithConfig,
+			seqevm.SeqDeployMCMWithConfig,
 			chain,
 			seqInput,
 		)
@@ -111,7 +105,7 @@ func DeployMCMSWithTimelockContractsEVM(
 	}
 
 	if canceller == nil {
-		seqInput := seqs.SeqDeployMCMWithConfigInput{
+		seqInput := seqevm.SeqDeployMCMWithConfigInput{
 			ContractType:   mcmscontracts.CancellerManyChainMultisig,
 			MCMConfig:      config.Canceller,
 			ChainSelector:  chain.Selector,
@@ -120,7 +114,7 @@ func DeployMCMSWithTimelockContractsEVM(
 
 		report, err := operations.ExecuteSequence(
 			env.OperationsBundle,
-			seqs.SeqEVMDeployMCMWithConfig,
+			seqevm.SeqDeployMCMWithConfig,
 			chain,
 			seqInput,
 		)
@@ -150,7 +144,7 @@ func DeployMCMSWithTimelockContractsEVM(
 	}
 
 	if proposer == nil {
-		seqInput := seqs.SeqDeployMCMWithConfigInput{
+		seqInput := seqevm.SeqDeployMCMWithConfigInput{
 			ContractType:   mcmscontracts.ProposerManyChainMultisig,
 			MCMConfig:      config.Proposer,
 			ChainSelector:  chain.Selector,
@@ -159,7 +153,7 @@ func DeployMCMSWithTimelockContractsEVM(
 
 		report, err := operations.ExecuteSequence(
 			env.OperationsBundle,
-			seqs.SeqEVMDeployMCMWithConfig,
+			seqevm.SeqDeployMCMWithConfig,
 			chain,
 			seqInput,
 		)
@@ -189,7 +183,7 @@ func DeployMCMSWithTimelockContractsEVM(
 	}
 
 	if timelock == nil {
-		opInput := opsevm.OpEVMDeployTimelockInput{
+		opInput := opevm.OpDeployTimelockInput{
 			// Deployer is the initial admin.
 			// TODO: Could expose this as config?
 			// Or keep this enforced to follow the same pattern?
@@ -205,13 +199,13 @@ func DeployMCMSWithTimelockContractsEVM(
 
 		report, err := operations.ExecuteOperation(
 			env.OperationsBundle,
-			opsevm.OpEVMDeployTimelock,
+			opevm.OpDeployTimelock,
 			chain,
-			opsevm.EVMDeployInput[opsevm.OpEVMDeployTimelockInput]{
+			oputils.EVMDeployInput[opevm.OpDeployTimelockInput]{
 				ChainSelector: chain.Selector,
 				DeployInput:   opInput,
 			},
-			opsevm.RetryDeploymentWithGasBoost[opsevm.OpEVMDeployTimelockInput](config.GasBoostConfig),
+			oputils.RetryDeploymentWithGasBoost[opevm.OpDeployTimelockInput](config.GasBoostConfig),
 		)
 		execReports = append(execReports, report.ToGenericReport())
 		if err != nil {
@@ -240,19 +234,19 @@ func DeployMCMSWithTimelockContractsEVM(
 	}
 
 	if callProxy == nil {
-		opInput := opsevm.OpEVMDeployCallProxyInput{
+		opInput := opevm.OpDeployCallProxyInput{
 			Timelock: timelock.Address(),
 		}
 
 		report, err := operations.ExecuteOperation(
 			env.OperationsBundle,
-			opsevm.OpEVMDeployCallProxy,
+			opevm.OpDeployCallProxy,
 			chain,
-			opsevm.EVMDeployInput[opsevm.OpEVMDeployCallProxyInput]{
+			oputils.EVMDeployInput[opevm.OpDeployCallProxyInput]{
 				ChainSelector: chain.Selector,
 				DeployInput:   opInput,
 			},
-			opsevm.RetryDeploymentWithGasBoost[opsevm.OpEVMDeployCallProxyInput](config.GasBoostConfig),
+			oputils.RetryDeploymentWithGasBoost[opevm.OpDeployCallProxyInput](config.GasBoostConfig),
 		)
 		execReports = append(execReports, report.ToGenericReport())
 		if err != nil {
@@ -295,125 +289,3 @@ func DeployMCMSWithTimelockContractsEVM(
 	// we can remove the deployer as an admin.
 	return execReports, nil
 }
-
-// TODO: delete this function after it is available in timelock Inspector
-func getAdminAddresses(ctx context.Context, timelock *bindings.RBACTimelock) ([]string, error) {
-	numAddresses, err := timelock.GetRoleMemberCount(&bind.CallOpts{
-		Context: ctx,
-	}, mcmsrole.AdminRole.ID)
-	if err != nil {
-		return nil, err
-	}
-	adminAddresses := make([]string, 0, numAddresses.Uint64())
-	for i := range numAddresses.Uint64() {
-		if i > math.MaxUint32 {
-			return nil, fmt.Errorf("value %d exceeds uint32 range", i)
-		}
-		idx, err := cast.ToInt64E(i)
-		if err != nil {
-			return nil, err
-		}
-		address, err := timelock.GetRoleMember(&bind.CallOpts{
-			Context: ctx,
-		}, mcmsrole.AdminRole.ID, big.NewInt(idx))
-		if err != nil {
-			return nil, err
-		}
-		adminAddresses = append(adminAddresses, address.String())
-	}
-
-	return adminAddresses, nil
-}
-
-func GrantRolesForTimelock(
-	env cldf.Environment,
-	chain cldf_evm.Chain,
-	timelockContracts *cldfproposalutils.MCMSWithTimelockContracts,
-	skipIfDeployerKeyNotAdmin bool, // If true, skip role grants if the deployer key is not an admin.
-	gasBoostConfig *cldfproposalutils.GasBoostConfig,
-) (operations.SequenceReport[seqs.SeqGrantRolesTimelockInput, map[uint64][]opsevm.EVMCallOutput], error) {
-	lggr := env.Logger
-	ctx := env.GetContext()
-
-	if timelockContracts == nil {
-		lggr.Errorw("Timelock contracts not found", "chain", chain.String())
-		return operations.SequenceReport[seqs.SeqGrantRolesTimelockInput, map[uint64][]opsevm.EVMCallOutput]{}, fmt.Errorf("timelock contracts not found for chain %s", chain.String())
-	}
-
-	timelock := timelockContracts.Timelock
-	proposer := timelockContracts.ProposerMcm
-	canceller := timelockContracts.CancellerMcm
-	bypasser := timelockContracts.BypasserMcm
-	callProxy := timelockContracts.CallProxy
-
-	// get admin addresses
-	adminAddresses, err := getAdminAddresses(ctx, timelock)
-	if err != nil {
-		return operations.SequenceReport[seqs.SeqGrantRolesTimelockInput, map[uint64][]opsevm.EVMCallOutput]{}, fmt.Errorf("failed to get admin addresses: %w", err)
-	}
-	isDeployerKeyAdmin := slices.Contains(adminAddresses, chain.DeployerKey.From.String())
-	isTimelockAdmin := slices.Contains(adminAddresses, timelock.Address().String())
-	if !isDeployerKeyAdmin && skipIfDeployerKeyNotAdmin {
-		lggr.Infow("Deployer key is not admin, skipping role grants", "chain", chain.String())
-		return operations.SequenceReport[seqs.SeqGrantRolesTimelockInput, map[uint64][]opsevm.EVMCallOutput]{}, nil
-	}
-	if !isDeployerKeyAdmin && !isTimelockAdmin {
-		return operations.SequenceReport[seqs.SeqGrantRolesTimelockInput, map[uint64][]opsevm.EVMCallOutput]{}, errors.New("neither deployer key nor timelock is admin, cannot grant roles")
-	}
-
-	seqDeps := seqs.SeqGrantRolesTimelockDeps{
-		Chain: chain,
-	}
-
-	seqInput := seqs.SeqGrantRolesTimelockInput{
-		ContractType:       mcmscontracts.RBACTimelock,
-		ChainSelector:      chain.Selector,
-		Timelock:           timelock.Address(),
-		IsDeployerKeyAdmin: isDeployerKeyAdmin,
-		RolesAndAddresses: []seqs.RolesAndAddresses{
-			{
-				Role:      mcmsrole.ProposerRole.ID,
-				Name:      mcmsrole.ProposerRole.Name,
-				Addresses: []common.Address{proposer.Address()},
-			},
-			{
-				Role:      mcmsrole.CancellerRole.ID,
-				Name:      mcmsrole.CancellerRole.Name,
-				Addresses: []common.Address{proposer.Address(), canceller.Address(), bypasser.Address()},
-			},
-			{
-				Role:      mcmsrole.BypasserRole.ID,
-				Name:      mcmsrole.BypasserRole.Name,
-				Addresses: []common.Address{bypasser.Address()},
-			},
-			{
-				Role:      mcmsrole.ExecutorRole.ID,
-				Name:      mcmsrole.ExecutorRole.Name,
-				Addresses: []common.Address{callProxy.Address()},
-			},
-		},
-		GasBoostConfig: gasBoostConfig,
-	}
-
-	if !isTimelockAdmin {
-		// We grant the timelock the admin role on the MCMS contracts.
-		seqInput.RolesAndAddresses = append(seqInput.RolesAndAddresses, seqs.RolesAndAddresses{
-			Role:      mcmsrole.AdminRole.ID,
-			Name:      mcmsrole.AdminRole.Name,
-			Addresses: []common.Address{timelock.Address()},
-		})
-	}
-
-	report, err := operations.ExecuteSequence(
-		env.OperationsBundle,
-		seqs.SeqGrantRolesTimelock,
-		seqDeps,
-		seqInput,
-	)
-	if err != nil {
-		lggr.Errorw("Failed to grant roles for timelock", "chain", chain.String(), "err", err)
-		return operations.SequenceReport[seqs.SeqGrantRolesTimelockInput, map[uint64][]opsevm.EVMCallOutput]{}, err
-	}
-
-	return report, nil
-}