feat(beans): use sdk.Uint whole beans to prevent negatives

Agoric · Nov 3, 2021 · 46f7fdc · 46f7fdc
1 parent f7e0710
commit 46f7fdc
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 53 deletions.
diff --git a/golang/cosmos/proto/agoric/swingset/swingset.proto b/golang/cosmos/proto/agoric/swingset/swingset.proto
@@ -37,8 +37,8 @@ message Params {
 message Beans {
   option (gogoproto.equal) = true;
 
-  string int = 1 [
-    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+  string whole = 1 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Uint",
     (gogoproto.nullable) = false
   ];
 }
diff --git a/golang/cosmos/x/swingset/types/params.go b/golang/cosmos/x/swingset/types/params.go
@@ -15,9 +15,9 @@ var (
 	ParamStoreKeyFeeUnitPrice = []byte("fee_unit_price")
 )
 
-func NewBeans(i sdk.Int) Beans {
+func NewBeans(u sdk.Uint) Beans {
 	return Beans{
-		Int: i,
+		Whole: u,
 	}
 }
 
@@ -65,14 +65,10 @@ func validateBeansPerUnit(i interface{}) error {
 		return fmt.Errorf("invalid parameter type: %T", i)
 	}
 
-	for unit, beans := range v {
+	for unit := range v {
 		if unit == "" {
 			return fmt.Errorf("unit must not be empty")
 		}
-
-		if beans.Int.IsNegative() {
-			return fmt.Errorf("beans per unit %s must not be negative: %s", unit, beans.Int)
-		}
 	}
 
 	return nil

diff --git a/golang/cosmos/x/swingset/types/sim-params.go b/golang/cosmos/x/swingset/types/sim-params.go
@@ -22,24 +22,24 @@ const (
 )
 
 var (
-	DefaultBeansPerXsnapComputron = sdk.NewInt(100)
+	DefaultBeansPerXsnapComputron = sdk.NewUint(100)
 
 	// DefaultBeansPerBlockComputeLimit is how many computron beans we allow
 	// before starting a new block.  Some analysis (#3459) suggests this leads to
 	// about 2/3rds utilization, based on 5 sec voting time and up to 10 sec of
 	// computation.
-	DefaultBeansPerBlockComputeLimit = sdk.NewInt(8000000).Mul(DefaultBeansPerXsnapComputron)
+	DefaultBeansPerBlockComputeLimit = sdk.NewUint(8000000).Mul(DefaultBeansPerXsnapComputron)
 	// observed: 0.385 sec
-	DefaultBeansPerVatCreation = sdk.NewInt(300000).Mul(DefaultBeansPerXsnapComputron)
+	DefaultBeansPerVatCreation = sdk.NewUint(300000).Mul(DefaultBeansPerXsnapComputron)
 
 	// Fees are denominated in units of $1 RUN.
 	DefaultFeeUnitPrice = sdk.NewCoins(sdk.NewInt64Coin("urun", 1000000))
 
-	DefaultBeansPerFeeUnit     = sdk.NewInt(1000000000000)                        // $1
-	DefaultBeansPerInboundTx   = DefaultBeansPerFeeUnit.Quo(sdk.NewInt(100000))   // $0.00001
-	DefaultBeansPerMessage     = DefaultBeansPerFeeUnit.Quo(sdk.NewInt(1000000))  // $0.000001
-	DefaultBeansPerMessageByte = DefaultBeansPerFeeUnit.Quo(sdk.NewInt(50000000)) // $0.0000002
-	DefaultBeansPerMinFeeDebit = DefaultBeansPerFeeUnit.Quo(sdk.NewInt(4))        // $0.25
+	DefaultBeansPerFeeUnit     = sdk.NewUint(1000000000000)                        // $1
+	DefaultBeansPerInboundTx   = DefaultBeansPerFeeUnit.Quo(sdk.NewUint(100000))   // $0.00001
+	DefaultBeansPerMessage     = DefaultBeansPerFeeUnit.Quo(sdk.NewUint(1000000))  // $0.000001
+	DefaultBeansPerMessageByte = DefaultBeansPerFeeUnit.Quo(sdk.NewUint(50000000)) // $0.0000002
+	DefaultBeansPerMinFeeDebit = DefaultBeansPerFeeUnit.Quo(sdk.NewUint(4))        // $0.25
 
 	DefaultBeansPerUnit = map[string]Beans{
 		BeansPerBlockComputeLimit: NewBeans(DefaultBeansPerBlockComputeLimit),

diff --git a/golang/cosmos/x/swingset/types/swingset.pb.go b/golang/cosmos/x/swingset/types/swingset.pb.go
diff --git a/packages/cosmic-swingset/src/block-manager.js b/packages/cosmic-swingset/src/block-manager.js
@@ -58,13 +58,13 @@ const parseParams = params => {
           beans,
           X`${key} beans must be an object, not ${beans}`,
         );
-        const { int, ...rest } = beans;
+        const { whole, ...rest } = beans;
         assert.equal(
           Object.keys(rest).length,
           0,
           X`${key} beans must have no unexpected properties; had ${rest}`,
         );
-        return [key, stringToNat(int)];
+        return [key, stringToNat(whole)];
       }),
   );
 

diff --git a/packages/cosmic-swingset/src/sim-params.js b/packages/cosmic-swingset/src/sim-params.js
@@ -1,6 +1,6 @@
 import { Nat } from '@agoric/nat';
 
-const makeBeans = int => ({ int: `${Nat(int)}` });
+const makeBeans = whole => ({ whole: `${Nat(whole)}` });
 
 // This should roughly match the values in
 // `agoric-sdk/golang/cosmos/x/swingset/types/sim-params.go`.