fix: use new gas boost types and use familyregistry

Author: ecPablo

mcms/changesets/deploy-custom-topology/changeset.go

@@ -43,7 +43,7 @@ func (Changeset) Apply(e cldf.Environment, input Input) (cldf.ChangesetOutput, e
 	var agg sequenceutils.OnChainOutput
 
 	for _, chainSelector := range maputil.SortedMapKeys(input.Cfg.ChainConfigs) {
-		seq, seqErr := Sequences.SequenceForChainSelector(chainSelector)
+		seq, seqErr := Registry.SequenceForChainSelector(chainSelector)
 		if seqErr != nil {
 			return buildOutput(e, input.Cfg, input.MCMS, agg, fmt.Errorf("chain selector %d: %w", chainSelector, seqErr))
 		}
@@ -159,7 +159,7 @@ func validateConfig(e cldf.Environment, cfg Config, mcms *cldf.MCMSTimelockPropo
 	slices.Sort(families)
 
 	for _, family := range families {
-		if err := Sequences.VerifyForFamily(family, e, byFamily[family]); err != nil {
+		if err := Registry.VerifyForFamily(family, e, byFamily[family]); err != nil {
 			return err
 		}
 	}

mcms/changesets/deploy-custom-topology/changeset_test.go

@@ -61,7 +61,7 @@ var fakeEVMTopologySeq = operations.NewSequence(
 )
 
 func init() {
-	Sequences.Register(Registration{Family: chain_selectors.FamilyEVM, Sequence: fakeEVMTopologySeq})
+	Registry.Register(Registration{Family: chain_selectors.FamilyEVM, Sequence: fakeEVMTopologySeq})
 }
 
 func testEnv(t *testing.T) cldf.Environment {

mcms/changesets/deploy-custom-topology/doc.go

@@ -42,14 +42,18 @@
 // Implement a family under mcms/<family>/deploy-custom-topology and register it at
 // process startup. Follow this layout:
 //
-//   - register.go — exports Registration() and calls [Register] in init()
+//   - register.go — exports Registration() and calls [Registry.Register] in init()
 //   - sequence.go — operations.Sequence that deploys the topology for one chain
 //   - addresses.go — datastore ref resolution / AddressRef construction
 //   - extra_args.go — optional, parses family-specific [ChainTopologyConfig.ExtraArgs]
 //
 // The sequence must match [Sequence]: it receives [ChainInput] and [Deps] and returns
 // [sequenceutils.OnChainOutput].
 //
+// Register at startup from init (recommended, mirrors EVM and Solana):
+//
+//	func init() { deploycustomtopology.Registry.Register(Registration()) }
+//
 // Each family may only be registered once; duplicate registration panics. Use
-// [Sequences.RegisteredFamilies] to inspect the registry in tests.
+// [Registry.RegisteredFamilies] to inspect the registry in tests.
 package deploycustomtopology

mcms/changesets/deploy-custom-topology/registry.go

@@ -1,11 +1,11 @@
 package deploycustomtopology
 
 import (
-	"github.com/smartcontractkit/cld-changesets/mcms/changesets/familyregistry"
+	"github.com/smartcontractkit/cld-changesets/internal/familyregistry"
 )
 
-// Sequences is the deploy-custom-topology family sequence registry.
-var Sequences = familyregistry.New[Sequence, ChainInput](familyregistry.Options{
-	Name:               "deploy-custom-topology",
-	NoneRegisteredHint: "blank-import mcms/<family>/deploy-custom-topology or mcms/changesets/deploy-custom-topology/all",
-})
+// Registration describes one chain family's deploy-custom-topology implementation.
+type Registration = familyregistry.Registration[Sequence, ChainInput]
+
+// Registry holds per-family deploy-custom-topology sequences.
+var Registry = familyregistry.New[Sequence, ChainInput]("mcms deploy-custom-topology")

mcms/changesets/deploy-custom-topology/registry_test.go

@@ -11,6 +11,8 @@ import (
 	"github.com/smartcontractkit/chainlink-deployments-framework/changeset/sequenceutils"
 	cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
 	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
+
+	"github.com/smartcontractkit/cld-changesets/internal/familyregistry"
 )
 
 func testSequence(id string) *Sequence {
@@ -24,19 +26,39 @@ func testSequence(id string) *Sequence {
 	)
 }
 
+func newTestRegistry() *familyregistry.Registry[Sequence, ChainInput] {
+	return familyregistry.New[Sequence, ChainInput]("test deploy-custom-topology")
+}
+
 func TestSequenceForChainSelector(t *testing.T) {
 	t.Parallel()
 
-	_, err := Sequences.SequenceForChainSelector(0)
-	require.Error(t, err)
+	reg := newTestRegistry()
+
+	tests := []struct {
+		name          string
+		chainSelector uint64
+	}{
+		{name: "invalid selector", chainSelector: 0},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			_, err := reg.SequenceForChainSelector(tt.chainSelector)
+			require.Error(t, err)
+		})
+	}
 }
 
 func TestRegister_andLookup(t *testing.T) {
 	t.Parallel()
 
-	const family = "test-topology-family-a"
+	reg := newTestRegistry()
+	const family = "test-deploy-custom-topology-family-a"
 
-	Sequences.Register(Registration{
+	reg.Register(Registration{
 		Family:   family,
 		Sequence: testSequence("test-topology-seq-a"),
 		Verify: func(_ cldf.Environment, chains []ChainInput) error {
@@ -48,9 +70,9 @@ func TestRegister_andLookup(t *testing.T) {
 		},
 	})
 
-	require.Contains(t, Sequences.RegisteredFamilies(), family)
+	require.Contains(t, reg.RegisteredFamilies(), family)
 
-	seq, err := Sequences.SequenceForFamily(family)
+	seq, err := reg.SequenceForFamily(family)
 	require.NoError(t, err)
 	require.NotNil(t, seq)
 
@@ -67,7 +89,7 @@ func TestRegister_andLookup(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			t.Parallel()
 
-			err := Sequences.VerifyForFamily(family, cldf.Environment{}, tt.chains)
+			err := reg.VerifyForFamily(family, cldf.Environment{}, tt.chains)
 			if tt.wantErr {
 				require.Error(t, err)
 				return
@@ -81,49 +103,68 @@ func TestRegister_andLookup(t *testing.T) {
 func TestRegister_validationPanics(t *testing.T) {
 	t.Parallel()
 
+	reg := newTestRegistry()
+
 	tests := []struct {
 		name string
 		reg  Registration
 	}{
 		{name: "empty family", reg: Registration{Family: "", Sequence: testSequence("empty-family")}},
-		{name: "nil sequence", reg: Registration{Family: "test-topology-family-b", Sequence: nil}},
+		{name: "nil sequence", reg: Registration{Family: "test-deploy-custom-topology-family-b", Sequence: nil}},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			t.Parallel()
-			require.Panics(t, func() { Sequences.Register(tt.reg) })
+			require.Panics(t, func() { reg.Register(tt.reg) })
 		})
 	}
 }
 
 func TestRegister_duplicatePanics(t *testing.T) {
 	t.Parallel()
 
-	const family = "test-topology-family-c"
-	Sequences.Register(Registration{Family: family, Sequence: testSequence("test-topology-seq-c")})
+	reg := newTestRegistry()
+	const family = "test-deploy-custom-topology-family-c"
+	reg.Register(Registration{Family: family, Sequence: testSequence("test-topology-seq-c")})
 
 	require.Panics(t, func() {
-		Sequences.Register(Registration{Family: family, Sequence: testSequence("test-topology-seq-c-dup")})
+		reg.Register(Registration{Family: family, Sequence: testSequence("test-topology-seq-c-dup")})
 	})
 }
 
 func TestSequenceForFamily_errors(t *testing.T) {
 	t.Parallel()
 
-	const family = "test-topology-family-missing"
-	_, err := Sequences.SequenceForFamily(family)
-	require.ErrorContains(t, err, fmt.Sprintf(`no sequence registered for family %q`, family))
+	reg := newTestRegistry()
+
+	tests := []struct {
+		name   string
+		family string
+	}{
+		{name: "missing family", family: "test-deploy-custom-topology-family-missing"},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			_, err := reg.SequenceForFamily(tt.family)
+			require.ErrorContains(t, err, fmt.Sprintf(`no sequence registered for family %q`, tt.family))
+		})
+	}
 }
 
 func TestVerifyForFamily(t *testing.T) {
 	t.Parallel()
 
-	const nilHookFamily = "test-topology-family-d"
-	Sequences.Register(Registration{Family: nilHookFamily, Sequence: testSequence("test-topology-seq-d")})
+	reg := newTestRegistry()
+
+	const nilHookFamily = "test-deploy-custom-topology-family-d"
+	reg.Register(Registration{Family: nilHookFamily, Sequence: testSequence("test-topology-seq-d")})
 
-	const wrapFamily = "test-topology-family-e"
-	Sequences.Register(Registration{
+	const wrapFamily = "test-deploy-custom-topology-family-e"
+	reg.Register(Registration{
 		Family:   wrapFamily,
 		Sequence: testSequence("test-topology-seq-e"),
 		Verify: func(_ cldf.Environment, _ []ChainInput) error {
@@ -137,7 +178,7 @@ func TestVerifyForFamily(t *testing.T) {
 		chains  []ChainInput
 		wantErr string
 	}{
-		{name: "missing family", family: "test-topology-family-missing-verify", wantErr: "no sequence registered for family"},
+		{name: "missing family", family: "test-deploy-custom-topology-family-missing-verify", wantErr: "no sequence registered for family"},
 		{name: "nil verify hook", family: nilHookFamily},
 		{name: "wrapped verify error", family: wrapFamily, chains: []ChainInput{{ChainSelector: 1}}, wantErr: "boom"},
 	}
@@ -146,7 +187,7 @@ func TestVerifyForFamily(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			t.Parallel()
 
-			err := Sequences.VerifyForFamily(tt.family, cldf.Environment{}, tt.chains)
+			err := reg.VerifyForFamily(tt.family, cldf.Environment{}, tt.chains)
 			if tt.wantErr == "" {
 				require.NoError(t, err)
 				return

mcms/changesets/deploy-custom-topology/types.go

@@ -6,14 +6,12 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 
 	"github.com/smartcontractkit/chainlink-deployments-framework/chain"
+	opscontract "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm/operations2/contract"
 	"github.com/smartcontractkit/chainlink-deployments-framework/changeset/sequenceutils"
 	cldfdatastore "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
 	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"
 	mcmstypes "github.com/smartcontractkit/mcms/types"
-
-	"github.com/smartcontractkit/cld-changesets/mcms/changesets/familyregistry"
 )
 
 // Config is the changeset payload: the custom MCMS topology to deploy per chain.
@@ -31,9 +29,9 @@ type MCMSTopologyConfig struct {
 
 // ChainTopologyConfig describes the MCMS topology to deploy on a single chain.
 type ChainTopologyConfig struct {
-	MCMs           []MCMSpec                         `json:"mcms"`
-	Timelocks      []TimelockSpec                    `json:"timelocks"`
-	GasBoostConfig *cldfproposalutils.GasBoostConfig `json:"gasBoostConfig,omitempty"`
+	MCMs           []MCMSpec                   `json:"mcms"`
+	Timelocks      []TimelockSpec              `json:"timelocks"`
+	GasBoostConfig *opscontract.GasBoostConfig `json:"gasBoostConfig,omitempty"`
 
 	// ExtraArgs carries chain-family-specific input that the default per-chain
 	// parameters above cannot express. It is forwarded verbatim to the family
@@ -119,9 +117,6 @@ type Deps struct {
 // Sequence is the required operations sequence type for all family implementations.
 type Sequence = operations.Sequence[ChainInput, sequenceutils.OnChainOutput, Deps]
 
-// Registration describes one chain family's deploy-custom-topology implementation.
-type Registration = familyregistry.Registration[Sequence, ChainInput]
-
 // EnvFromDeps reconstructs the environment fields sequences need for ref and
 // MCMS resolution.
 func EnvFromDeps(deps Deps) cldf.Environment {