Cleaning up manage whitelist (#21997)

Author: poke1994

deployment/vault/changeset/manage_whitelist.go

@@ -30,9 +30,14 @@ func (s whitelistChangeset) Apply(e cldf.Environment, cfg types.SetWhitelistConf
 	lggr := e.Logger
 
 	ds := datastore.NewMemoryDataStore()
+	// Merge only chain metadata from the environment, not the full datastore. A full Merge would
+	// copy every AddressRef from e.DataStore into the output artifact; the catalog/runtime can
+	// carry duplicate contract keys (e.g. qualifier "" vs address-type from deploy_timelock_vault
+	// or address-book migration), and passing those through would upsert unwanted rows into
+	// address_refs.json even though this changeset only updates whitelist chain metadata.
 	if e.DataStore != nil {
-		if err := ds.Merge(e.DataStore); err != nil {
-			return cldf.ChangesetOutput{}, fmt.Errorf("failed to merge existing datastore: %w", err)
+		if err := mergeChainMetadataOnly(ds, e.DataStore); err != nil {
+			return cldf.ChangesetOutput{}, fmt.Errorf("failed to merge existing chain metadata: %w", err)
 		}
 	}
 
@@ -79,6 +84,19 @@ func (s whitelistChangeset) Apply(e cldf.Environment, cfg types.SetWhitelistConf
 	}, nil
 }
 
+func mergeChainMetadataOnly(dst datastore.MutableDataStore, src datastore.DataStore) error {
+	records, err := src.ChainMetadata().Fetch()
+	if err != nil {
+		return err
+	}
+	for _, record := range records {
+		if err := dst.ChainMetadata().Upsert(record); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 func mergeWhitelistEntries(existing, incoming []types.WhitelistAddress) []types.WhitelistAddress {
 	if len(existing) == 0 && len(incoming) == 0 {
 		return nil

deployment/vault/changeset/manage_whitelist_test.go

@@ -4,6 +4,7 @@ import (
 	"slices"
 	"testing"
 
+	"github.com/Masterminds/semver/v3"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stretchr/testify/require"
 
@@ -633,3 +634,43 @@ func TestOverwriteWhitelistChangeset(t *testing.T) {
 		require.Empty(t, whitelist[selector1])
 	})
 }
+
+func TestSetWhitelistOutputOmitsEnvironmentAddressRefs(t *testing.T) {
+	t.Parallel()
+
+	selector := chainselectors.TEST_90000001.Selector
+	version := semver.MustParse("1.0.0")
+
+	ds := datastore.NewMemoryDataStore()
+	err := ds.Addresses().Add(datastore.AddressRef{
+		ChainSelector: selector,
+		Address:       "0x52b93FCA1F672800B5FdBCbDAF7c76646470C506",
+		Type:          datastore.ContractType("RBACTimeLock"),
+		Version:       version,
+		Qualifier:     "0x52b93FCA1F672800B5FdBCbDAF7c76646470C506-RBACTimeLock",
+	})
+	require.NoError(t, err)
+
+	env, err := environment.New(t.Context(),
+		environment.WithEVMSimulated(t, []uint64{selector}),
+		environment.WithDatastore(ds.Seal()),
+	)
+	require.NoError(t, err)
+
+	cfg := types.SetWhitelistConfig{
+		WhitelistByChain: map[uint64][]types.WhitelistAddress{
+			selector: {{
+				Address:     common.HexToAddress(whitelistTestAddr1).Hex(),
+				Description: "test",
+				Labels:      []string{"team"},
+			}},
+		},
+	}
+
+	out, err := SetWhitelistChangeset.Apply(*env, cfg)
+	require.NoError(t, err)
+
+	refs, err := out.DataStore.Addresses().Fetch()
+	require.NoError(t, err)
+	require.Empty(t, refs, "output must not merge address refs from environment; pipeline merge would upsert them into address_refs.json")
+}