@agoric/cosmos 0.34.2-upgrade-18-dev-6ddbef0.0 → 0.34.2-upgrade-19-dev-2a71f04.0

package/x/swingset/types/params.go

@@ -17,6 +17,7 @@ var (
 	ParamStoreKeyFeeUnitPrice       = []byte("fee_unit_price")
 	ParamStoreKeyPowerFlagFees      = []byte("power_flag_fees")
 	ParamStoreKeyQueueMax           = []byte("queue_max")
+	ParamStoreKeyVatCleanupBudget   = []byte("vat_cleanup_budget")
 )
 
 func NewStringBeans(key string, beans sdkmath.Uint) StringBeans {
@@ -53,6 +54,7 @@ func DefaultParams() Params {
 		FeeUnitPrice:       DefaultFeeUnitPrice,
 		PowerFlagFees:      DefaultPowerFlagFees,
 		QueueMax:           DefaultQueueMax,
+		VatCleanupBudget:   DefaultVatCleanupBudget,
 	}
 }
 
@@ -69,6 +71,7 @@ func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs {
 		paramtypes.NewParamSetPair(ParamStoreKeyBootstrapVatConfig, &p.BootstrapVatConfig, validateBootstrapVatConfig),
 		paramtypes.NewParamSetPair(ParamStoreKeyPowerFlagFees, &p.PowerFlagFees, validatePowerFlagFees),
 		paramtypes.NewParamSetPair(ParamStoreKeyQueueMax, &p.QueueMax, validateQueueMax),
+		paramtypes.NewParamSetPair(ParamStoreKeyVatCleanupBudget, &p.VatCleanupBudget, validateVatCleanupBudget),
 	}
 }
 
@@ -89,6 +92,9 @@ func (p Params) ValidateBasic() error {
 	if err := validateQueueMax(p.QueueMax); err != nil {
 		return err
 	}
+	if err := validateVatCleanupBudget(p.VatCleanupBudget); err != nil {
+		return err
+	}
 
 	return nil
 }
@@ -165,20 +171,42 @@ func validateQueueMax(i interface{}) error {
 	return nil
 }
 
