@agoric/cosmos 0.35.0-u18.4 → 0.35.0-u18.5

package/x/swingset/types/default-params.go

@@ -22,13 +22,23 @@ const (
 	BeansPerXsnapComputron       = "xsnapComputron"
 	BeansPerSmartWalletProvision = "smartWalletProvision"
 
+	// PowerFlags.
+	PowerFlagSmartWallet = "SMART_WALLET"
+
 	// QueueSize keys.
-	// Keep up-to-date with updateQueueAllowed() in packanges/cosmic-swingset/src/launch-chain.js
+	// Keep up-to-date with updateQueueAllowed() in packages/cosmic-swingset/src/launch-chain.js
 	QueueInbound        = "inbound"
 	QueueInboundMempool = "inbound_mempool"
 
-	// PowerFlags.
-	PowerFlagSmartWallet = "SMART_WALLET"
+	// Vat cleanup budget keys.
+	// Keep up-to-date with CleanupBudget in packages/cosmic-swingset/src/launch-chain.js
+	VatCleanupDefault     = "default"
+	VatCleanupExports     = "exports"
+	VatCleanupImports     = "imports"
+	VatCleanupPromises    = "promises"
+	VatCleanupKv          = "kv"
+	VatCleanupSnapshots   = "snapshots"
+	VatCleanupTranscripts = "transcripts"
 )
 
 var (
@@ -62,10 +72,26 @@ var (
 	}
 
 	DefaultInboundQueueMax = int32(1_000)
-
-	DefaultQueueMax = []QueueSize{
+	DefaultQueueMax        = []QueueSize{
 		NewQueueSize(QueueInbound, DefaultInboundQueueMax),
 	}
+
+	DefaultVatCleanupDefault = sdk.NewUint(5)
+	// DefaultVatCleanupExports     = DefaultVatCleanupDefault
+	// DefaultVatCleanupImports     = DefaultVatCleanupDefault
+	// DefaultVatCleanupPromises    = DefaultVatCleanupDefault
+	DefaultVatCleanupKv = sdk.NewUint(50)
+	// DefaultVatCleanupSnapshots   = DefaultVatCleanupDefault
+	// DefaultVatCleanupTranscripts = DefaultVatCleanupDefault
+	DefaultVatCleanupBudget = []UintMapEntry{
+		UintMapEntry{VatCleanupDefault, DefaultVatCleanupDefault},
+		// UintMapEntry{VatCleanupExports, DefaultVatCleanupExports},
+		// UintMapEntry{VatCleanupImports, DefaultVatCleanupImports},
+		// UintMapEntry{VatCleanupPromises, DefaultVatCleanupPromises},
+		UintMapEntry{VatCleanupKv, DefaultVatCleanupKv},
+		// UintMapEntry{VatCleanupSnapshots, DefaultVatCleanupSnapshots},
+		// UintMapEntry{VatCleanupTranscripts, DefaultVatCleanupTranscripts},
+	}
 )
 
 // move DefaultBeansPerUnit to a function to allow for boot overriding of the Default params

package/x/swingset/types/expected_keepers.go

@@ -23,8 +23,8 @@ type AccountKeeper interface {
 
 type SwingSetKeeper interface {
 	GetBeansPerUnit(ctx sdk.Context) map[string]sdkmath.Uint
-	ChargeBeans(ctx sdk.Context, addr sdk.AccAddress, beans sdkmath.Uint) error
+	ChargeBeans(ctx sdk.Context, beansPerUnit map[string]sdkmath.Uint, addr sdk.AccAddress, beans sdkmath.Uint) error
 	IsHighPriorityAddress(ctx sdk.Context, addr sdk.AccAddress) (bool, error)
 	GetSmartWalletState(ctx sdk.Context, addr sdk.AccAddress) SmartWalletState
-	ChargeForSmartWallet(ctx sdk.Context, addr sdk.AccAddress) error
+	ChargeForSmartWallet(ctx sdk.Context, beansPerUnit map[string]sdkmath.Uint, addr sdk.AccAddress) error
 }

package/x/swingset/types/msgs.go

@@ -8,9 +8,12 @@ import (
 	"strings"
 
 	sdkioerrors "cosmossdk.io/errors"
-	"github.com/Agoric/agoric-sdk/golang/cosmos/vm"
+	sdkmath "cosmossdk.io/math"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+
+	"github.com/Agoric/agoric-sdk/golang/cosmos/vm"
 )
 
 const RouterKey = ModuleName // this was defined in your key.go file
@@ -56,16 +59,26 @@ const (
 
 // Charge an account address for the beans associated with given messages and storage.
 // See list of bean charges in default-params.go
-func chargeAdmission(ctx sdk.Context, keeper SwingSetKeeper, addr sdk.AccAddress, msgs []string, storageLen uint64) error {
-	beansPerUnit := keeper.GetBeansPerUnit(ctx)
+func chargeAdmission(
+	ctx sdk.Context,
+	keeper SwingSetKeeper,
+	beansPerUnit map[string]sdkmath.Uint,
+	addr sdk.AccAddress,
+	msgs []string,
+	storageLen uint64,
+) error {
+	// A flat charge for each transaction.
 	beans := beansPerUnit[BeansPerInboundTx]
+	// A charge for each message in the transaction.
 	beans = beans.Add(beansPerUnit[BeansPerMessage].MulUint64((uint64(len(msgs)))))
+	// A charge for the total byte length of all messages.
 	for _, msg := range msgs {
 		beans = beans.Add(beansPerUnit[BeansPerMessageByte].MulUint64(uint64(len(msg))))
 	}
+	// A charge for persistent storage.
 	beans = beans.Add(beansPerUnit[BeansPerStorageByte].MulUint64(storageLen))
 
-	return keeper.ChargeBeans(ctx, addr, beans)
+	return keeper.ChargeBeans(ctx, beansPerUnit, addr, beans)
 }
 
 // checkSmartWalletProvisioned verifies if a smart wallet message (MsgWalletAction
@@ -74,7 +87,12 @@ func chargeAdmission(ctx sdk.Context, keeper SwingSetKeeper, addr sdk.AccAddress
 // provisioning fee is charged successfully.
 // All messages for non-provisioned smart wallets allowed here will result in
 // an auto-provision action generated by the msg server.
-func checkSmartWalletProvisioned(ctx sdk.Context, keeper SwingSetKeeper, addr sdk.AccAddress) error {
+func checkSmartWalletProvisioned(
+	ctx sdk.Context,
+	keeper SwingSetKeeper,
+	beansPerUnit map[string]sdkmath.Uint,
+	addr sdk.AccAddress,
+) error {
 	walletState := keeper.GetSmartWalletState(ctx, addr)
 
 	switch walletState {
@@ -91,7 +109,7 @@ func checkSmartWalletProvisioned(ctx sdk.Context, keeper SwingSetKeeper, addr sd
 		// This is a separate charge from the smart wallet action which triggered the check
 		// TODO: Currently this call does not mark the smart wallet provisioning as
 		// pending, resulting in multiple provisioning charges for the owner.
-		return keeper.ChargeForSmartWallet(ctx, addr)
+		return keeper.ChargeForSmartWallet(ctx, beansPerUnit, addr)
 	}
 }
 
@@ -118,7 +136,8 @@ func (msg MsgDeliverInbound) CheckAdmissibility(ctx sdk.Context, data interface{
 		}
 	*/
 
-	return chargeAdmission(ctx, keeper, msg.Submitter, msg.Messages, 0)
+	beansPerUnit := keeper.GetBeansPerUnit(ctx)
+	return chargeAdmission(ctx, keeper, beansPerUnit, msg.Submitter, msg.Messages, 0)
 }
 
 // GetInboundMsgCount implements InboundMsgCarrier.
@@ -184,12 +203,13 @@ func (msg MsgWalletAction) CheckAdmissibility(ctx sdk.Context, data interface{})
 		return sdkioerrors.Wrapf(sdkerrors.ErrInvalidRequest, "data must be a SwingSetKeeper, not a %T", data)
 	}
 
-	err := checkSmartWalletProvisioned(ctx, keeper, msg.Owner)
+	beansPerUnit := keeper.GetBeansPerUnit(ctx)
+	err := checkSmartWalletProvisioned(ctx, keeper, beansPerUnit, msg.Owner)
 	if err != nil {
 		return err
 	}
 
-	return chargeAdmission(ctx, keeper, msg.Owner, []string{msg.Action}, 0)
+	return chargeAdmission(ctx, keeper, beansPerUnit, msg.Owner, []string{msg.Action}, 0)
 }
 
 // GetInboundMsgCount implements InboundMsgCarrier.
@@ -256,12 +276,13 @@ func (msg MsgWalletSpendAction) CheckAdmissibility(ctx sdk.Context, data interfa
 		return sdkioerrors.Wrapf(sdkerrors.ErrInvalidRequest, "data must be a SwingSetKeeper, not a %T", data)
 	}
 
-	err := checkSmartWalletProvisioned(ctx, keeper, msg.Owner)
+	beansPerUnit := keeper.GetBeansPerUnit(ctx)
+	err := checkSmartWalletProvisioned(ctx, keeper, beansPerUnit, msg.Owner)
 	if err != nil {
 		return err
 	}
 
-	return chargeAdmission(ctx, keeper, msg.Owner, []string{msg.SpendAction}, 0)
+	return chargeAdmission(ctx, keeper, beansPerUnit, msg.Owner, []string{msg.SpendAction}, 0)
 }
 
 // GetInboundMsgCount implements InboundMsgCarrier.
@@ -373,7 +394,8 @@ func (msg MsgInstallBundle) CheckAdmissibility(ctx sdk.Context, data interface{}
 	if !ok {
 		return sdkioerrors.Wrapf(sdkerrors.ErrInvalidRequest, "data must be a SwingSetKeeper, not a %T", data)
 	}
-	return chargeAdmission(ctx, keeper, msg.Submitter, []string{msg.Bundle}, msg.ExpectedUncompressedSize())
+	beansPerUnit := keeper.GetBeansPerUnit(ctx)
+	return chargeAdmission(ctx, keeper, beansPerUnit, msg.Submitter, []string{msg.Bundle}, msg.ExpectedUncompressedSize())
 }
 
 // GetInboundMsgCount implements InboundMsgCarrier.

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)
 	}
 }