Skip to content

chore: remove deprecated common MCMSWithTimelockState #22641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graham-chainlink merged 1 commit into from
May 27, 2026
Merged

chore: remove deprecated common MCMSWithTimelockState #22641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions deployment/ccip/changeset/save_existing_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ import (
"testing"

"github.com/ethereum/go-ethereum/common"
chainsel "github.com/smartcontractkit/chain-selectors"
"github.com/stretchr/testify/require"

chainsel "github.com/smartcontractkit/chain-selectors"
evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"

cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain"
cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm"
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"

"github.com/smartcontractkit/chainlink/deployment"
changeset2 "github.com/smartcontractkit/chainlink/deployment/common/changeset"
"github.com/smartcontractkit/chainlink/deployment/common/types"
"github.com/smartcontractkit/chainlink/v2/core/logger"
)
Expand Down Expand Up @@ -138,7 +139,7 @@ func TestSaveExistingMCMSAddressWithLabels(t *testing.T) {
require.True(t, exists)
require.Len(t, addressForChain1, 1)
// load mcms state
mcmsState, err := changeset2.MaybeLoadMCMSWithTimelockChainState(dummyEnv.BlockChains.EVMChains()[chainsel.TEST_90000001.Selector], addressForChain1)
mcmsState, err := evmstate.MaybeLoadMCMSWithTimelockChainState(dummyEnv.BlockChains.EVMChains()[chainsel.TEST_90000001.Selector], addressForChain1)
require.NoError(t, err)
require.NotNil(t, mcmsState)
require.NotNil(t, mcmsState.ProposerMcm)
Expand Down
6 changes: 0 additions & 6 deletions deployment/keystone/changeset/internal/contract_set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ import (
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
)

type deployContractsRequest struct {
chain cldf_evm.Chain
isRegistryChain bool
ad cldf.AddressBook
}

// DeployCapabilitiesRegistry deploys the CapabilitiesRegistry contract to the chain
// and saves the address in the address book. This mutates the address book.
func DeployCapabilitiesRegistry(_ context.Context, chain cldf_evm.Chain, ab cldf.AddressBook) (*DeployResponse, error) {
Expand Down
5 changes: 2 additions & 3 deletions deployment/keystone/changeset/internal/state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm"
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"

commonchangeset "github.com/smartcontractkit/chainlink/deployment/common/changeset"
"github.com/smartcontractkit/chainlink/deployment/keystone/changeset/internal/addrbook"

capabilities_registry "github.com/smartcontractkit/chainlink-evm/gethwrappers/keystone/generated/capabilities_registry_1_1_0"
Expand Down Expand Up @@ -40,7 +39,7 @@ type GetContractSetsResponse struct {
//
// TODO: remove after CRE-227
type ContractSet struct {
commonchangeset.MCMSWithTimelockState
MCMSWithTimelockState
OCR3 map[common.Address]*ocr3_capability.OCR3Capability
Forwarder *forwarder.KeystoneForwarder
CapabilitiesRegistry *capabilities_registry.CapabilitiesRegistry
Expand Down Expand Up @@ -94,7 +93,7 @@ func loadContractSet(
addresses map[string]cldf.TypeAndVersion,
) (*ContractSet, error) {
var out ContractSet
mcmsWithTimelock, err := commonchangeset.MaybeLoadMCMSWithTimelockChainState(chain, addresses)
mcmsWithTimelock, err := MaybeLoadMCMSWithTimelockChainState(chain, addresses)
if err != nil {
return nil, fmt.Errorf("failed to load mcms contract: %w", err)
}
Expand Down
62 changes: 2 additions & 60 deletions deployment/common/changeset/state.go → ...keystone/changeset/internal/state_mcms.go
View file
Open in desktop
Copy link
Copy Markdown
Contributor Author

@jkongie jkongie May 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to Keystone internal since we don't want to disrupt their state output, but they ar e the last consumers of this deprecated function

Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
package changeset
package internal

import (
"fmt"

"github.com/ethereum/go-ethereum/common"

owner_helpers "github.com/smartcontractkit/ccip-owner-contracts/pkg/gethwrappers"

cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm"
Expand All @@ -12,7 +13,6 @@ import (

"github.com/smartcontractkit/chainlink/deployment"
"github.com/smartcontractkit/chainlink/deployment/common/types"
"github.com/smartcontractkit/chainlink/deployment/common/view/v1_0"
)

// MCMSWithTimelockState holds the Go bindings
Expand All @@ -25,64 +25,6 @@ type MCMSWithTimelockState struct {
*cldfproposalutils.MCMSWithTimelockContracts
}

// Deprecated: use GenerateMCMSWithTimelockView from deployment/common/changeset/state/evm.go instead
// if you are changing this, please make the similar changes in deployment/common/changeset/state
func (state MCMSWithTimelockState) GenerateMCMSWithTimelockView() (v1_0.MCMSWithTimelockView, error) {
if err := state.Validate(); err != nil {
return v1_0.MCMSWithTimelockView{}, err
}
timelockView, err := v1_0.GenerateTimelockView(*state.Timelock)
if err != nil {
return v1_0.MCMSWithTimelockView{}, nil
}
callProxyView, err := v1_0.GenerateCallProxyView(*state.CallProxy)
if err != nil {
return v1_0.MCMSWithTimelockView{}, nil
}
bypasserView, err := v1_0.GenerateMCMSView(*state.BypasserMcm)
if err != nil {
return v1_0.MCMSWithTimelockView{}, nil
}
proposerView, err := v1_0.GenerateMCMSView(*state.ProposerMcm)
if err != nil {
return v1_0.MCMSWithTimelockView{}, nil
}
cancellerView, err := v1_0.GenerateMCMSView(*state.CancellerMcm)
if err != nil {
return v1_0.MCMSWithTimelockView{}, nil
}
return v1_0.MCMSWithTimelockView{
Timelock: timelockView,
Bypasser: bypasserView,
Proposer: proposerView,
Canceller: cancellerView,
CallProxy: callProxyView,
}, nil
}

// MaybeLoadMCMSWithTimelockState loads the MCMSWithTimelockState state for each chain in the given environment.
// Deprecated: use MaybeLoadMCMSWithTimelockState from deployment/common/changeset/state/evm.go instead
// if you are changing this, please make the similar changes in deployment/common/changeset/state
func MaybeLoadMCMSWithTimelockState(env cldf.Environment, chainSelectors []uint64) (map[uint64]*MCMSWithTimelockState, error) {
result := map[uint64]*MCMSWithTimelockState{}
for _, chainSelector := range chainSelectors {
chain, ok := env.BlockChains.EVMChains()[chainSelector]
if !ok {
return nil, fmt.Errorf("chain %d not found", chainSelector)
}
addressesChain, err := env.ExistingAddresses.AddressesForChain(chainSelector)
if err != nil {
return nil, err
}
state, err := MaybeLoadMCMSWithTimelockChainState(chain, addressesChain)
if err != nil {
return nil, err
}
result[chainSelector] = state
}
return result, nil
}

// MaybeLoadMCMSWithTimelockChainState looks for the addresses corresponding to
// contracts deployed with DeployMCMSWithTimelock and loads them into a
// MCMSWithTimelockState struct. If none of the contracts are found, the state struct will be nil.
Expand Down
2 changes: 1 addition & 1 deletion deployment/common/changeset/state_test.go → ...one/changeset/internal/state_mcms_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package changeset
package internal

import (
"testing"
Expand Down
5 changes: 2 additions & 3 deletions deployment/keystone/changeset/internal/state_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import (
"github.com/stretchr/testify/require"

"github.com/smartcontractkit/chainlink/deployment"
commonchangeset "github.com/smartcontractkit/chainlink/deployment/common/changeset"
)

func Test_GetContractSet(t *testing.T) {
Expand Down Expand Up @@ -68,7 +67,7 @@ func Test_GetContractSet(t *testing.T) {
wantResp: &GetContractSetsResponse{
ContractSets: map[uint64]ContractSet{
chain.Selector: {
MCMSWithTimelockState: commonchangeset.MCMSWithTimelockState{
MCMSWithTimelockState: MCMSWithTimelockState{
MCMSWithTimelockContracts: &cldfproposalutils.MCMSWithTimelockContracts{},
},
CapabilitiesRegistry: func() *kcr.CapabilitiesRegistry {
Expand Down Expand Up @@ -116,7 +115,7 @@ func Test_GetContractSet(t *testing.T) {
wantResp: &GetContractSetsResponse{
ContractSets: map[uint64]ContractSet{
chain.Selector: {
MCMSWithTimelockState: commonchangeset.MCMSWithTimelockState{
MCMSWithTimelockState: MCMSWithTimelockState{
MCMSWithTimelockContracts: &cldfproposalutils.MCMSWithTimelockContracts{},
},
CapabilitiesRegistry: func() *kcr.CapabilitiesRegistry {
Expand Down
7 changes: 3 additions & 4 deletions deployment/keystone/changeset/state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm"
cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"

commonchangeset "github.com/smartcontractkit/chainlink/deployment/common/changeset"
"github.com/smartcontractkit/chainlink/deployment/keystone/changeset/internal"
"github.com/smartcontractkit/chainlink/deployment/keystone/changeset/internal/addrbook"

Expand All @@ -37,7 +36,7 @@ type GetContractSetsResponse struct {
}

type ContractSet struct {
commonchangeset.MCMSWithTimelockState
internal.MCMSWithTimelockState
OCR3 map[common.Address]*ocr3_capability.OCR3Capability
Forwarder *forwarder.KeystoneForwarder
CapabilitiesRegistry *capabilities_registry.CapabilitiesRegistry
Expand All @@ -46,7 +45,7 @@ type ContractSet struct {

func (cs ContractSet) Convert() internal.ContractSet {
return internal.ContractSet{
MCMSWithTimelockState: commonchangeset.MCMSWithTimelockState{
MCMSWithTimelockState: internal.MCMSWithTimelockState{
MCMSWithTimelockContracts: cs.MCMSWithTimelockContracts,
},
Forwarder: cs.Forwarder,
Expand Down Expand Up @@ -117,7 +116,7 @@ func GetContractSets(lggr logger.Logger, req *GetContractSetsRequest) (*GetContr

func loadContractSet(lggr logger.Logger, chain cldf_evm.Chain, addresses map[string]cldf.TypeAndVersion) (*ContractSet, error) {
var out ContractSet
mcmsWithTimelock, err := commonchangeset.MaybeLoadMCMSWithTimelockChainState(chain, addresses)
mcmsWithTimelock, err := internal.MaybeLoadMCMSWithTimelockChainState(chain, addresses)
if err != nil {
return nil, fmt.Errorf("failed to load mcms contract: %w", err)
}
Expand Down
10 changes: 5 additions & 5 deletions deployment/vault/changeset/validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ import (

"github.com/ethereum/go-ethereum/common"
chainSel "github.com/smartcontractkit/chain-selectors"

cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"

proposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils"
evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm"

"github.com/smartcontractkit/chainlink/deployment/common/changeset"
"github.com/smartcontractkit/chainlink/deployment/common/changeset/state"

commontypes "github.com/smartcontractkit/chainlink/deployment/common/types"

"github.com/smartcontractkit/chainlink/deployment/vault/changeset/types"
)

Expand Down Expand Up @@ -160,7 +160,7 @@ func validateMCMSConfig(e cldf.Environment, mcmsConfig *proposalutils.TimelockCo
}

chain := e.BlockChains.EVMChains()[chainSelector]
_, err = changeset.MaybeLoadMCMSWithTimelockChainState(chain, addresses)
_, err = evmstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses)
if err != nil {
return fmt.Errorf("failed to load MCMS state for chain %d: %w", chainSelector, err)
}
Expand Down Expand Up @@ -287,7 +287,7 @@ func validateDeployEthBalMonMCMSInDatastore(e cldf.Environment, chainSelector ui
}

chain := e.BlockChains.EVMChains()[chainSelector]
_, err = changeset.MaybeLoadMCMSWithTimelockChainState(chain, addresses)
_, err = evmstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses)
if err != nil {
return fmt.Errorf("failed to load MCMS with timelock state: %w", err)
}
Expand Down
Loading