feat: deploy custom topology mcms [CLD-2766] (#100)

To be merged after:
#99
Implements the deploy custom topology changeset and sequences for EVM
which allows users to deploy custom mcms / timelock structures without
custom coding topologies.

## AI Summary
This pull request refactors the EVM operations code in the MCMS legacy
changesets by consolidating and updating imports to use a newer,
centralized `evm/operations` package. The changes primarily involve
replacing references to the old `oputil` and legacy operation types with
the new `evmops` types and functions, improving maintainability and
consistency across the codebase. No functional logic is altered; this is
a structural cleanup.

**Refactoring and Codebase Cleanup:**

* Replaced all imports of `oputil` and legacy operation types in
multiple files (such as `deploy_mcms_with_timelock.go`,
`grant_timelock.go`, and various operation and sequence files) with the
new `evmops` package from `mcms/evm/operations` for EVM operation
utilities and types.
[[1]](diffhunk://#diff-b2398611f89ecae075cf3fa2ebc54fffdb5be3053e22ec48a758b897a3fe4f2eL24-R26)
[[2]](diffhunk://#diff-d65ee785393e80500d9a9e10b6be88af9066f272f273b3a495ca51eb62bcf1caL14-R16)
[[3]](diffhunk://#diff-01347b473bc84fecfbfd6e74fc8d3ceab6f5f46df817b98912390a91abded6e9L23-R24)
[[4]](diffhunk://#diff-d06b9c5105af450ff38a3d1088e63930739725c5d769c418e049501f2a9ee774L12-R25)
[[5]](diffhunk://#diff-bbc03c83b6d0480e7d8522c83792e93540a723fd77538ee68aa6f4680b91d026L14-R14)
[[6]](diffhunk://#diff-2ba3562716d4f675ca494b4cdd289784a1a11084bf6819b9fe02e3b129822741L12-R20)
[[7]](diffhunk://#diff-6e44b5b90b68ec00183f14c09ca6f134d53654e8ee03c3cfe811033a07ccdf1dL12-R12)
[[8]](diffhunk://#diff-f7f4b27536717322f79551fe53d332068a4a60df6ec498e5b17a504932fe953cL12-R25)
[[9]](diffhunk://#diff-af27581a8ad86d0f1ecc0da7328dd4557658d19be900e98f4cd95b8588c6b3f2L17-R18)
[[10]](diffhunk://#diff-1fd84ce86f315635e347f82581e4070196a811f934685fa1a908b24d67089ffeL17-R18)

* Updated all usages of EVM operation constructors and types (e.g.,
`NewEVMDeployOperation`, `NewEVMCallOperation`, `EVMDeployInput`,
`RetryDeploymentWithGasBoost`, `EVMCallOutput`, etc.) to use the new
`evmops` equivalents, ensuring type compatibility and consistency.
[[1]](diffhunk://#diff-b2398611f89ecae075cf3fa2ebc54fffdb5be3053e22ec48a758b897a3fe4f2eL259-R259)
[[2]](diffhunk://#diff-b2398611f89ecae075cf3fa2ebc54fffdb5be3053e22ec48a758b897a3fe4f2eL271-R271)
[[3]](diffhunk://#diff-d65ee785393e80500d9a9e10b6be88af9066f272f273b3a495ca51eb62bcf1caL204-R208)
[[4]](diffhunk://#diff-d65ee785393e80500d9a9e10b6be88af9066f272f273b3a495ca51eb62bcf1caL245-R249)
[[5]](diffhunk://#diff-01347b473bc84fecfbfd6e74fc8d3ceab6f5f46df817b98912390a91abded6e9L41-R47)
[[6]](diffhunk://#diff-01347b473bc84fecfbfd6e74fc8d3ceab6f5f46df817b98912390a91abded6e9L59-R68)
[[7]](diffhunk://#diff-01347b473bc84fecfbfd6e74fc8d3ceab6f5f46df817b98912390a91abded6e9L122-R122)
[[8]](diffhunk://#diff-d06b9c5105af450ff38a3d1088e63930739725c5d769c418e049501f2a9ee774L12-R25)
[[9]](diffhunk://#diff-bbc03c83b6d0480e7d8522c83792e93540a723fd77538ee68aa6f4680b91d026L26-R32)
[[10]](diffhunk://#diff-2ba3562716d4f675ca494b4cdd289784a1a11084bf6819b9fe02e3b129822741L12-R20)
[[11]](diffhunk://#diff-6e44b5b90b68ec00183f14c09ca6f134d53654e8ee03c3cfe811033a07ccdf1dL22-R22)
[[12]](diffhunk://#diff-f7f4b27536717322f79551fe53d332068a4a60df6ec498e5b17a504932fe953cL35-R41)
[[13]](diffhunk://#diff-f7f4b27536717322f79551fe53d332068a4a60df6ec498e5b17a504932fe953cL51-R57)
[[14]](diffhunk://#diff-af27581a8ad86d0f1ecc0da7328dd4557658d19be900e98f4cd95b8588c6b3f2L48-R53)
[[15]](diffhunk://#diff-af27581a8ad86d0f1ecc0da7328dd4557658d19be900e98f4cd95b8588c6b3f2L83-R94)
[[16]](diffhunk://#diff-af27581a8ad86d0f1ecc0da7328dd4557658d19be900e98f4cd95b8588c6b3f2L122-R122)

* Adjusted function signatures and return types throughout the EVM
operation and sequence logic to use the new types from `evmops`,
removing all direct dependencies on the deprecated `oputil` package.
[[1]](diffhunk://#diff-01347b473bc84fecfbfd6e74fc8d3ceab6f5f46df817b98912390a91abded6e9L41-R47)
[[2]](diffhunk://#diff-01347b473bc84fecfbfd6e74fc8d3ceab6f5f46df817b98912390a91abded6e9L59-R68)
[[3]](diffhunk://#diff-01347b473bc84fecfbfd6e74fc8d3ceab6f5f46df817b98912390a91abded6e9L122-R122)
[[4]](diffhunk://#diff-af27581a8ad86d0f1ecc0da7328dd4557658d19be900e98f4cd95b8588c6b3f2L48-R53)
[[5]](diffhunk://#diff-af27581a8ad86d0f1ecc0da7328dd4557658d19be900e98f4cd95b8588c6b3f2L83-R94)
[[6]](diffhunk://#diff-af27581a8ad86d0f1ecc0da7328dd4557658d19be900e98f4cd95b8588c6b3f2L122-R122)

This update is a non-functional, structural refactor that will make
future maintenance and enhancements easier by consolidating EVM
operation logic in a single, modern package.

---------

Signed-off-by: Pablo Estrada <139084212+ecPablo@users.noreply.github.com>
Co-authored-by: Graham Goh <graham.goh@smartcontract.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 3 people

legacy/mcms/changesets/deploy_mcms_with_timelock.go

@@ -21,9 +21,9 @@ import (
 	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
 
 	evmchangesets "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/changesets"
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
 	"github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"
 	solchangesets "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/solana/changesets"
+	evmops "github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 // migrateAddressBookWithQualifiers migrates an address book to a data store,
@@ -256,7 +256,7 @@ func grantRoleLogic(e cldf.Environment, cfg GrantRoleInput) (cldf.ChangesetOutpu
 	}
 
 	out := cldf.ChangesetOutput{}
-	gasBoostConfigs := oputil.GasBoostConfigsForChainMap(cfg.ExistingProposerByChain, cfg.GasBoostConfigPerChain)
+	gasBoostConfigs := evmops.GasBoostConfigsForChainMap(cfg.ExistingProposerByChain, cfg.GasBoostConfigPerChain)
 	for chain := range cfg.ExistingProposerByChain {
 		stateForChain := mcmsState[chain]
 		evmChains := e.BlockChains.EVMChains()
@@ -268,7 +268,7 @@ func grantRoleLogic(e cldf.Environment, cfg GrantRoleInput) (cldf.ChangesetOutpu
 				Timelock:     stateForChain.Timelock,
 				CallProxy:    stateForChain.CallProxy,
 			}, false, gasBoostConfigs[chain])
-		out, err = oputil.AddEVMCallSequenceToCSOutput(e, out, seqReport, err, mcmsStateForProposal, cfg.MCMS, fmt.Sprintf("GrantRolesForTimelock on %s", evmChains[chain]))
+		out, err = evmops.AddEVMCallSequenceToCSOutput(e, out, seqReport, err, mcmsStateForProposal, cfg.MCMS, fmt.Sprintf("GrantRolesForTimelock on %s", evmChains[chain]))
 		if err != nil {
 			return out, fmt.Errorf("failed to grant roles for timelock on chain %d: %w", chain, err)
 		}

legacy/mcms/internal/family/evm/changesets/deploy_mcms_with_timelock.go

@@ -11,9 +11,9 @@ import (
 	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
 
 	opevm "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/operations"
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
 	seqevm "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/sequences"
 	evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"
+	evmops "github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 // DeployMCMSOption is a function that modifies a TypeAndVersion before or after deployment.
@@ -201,11 +201,11 @@ func DeployMCMSWithTimelockContracts(
 			env.OperationsBundle,
 			opevm.OpDeployTimelock,
 			chain,
-			oputil.EVMDeployInput[opevm.OpDeployTimelockInput]{
+			evmops.EVMDeployInput[opevm.OpDeployTimelockInput]{
 				ChainSelector: chain.Selector,
 				DeployInput:   opInput,
 			},
-			oputil.RetryDeploymentWithGasBoost[opevm.OpDeployTimelockInput](config.GasBoostConfig),
+			evmops.RetryDeploymentWithGasBoost[opevm.OpDeployTimelockInput](config.GasBoostConfig),
 		)
 		execReports = append(execReports, report.ToGenericReport())
 		if err != nil {
@@ -242,11 +242,11 @@ func DeployMCMSWithTimelockContracts(
 			env.OperationsBundle,
 			opevm.OpDeployCallProxy,
 			chain,
-			oputil.EVMDeployInput[opevm.OpDeployCallProxyInput]{
+			evmops.EVMDeployInput[opevm.OpDeployCallProxyInput]{
 				ChainSelector: chain.Selector,
 				DeployInput:   opInput,
 			},
-			oputil.RetryDeploymentWithGasBoost[opevm.OpDeployCallProxyInput](config.GasBoostConfig),
+			evmops.RetryDeploymentWithGasBoost[opevm.OpDeployCallProxyInput](config.GasBoostConfig),
 		)
 		execReports = append(execReports, report.ToGenericReport())
 		if err != nil {

legacy/mcms/internal/family/evm/changesets/grant_timelock.go

@@ -20,8 +20,8 @@ import (
 	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
 
 	"github.com/smartcontractkit/cld-changesets/internal/mcmsrole"
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
 	seqevm "github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/sequences"
+	evmops "github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 // GrantRolesForTimelock grants RBACTimelock roles to the MCMS contracts in timelockContracts.
@@ -38,13 +38,13 @@ func GrantRolesForTimelock(
 	timelockContracts *cldfproposalutils.MCMSWithTimelockContracts,
 	skipIfDeployerKeyNotAdmin bool, // If true, skip role grants if the deployer key is not an admin.
 	gasBoostConfig *cldfproposalutils.GasBoostConfig,
-) (operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]oputil.EVMCallOutput], error) {
+) (operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]evmops.EVMCallOutput], error) {
 	lggr := env.Logger
 	ctx := env.GetContext()
 
 	if timelockContracts == nil {
 		lggr.Errorw("Timelock contracts not found", "chain", chain.String())
-		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]oputil.EVMCallOutput]{}, fmt.Errorf("timelock contracts not found for chain %s", chain.String())
+		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]evmops.EVMCallOutput]{}, fmt.Errorf("timelock contracts not found for chain %s", chain.String())
 	}
 
 	timelock := timelockContracts.Timelock
@@ -56,16 +56,16 @@ func GrantRolesForTimelock(
 	// get admin addresses
 	adminAddresses, err := getAdminAddresses(ctx, timelock)
 	if err != nil {
-		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]oputil.EVMCallOutput]{}, fmt.Errorf("failed to get admin addresses: %w", err)
+		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]evmops.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[seqevm.SeqGrantRolesTimelockInput, map[uint64][]oputil.EVMCallOutput]{}, nil
+		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]evmops.EVMCallOutput]{}, nil
 	}
 	if !isDeployerKeyAdmin && !isTimelockAdmin {
-		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]oputil.EVMCallOutput]{}, errors.New("neither deployer key nor timelock is admin, cannot grant roles")
+		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]evmops.EVMCallOutput]{}, errors.New("neither deployer key nor timelock is admin, cannot grant roles")
 	}
 
 	seqDeps := seqevm.SeqGrantRolesTimelockDeps{
@@ -119,7 +119,7 @@ func GrantRolesForTimelock(
 	)
 	if err != nil {
 		lggr.Errorw("Failed to grant roles for timelock", "chain", chain.String(), "err", err)
-		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]oputil.EVMCallOutput]{}, err
+		return operations.SequenceReport[seqevm.SeqGrantRolesTimelockInput, map[uint64][]evmops.EVMCallOutput]{}, err
 	}
 
 	return report, nil

legacy/mcms/internal/family/evm/operations/op_deploy_call_proxy.go

@@ -9,20 +9,20 @@ import (
 	zkbindings "github.com/smartcontractkit/mcms/sdk/zksync/bindings"
 
 	"github.com/smartcontractkit/cld-changesets/internal/semvers"
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
+	"github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 type OpDeployCallProxyInput struct {
 	Timelock common.Address `json:"timelock"`
 }
 
-var OpDeployCallProxy = oputil.NewEVMDeployOperation(
+var OpDeployCallProxy = operations.NewEVMDeployOperation(
 	"evm-call-proxy-deploy",
 	semver.MustParse("1.0.0"),
 	"Deploys CallProxy contract on the specified EVM chains",
 	mcmscontracts.CallProxy,
 	bindings.CallProxyMetaData,
-	&oputil.ContractOpts{
+	&operations.ContractOpts{
 		Version:          &semvers.V1_0_0,
 		EVMBytecode:      common.FromHex(bindings.CallProxyBin),
 		ZkSyncVMBytecode: zkbindings.CallProxyZkBytecode,

legacy/mcms/internal/family/evm/operations/op_deploy_timelock.go

@@ -11,7 +11,7 @@ import (
 	zkbindings "github.com/smartcontractkit/mcms/sdk/zksync/bindings"
 
 	"github.com/smartcontractkit/cld-changesets/internal/semvers"
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
+	"github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 type OpDeployTimelockInput struct {
@@ -23,13 +23,13 @@ type OpDeployTimelockInput struct {
 	Bypassers        []common.Address `json:"bypassers"`  // Bypasser of the timelock contract, usually the deployer key
 }
 
-var OpDeployTimelock = oputil.NewEVMDeployOperation(
+var OpDeployTimelock = operations.NewEVMDeployOperation(
 	"evm-timelock-deploy",
 	semver.MustParse("1.0.0"),
 	"Deploys Timelock contract on the specified EVM chains",
 	mcmscontracts.RBACTimelock,
 	bindings.RBACTimelockMetaData,
-	&oputil.ContractOpts{
+	&operations.ContractOpts{
 		Version:          &semvers.V1_0_0,
 		EVMBytecode:      common.FromHex(bindings.RBACTimelockBin),
 		ZkSyncVMBytecode: zkbindings.RBACTimelockZkBytecode,

legacy/mcms/internal/family/evm/operations/op_grant_role.go

@@ -2,22 +2,22 @@ package operations
 
 import (
 	"github.com/Masterminds/semver/v3"
-	"github.com/ethereum/go-ethereum/accounts/abi/bind/v2"
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 
 	mcmscontracts "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/contracts/mcms"
 	"github.com/smartcontractkit/mcms/sdk/evm/bindings"
 
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
+	"github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 type OpGrantRoleInput struct {
 	Account common.Address `json:"account"`
 	RoleID  [32]byte       `json:"roleID"`
 }
 
-var OpGrantRole = oputil.NewEVMCallOperation(
+var OpGrantRole = operations.NewEVMCallOperation(
 	"evm-timelock-grant-role",
 	semver.MustParse("1.0.0"),
 	"Grants specified role to the ManyChainMultiSig contract on the EVM Timelock contract",

legacy/mcms/internal/family/evm/operations/op_set_config_mcm.go

@@ -9,7 +9,7 @@ import (
 	bindings "github.com/smartcontractkit/ccip-owner-contracts/pkg/gethwrappers"
 	mcmscontracts "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/contracts/mcms"
 
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
+	"github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 type OpEVMSetConfigMCMInput struct {
@@ -19,7 +19,7 @@ type OpEVMSetConfigMCMInput struct {
 	GroupParents    [32]uint8        `json:"groupParents"`
 }
 
-var OpEVMSetConfigMCM = oputil.NewEVMCallOperation(
+var OpEVMSetConfigMCM = operations.NewEVMCallOperation(
 	"evm-mcm-set-config",
 	semver.MustParse("1.0.0"),
 	"Sets Config on the deployed MCM contract",

legacy/mcms/internal/family/evm/operations/ops_deploy_mcm.go

@@ -9,20 +9,20 @@ import (
 	zkbindings "github.com/smartcontractkit/mcms/sdk/zksync/bindings"
 
 	"github.com/smartcontractkit/cld-changesets/internal/semvers"
-	"github.com/smartcontractkit/cld-changesets/legacy/mcms/internal/family/evm/oputil"
+	"github.com/smartcontractkit/cld-changesets/mcms/evm/operations"
 )
 
 type OpEVMDeployMCMOutput struct {
 	Address common.Address `json:"address"`
 }
 
-var OpDeployProposerMCM = oputil.NewEVMDeployOperation(
+var OpDeployProposerMCM = operations.NewEVMDeployOperation(
 	"evm-proposer-mcm-deploy",
 	semver.MustParse("1.0.0"),
 	"Deploys Proposer MCM contract",
 	mcmscontracts.ProposerManyChainMultisig,
 	bindings.ManyChainMultiSigMetaData,
-	&oputil.ContractOpts{
+	&operations.ContractOpts{
 		Version:          &semvers.V1_0_0,
 		EVMBytecode:      common.FromHex(bindings.ManyChainMultiSigBin),
 		ZkSyncVMBytecode: zkbindings.ManyChainMultiSigZkBytecode,
@@ -32,13 +32,13 @@ var OpDeployProposerMCM = oputil.NewEVMDeployOperation(
 	},
 )
 
-var OpDeployBypasserMCM = oputil.NewEVMDeployOperation(
+var OpDeployBypasserMCM = operations.NewEVMDeployOperation(
 	"evm-bypasser-mcm-deploy",
 	semver.MustParse("1.0.0"),
 	"Deploys Bypasser MCM contract",
 	mcmscontracts.BypasserManyChainMultisig,
 	bindings.ManyChainMultiSigMetaData,
-	&oputil.ContractOpts{
+	&operations.ContractOpts{
 		Version:          &semvers.V1_0_0,
 		EVMBytecode:      common.FromHex(bindings.ManyChainMultiSigBin),
 		ZkSyncVMBytecode: zkbindings.ManyChainMultiSigZkBytecode,
@@ -48,13 +48,13 @@ var OpDeployBypasserMCM = oputil.NewEVMDeployOperation(
 	},
 )
 
-var OpDeployCancellerMCM = oputil.NewEVMDeployOperation(
+var OpDeployCancellerMCM = operations.NewEVMDeployOperation(
 	"evm-canceller-mcm-deploy",
 	semver.MustParse("1.0.0"),
 	"Deploys Canceller MCM contract",
 	mcmscontracts.CancellerManyChainMultisig,
 	bindings.ManyChainMultiSigMetaData,
-	&oputil.ContractOpts{
+	&operations.ContractOpts{
 		Version:          &semvers.V1_0_0,
 		EVMBytecode:      common.FromHex(bindings.ManyChainMultiSigBin),
 		ZkSyncVMBytecode: zkbindings.ManyChainMultiSigZkBytecode,