move changeset to common

Refactor the proposal helpers a bit
smartcontractkit · Nov 27, 2024 · 5ad33a0 · 5ad33a0
1 parent 2edd809
commit 5ad33a0
Show file tree

Hide file tree

Showing 10 changed files with 395 additions and 245 deletions.
diff --git a/deployment/ccip/changeset/accept_ownership.go b/deployment/ccip/changeset/accept_ownership.go
diff --git a/deployment/ccip/changeset/accept_ownership_test.go b/deployment/ccip/changeset/accept_ownership_test.go
@@ -3,8 +3,10 @@ package changeset
 import (
 	"math/big"
 	"testing"
+	"time"
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	"github.com/ethereum/go-ethereum/common"
 	"github.com/smartcontractkit/ccip-owner-contracts/pkg/gethwrappers"
 	"github.com/smartcontractkit/chainlink-common/pkg/utils/tests"
 	"github.com/smartcontractkit/chainlink/deployment"
@@ -81,19 +83,55 @@ func Test_NewAcceptOwnershipChangeset(t *testing.T) {
 		// this has proposals, ApplyChangesets will sign & execute them.
 		// in practice, signing and executing are separated processes.
 		{
-			Changeset: commonchangeset.WrapChangeSet(NewAcceptOwnershipChangeset),
-			Config: AcceptOwnershipConfig{
-				State:             state,
-				ChainSelectors:    allChains,
-				HomeChainSelector: e.HomeChainSel,
-			},
+			Changeset: commonchangeset.WrapChangeSet(commonchangeset.NewAcceptOwnershipChangeset),
+			Config:    genTestAcceptOwnershipConfig(e, allChains, state),
 		},
 	})
 	require.NoError(t, err)
 
 	assertTimelockOwnership(t, e, allChains, state)
 }
 