+func validateVatCleanupBudget(i interface{}) error {
+	entries, ok := i.([]UintMapEntry)
+	if !ok {
+		return fmt.Errorf("invalid parameter type: %T", i)
+	}
+	hasDefault := false
+	for _, entry := range entries {
+		if entry.Key == VatCleanupDefault {
+			hasDefault = true
+			break
+		}
+	}
+	if len(entries) > 0 && !hasDefault {
+		return fmt.Errorf("`default` must be present in a non-empty vat cleanup budget")
+	}
+	return nil
+}
+
 // UpdateParams appends any missing params, configuring them to their defaults,
 // then returning the updated params or an error. Existing params are not
 // modified, regardless of their value, and they are not removed if they no
 // longer appear in the defaults.
 func UpdateParams(params Params) (Params, error) {
-	newBpu, err := appendMissingDefaultBeansPerUnit(params.BeansPerUnit, DefaultBeansPerUnit())
+	newBpu, err := appendMissingDefaults(params.BeansPerUnit, DefaultBeansPerUnit())
 	if err != nil {
 		return params, err
 	}
-	newPff, err := appendMissingDefaultPowerFlagFees(params.PowerFlagFees, DefaultPowerFlagFees)
+	newPff, err := appendMissingDefaults(params.PowerFlagFees, DefaultPowerFlagFees)
 	if err != nil {
 		return params, err
 	}
-	newQm, err := appendMissingDefaultQueueSize(params.QueueMax, DefaultQueueMax)
+	newQm, err := appendMissingDefaults(params.QueueMax, DefaultQueueMax)
+	if err != nil {
+		return params, err
+	}
+	newVcb, err := appendMissingDefaults(params.VatCleanupBudget, DefaultVatCleanupBudget)
 	if err != nil {
 		return params, err
 	}
@@ -186,55 +214,37 @@ func UpdateParams(params Params) (Params, error) {
 	params.BeansPerUnit = newBpu
 	params.PowerFlagFees = newPff
 	params.QueueMax = newQm
+	params.VatCleanupBudget = newVcb
 	return params, nil
 }
 
-// appendMissingDefaultBeansPerUnit appends the default beans per unit entries
-// not in the list of bean costs already, returning the possibly-updated list,
-// or an error.
-func appendMissingDefaultBeansPerUnit(bpu []StringBeans, defaultBpu []StringBeans) ([]StringBeans, error) {
-	existingBpu := make(map[string]struct{}, len(bpu))
-	for _, ob := range bpu {
-		existingBpu[ob.Key] = struct{}{}
-	}
-
-	for _, b := range defaultBpu {
-		if _, exists := existingBpu[b.Key]; !exists {
-			bpu = append(bpu, b)
+// appendMissingDefaults appends to an input list any missing entries with their
+// respective default values and returns the result.
+func appendMissingDefaults[Entry StringBeans | PowerFlagFee | QueueSize | UintMapEntry](entries []Entry, defaults []Entry) ([]Entry, error) {
+	getKey := func(entry any) string {
+		switch e := entry.(type) {
+		case StringBeans:
+			return e.Key
+		case PowerFlagFee:
+			return e.PowerFlag
+		case QueueSize:
+			return e.Key
+		case UintMapEntry:
+			return e.Key
 		}
+		panic("unreachable")
 	}
-	return bpu, nil
-}
 
-// appendMissingDefaultPowerFlagFees appends the default power flag fee entries
-// not in the list of power flags already, returning the possibly-updated list,
-// or an error.
-func appendMissingDefaultPowerFlagFees(pff []PowerFlagFee, defaultPff []PowerFlagFee) ([]PowerFlagFee, error) {
-	existingPff := make(map[string]struct{}, len(pff))
-	for _, of := range pff {
-		existingPff[of.PowerFlag] = struct{}{}
+	existingKeys := make(map[string]bool, len(entries))
+	for _, entry := range entries {
+		existingKeys[getKey(entry)] = true
 	}
 
-	for _, f := range defaultPff {
-		if _, exists := existingPff[f.PowerFlag]; !exists {
-			pff = append(pff, f)
+	for _, defaultEntry := range defaults {
+		if exists := existingKeys[getKey(defaultEntry)]; !exists {
+			entries = append(entries, defaultEntry)
 		}
 	}
-	return pff, nil
-}
-
-// appendMissingDefaultQueueSize appends the default queue size entries not in
-// the list of sizes already, returning the possibly-updated list, or an error.
-func appendMissingDefaultQueueSize(qs []QueueSize, defaultQs []QueueSize) ([]QueueSize, error) {
-	existingQs := make(map[string]struct{}, len(qs))
-	for _, os := range qs {
-		existingQs[os.Key] = struct{}{}
-	}
 
-	for _, s := range defaultQs {
-		if _, exists := existingQs[s.Key]; !exists {
-			qs = append(qs, s)
-		}
-	}
-	return qs, nil
+	return entries, nil
 }

package/x/swingset/types/params_test.go

@@ -80,7 +80,7 @@ func TestAddStorageBeanCost(t *testing.T) {
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := appendMissingDefaultBeansPerUnit(tt.in, []StringBeans{defaultStorageCost})
+			got, err := appendMissingDefaults(tt.in, []StringBeans{defaultStorageCost})
 			if err != nil {
 				t.Errorf("got error %v", err)
 			} else if !reflect.DeepEqual(got, tt.want) {
@@ -90,27 +90,93 @@ func TestAddStorageBeanCost(t *testing.T) {
 	}
 }
 
-func TestUpdateParams(t *testing.T) {
-
+func TestUpdateParamsFromEmpty(t *testing.T) {
 	in := Params{
-		BeansPerUnit:       []beans{},
-		BootstrapVatConfig: "baz",
+		BeansPerUnit:       nil,
+		BootstrapVatConfig: "",
 		FeeUnitPrice:       sdk.NewCoins(sdk.NewInt64Coin("denom", 789)),
-		PowerFlagFees:      []PowerFlagFee{},
-		QueueMax:           []QueueSize{},
+		PowerFlagFees:      nil,
+		QueueMax:           nil,
+		VatCleanupBudget:   nil,
 	}
 	want := Params{
 		BeansPerUnit:       DefaultBeansPerUnit(),
-		BootstrapVatConfig: "baz",
+		BootstrapVatConfig: "",
 		FeeUnitPrice:       sdk.NewCoins(sdk.NewInt64Coin("denom", 789)),
 		PowerFlagFees:      DefaultPowerFlagFees,
 		QueueMax:           DefaultQueueMax,
+		VatCleanupBudget:   DefaultVatCleanupBudget,
+	}
+	got, err := UpdateParams(in)
+	if err != nil {
+		t.Fatalf("UpdateParam error %v", err)
+	}
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("GOT\n%v\nWANTED\n%v", got, want)
+	}
+}
+
+func TestUpdateParamsFromExisting(t *testing.T) {
+	defaultBeansPerUnit := DefaultBeansPerUnit()
+	customBeansPerUnit := NewStringBeans("foo", sdk.NewUint(1))
+	customPowerFlagFee := NewPowerFlagFee("bar", sdk.NewCoins(sdk.NewInt64Coin("baz", 2)))
+	customQueueSize := NewQueueSize("qux", int32(3))
+	customVatCleanup := UintMapEntry{"corge", sdk.NewUint(4)}
+	in := Params{
+		BeansPerUnit:       append([]StringBeans{customBeansPerUnit}, defaultBeansPerUnit[2:4]...),
+		BootstrapVatConfig: "",
+		FeeUnitPrice:       sdk.NewCoins(sdk.NewInt64Coin("denom", 789)),
+		PowerFlagFees:      []PowerFlagFee{customPowerFlagFee},
+		QueueMax:           []QueueSize{NewQueueSize(QueueInbound, int32(10)), customQueueSize},
+		VatCleanupBudget:   []UintMapEntry{customVatCleanup, UintMapEntry{VatCleanupDefault, sdk.NewUint(10)}},
+	}
+	want := Params{
+		BeansPerUnit:       append(append(in.BeansPerUnit, defaultBeansPerUnit[0:2]...), defaultBeansPerUnit[4:]...),
+		BootstrapVatConfig: in.BootstrapVatConfig,
+		FeeUnitPrice:       in.FeeUnitPrice,
+		PowerFlagFees:      append(in.PowerFlagFees, DefaultPowerFlagFees...),
+		QueueMax:           in.QueueMax,
+		VatCleanupBudget:   append(in.VatCleanupBudget, DefaultVatCleanupBudget[1:]...),
 	}
 	got, err := UpdateParams(in)
 	if err != nil {
 		t.Fatalf("UpdateParam error %v", err)
 	}
 	if !reflect.DeepEqual(got, want) {
-		t.Errorf("got %v, want %v", got, want)
+		t.Errorf("GOT\n%v\nWANTED\n%v", got, want)
+	}
+}
+
+func TestValidateParams(t *testing.T) {
+	params := Params{
+		BeansPerUnit:       DefaultBeansPerUnit(),
+		BootstrapVatConfig: "foo",
+		FeeUnitPrice:       sdk.NewCoins(sdk.NewInt64Coin("denom", 789)),
+		PowerFlagFees:      DefaultPowerFlagFees,
+		QueueMax:           DefaultQueueMax,
+		VatCleanupBudget:   DefaultVatCleanupBudget,
+	}
+	err := params.ValidateBasic()
+	if err != nil {
+		t.Errorf("unexpected ValidateBasic() error with default params: %v", err)
+	}
+
+	customVatCleanup := UintMapEntry{"corge", sdk.NewUint(4)}
+	params.VatCleanupBudget = append(params.VatCleanupBudget, customVatCleanup)
+	err = params.ValidateBasic()
+	if err != nil {
+		t.Errorf("unexpected ValidateBasic() error with extended params: %v", err)
+	}
+
+	params.VatCleanupBudget = params.VatCleanupBudget[1:]
+	err = params.ValidateBasic()
+	if err == nil {
+		t.Errorf("ValidateBasic() failed to reject VatCleanupBudget with missing `default` %v", params.VatCleanupBudget)
+	}
+
+	params.VatCleanupBudget = []UintMapEntry{}
+	err = params.ValidateBasic()
+	if err != nil {
+		t.Errorf("unexpected ValidateBasic() error with empty VatCleanupBudget: %v", params.VatCleanupBudget)
 	}
 }