+func genTestAcceptOwnershipConfig(
+	e DeployedEnv,
+	chains []uint64,
+	state CCIPOnChainState,
+) commonchangeset.AcceptOwnershipConfig {
+	var (
+		timelocksPerChain = make(map[uint64]common.Address)
+		proposerMCMses    = make(map[uint64]*gethwrappers.ManyChainMultiSig)
+		contracts         = make(map[uint64][]commonchangeset.OwnershipAcceptor)
+	)
+	for _, chain := range chains {
+		timelocksPerChain[chain] = state.Chains[chain].Timelock.Address()
+		proposerMCMses[chain] = state.Chains[chain].ProposerMcm
+		contracts[chain] = []commonchangeset.OwnershipAcceptor{
+			state.Chains[chain].OnRamp,
+			state.Chains[chain].OffRamp,
+			state.Chains[chain].FeeQuoter,
+			state.Chains[chain].NonceManager,
+			state.Chains[chain].RMNRemote,
+		}
+	}
+
+	// add home chain contracts.
+	// this overwrite should be fine.
+	timelocksPerChain[e.HomeChainSel] = state.Chains[e.HomeChainSel].Timelock.Address()
+	proposerMCMses[e.HomeChainSel] = state.Chains[e.HomeChainSel].ProposerMcm
+	contracts[e.HomeChainSel] = append(contracts[e.HomeChainSel],
+		state.Chains[e.HomeChainSel].CapabilityRegistry,
+		state.Chains[e.HomeChainSel].CCIPHome,
+		state.Chains[e.HomeChainSel].RMNHome,
+	)
+
+	return commonchangeset.AcceptOwnershipConfig{
+		TimelocksPerChain: timelocksPerChain,
+		ProposerMCMSes:    proposerMCMses,
+		Contracts:         contracts,
+		MinDelay:          time.Duration(0),
+	}
+}
+
 // assertTimelockOwnership asserts that the ownership of the contracts has been transferred
 // to the appropriate timelock contract on each chain.
 func assertTimelockOwnership(

diff --git a/deployment/ccip/changeset/active_candidate.go b/deployment/ccip/changeset/active_candidate.go
@@ -3,16 +3,20 @@ package changeset
 import (
 	"fmt"
 
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/smartcontractkit/ccip-owner-contracts/pkg/gethwrappers"
 	"github.com/smartcontractkit/ccip-owner-contracts/pkg/proposal/mcms"
 	"github.com/smartcontractkit/ccip-owner-contracts/pkg/proposal/timelock"
 
 	"github.com/smartcontractkit/chainlink/deployment"
 	"github.com/smartcontractkit/chainlink/deployment/ccip/changeset/internal"
+	"github.com/smartcontractkit/chainlink/deployment/common/proposalutils"
 	cctypes "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/types"
 )
 
 // PromoteAllCandidatesChangeset generates a proposal to call promoteCandidate on the CCIPHome through CapReg.
 // This needs to be called after SetCandidateProposal is executed.
+// TODO: make it conform to the ChangeSet interface.
 func PromoteAllCandidatesChangeset(
 	state CCIPOnChainState,
 	homeChainSel, newChainSel uint64,
@@ -28,10 +32,24 @@ func PromoteAllCandidatesChangeset(
 		return deployment.ChangesetOutput{}, err
 	}
 
-	prop, err := BuildProposalFromBatches(state, []timelock.BatchChainOperation{{
-		ChainIdentifier: mcms.ChainIdentifier(homeChainSel),
-		Batch:           promoteCandidateOps,
-	}}, "promoteCandidate for commit and execution", 0)
+	var (
+		timelocksPerChain = map[uint64]common.Address{
+			homeChainSel: state.Chains[homeChainSel].Timelock.Address(),
+		}
+		proposerMCMSes = map[uint64]*gethwrappers.ManyChainMultiSig{
+			homeChainSel: state.Chains[homeChainSel].ProposerMcm,
+		}
+	)
+	prop, err := proposalutils.BuildProposalFromBatches(
+		timelocksPerChain,
+		proposerMCMSes,
+		[]timelock.BatchChainOperation{{
+			ChainIdentifier: mcms.ChainIdentifier(homeChainSel),
+			Batch:           promoteCandidateOps,
+		}},
+		"promoteCandidate for commit and execution",
+		0, // minDelay
+	)
 	if err != nil {
 		return deployment.ChangesetOutput{}, err
 	}
@@ -43,6 +61,7 @@ func PromoteAllCandidatesChangeset(
 }
 
 // SetCandidateExecPluginProposal calls setCandidate on the CCIPHome for setting up OCR3 exec Plugin config for the new chain.
+// TODO: make it conform to the ChangeSet interface.
 func SetCandidatePluginChangeset(
 	state CCIPOnChainState,
 	e deployment.Environment,
@@ -87,10 +106,24 @@ func SetCandidatePluginChangeset(
 		return deployment.ChangesetOutput{}, err
 	}
 
-	prop, err := BuildProposalFromBatches(state, []timelock.BatchChainOperation{{
-		ChainIdentifier: mcms.ChainIdentifier(homeChainSel),
-		Batch:           setCandidateMCMSOps,
-	}}, "SetCandidate for execution", 0)
+	var (
+		timelocksPerChain = map[uint64]common.Address{
+			homeChainSel: state.Chains[homeChainSel].Timelock.Address(),
+		}
+		proposerMCMSes = map[uint64]*gethwrappers.ManyChainMultiSig{
+			homeChainSel: state.Chains[homeChainSel].ProposerMcm,
+		}
+	)
+	prop, err := proposalutils.BuildProposalFromBatches(
+		timelocksPerChain,
+		proposerMCMSes,
+		[]timelock.BatchChainOperation{{
+			ChainIdentifier: mcms.ChainIdentifier(homeChainSel),
+			Batch:           setCandidateMCMSOps,
+		}},
+		"SetCandidate for execution",
+		0, // minDelay
+	)
 	if err != nil {
 		return deployment.ChangesetOutput{}, err
 	}

diff --git a/deployment/ccip/changeset/active_candidate_test.go b/deployment/ccip/changeset/active_candidate_test.go
@@ -20,6 +20,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	commonchangeset "github.com/smartcontractkit/chainlink/deployment/common/changeset"
+	"github.com/smartcontractkit/chainlink/deployment/common/proposalutils"
 
 	"github.com/smartcontractkit/chainlink/v2/core/logger"
 )
@@ -101,12 +102,8 @@ func TestActiveCandidate(t *testing.T) {
 		// this has proposals, ApplyChangesets will sign & execute them.
 		// in practice, signing and executing are separated processes.
 		{
-			Changeset: commonchangeset.WrapChangeSet(NewAcceptOwnershipChangeset),
-			Config: AcceptOwnershipConfig{
-				State:             state,
-				ChainSelectors:    allChains,
-				HomeChainSelector: tenv.HomeChainSel,
-			},
+			Changeset: commonchangeset.WrapChangeSet(commonchangeset.NewAcceptOwnershipChangeset),
+			Config:    genTestAcceptOwnershipConfig(tenv, allChains, state),
 		},
 	})
 	require.NoError(t, err)
@@ -162,6 +159,14 @@ func TestActiveCandidate(t *testing.T) {
 	)
 	require.NoError(t, err)
 
+	var (
+		timelocksPerChain = map[uint64]common.Address{
+			tenv.HomeChainSel: state.Chains[tenv.HomeChainSel].Timelock.Address(),
+		}
+		proposerMCMSes = map[uint64]*gethwrappers.ManyChainMultiSig{
+			tenv.HomeChainSel: state.Chains[tenv.HomeChainSel].ProposerMcm,
+		}
+	)
 	setCommitCandidateOp, err := SetCandidateOnExistingDon(
 		ocr3ConfigMap[cctypes.PluginTypeCCIPCommit],
 		state.Chains[tenv.HomeChainSel].CapabilityRegistry,
@@ -170,7 +175,7 @@ func TestActiveCandidate(t *testing.T) {
 		nodes.NonBootstraps(),
 	)
 	require.NoError(t, err)
-	setCommitCandidateProposal, err := BuildProposalFromBatches(state, []timelock.BatchChainOperation{{
+	setCommitCandidateProposal, err := proposalutils.BuildProposalFromBatches(timelocksPerChain, proposerMCMSes, []timelock.BatchChainOperation{{
 		ChainIdentifier: mcms.ChainIdentifier(tenv.HomeChainSel),
 		Batch:           setCommitCandidateOp,
 	}}, "set new candidates on commit plugin", 0)
@@ -188,7 +193,7 @@ func TestActiveCandidate(t *testing.T) {
 	)
 	require.NoError(t, err)
 
-	setExecCandidateProposal, err := BuildProposalFromBatches(state, []timelock.BatchChainOperation{{
+	setExecCandidateProposal, err := proposalutils.BuildProposalFromBatches(timelocksPerChain, proposerMCMSes, []timelock.BatchChainOperation{{
 		ChainIdentifier: mcms.ChainIdentifier(tenv.HomeChainSel),
 		Batch:           setExecCandidateOp,
 	}}, "set new candidates on commit and exec plugins", 0)
@@ -215,7 +220,7 @@ func TestActiveCandidate(t *testing.T) {
 
 	promoteOps, err := PromoteAllCandidatesForChainOps(state.Chains[tenv.HomeChainSel].CapabilityRegistry, state.Chains[tenv.HomeChainSel].CCIPHome, tenv.FeedChainSel, nodes.NonBootstraps())
 	require.NoError(t, err)
-	promoteProposal, err := BuildProposalFromBatches(state, []timelock.BatchChainOperation{{
+	promoteProposal, err := proposalutils.BuildProposalFromBatches(timelocksPerChain, proposerMCMSes, []timelock.BatchChainOperation{{
 		ChainIdentifier: mcms.ChainIdentifier(tenv.HomeChainSel),
 		Batch:           promoteOps,
 	}}, "promote candidates and revoke actives", 0)