CM-292 Added lease support

app.go

@@ -42,9 +42,12 @@ import (
 	"time"
 )
 
-const crudModuleEntry = "bluzelle_crud"
-const maxKeysSize = uint64(102400)
-const maxKeyValuesSize = uint64(102400)
+const (
+	crudModuleEntry         = "bluzelle_crud"
+	maxKeysSize             = uint64(102400)
+	maxKeyValuesSize        = uint64(102400)
+	DefaultLeaseBlockHeight = int64(10 * 86400 / 5) // (10 days of blocks * seconds/day) / 5
+)
 
 var (
 	// default home directories for the application CLI
@@ -136,7 +139,7 @@ func NewCRUDApp(
 	bApp.SetAppVersion(version.Version)
 
 	keys := sdk.NewKVStoreKeys(bam.MainStoreKey, auth.StoreKey, staking.StoreKey,
-		supply.StoreKey, distr.StoreKey, slashing.StoreKey, params.StoreKey, crud.StoreKey, faucet.StoreKey)
+		supply.StoreKey, distr.StoreKey, slashing.StoreKey, params.StoreKey, crud.StoreKey, faucet.StoreKey, crud.LeaseKey)
 
 	tkeys := sdk.NewTransientStoreKeys(staking.TStoreKey, params.TStoreKey)
 
@@ -219,19 +222,16 @@ func NewCRUDApp(
 	app.crudKeeper = crud.NewKeeper(
 		app.bankKeeper,
 		keys[crud.StoreKey],
+		keys[crud.LeaseKey],
 		app.cdc,
-		crud.MaxKeeperSizes{MaxKeysSize: maxKeysSize, MaxKeyValuesSize: maxKeyValuesSize},
+		crud.MaxKeeperSizes{MaxKeysSize: maxKeysSize, MaxKeyValuesSize: maxKeyValuesSize, MaxDefaultLeaseBlocks: DefaultLeaseBlockHeight},
 	)
 
-	// Example use of the faucet:
-	//
-	// blzcli tx faucet mintfor $(blzcli keys show neeraj -a) --from vuser --gas-prices 0.01bnt
-
 	app.faucetKeeper = faucet.NewKeeper(
 		app.supplyKeeper,
 		app.stakingKeeper,
-		2000000000,    // How many tokens to mint out for every successful request
-		5*time.Minute, // Time you have to wait before you can use the faucet again for a given beneficiary address
+		2000000000,
+		5*time.Minute,
 		keys[faucet.StoreKey],
 		app.cdc)
 
@@ -320,7 +320,9 @@ func (app *CRUDApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) ab
 }
 
 func (app *CRUDApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock {
-	return app.mm.EndBlock(ctx, req)
+	r := app.mm.EndBlock(ctx, req)
+	app.crudKeeper.ProcessLeasesAtBlockHeight(ctx, app.crudKeeper.GetKVStore(ctx), app.crudKeeper.GetLeaseStore(ctx), ctx.BlockHeight())
+	return r
 }
 
 func (app *CRUDApp) LoadHeight(height int64) error {

docs/commands/useful.md

@@ -189,8 +189,9 @@ request transaction
     }
 
 ***
-## query distribution validator-outstanding-rewards
->Query distribution outstanding (un-withdrawn) rewards for a validator and all their delegations
+# query distribution validator-outstanding-rewards
+>Query distribution outstanding (un-withdrawn) rewards for a validator and all 
+ their delegations
 
     blzcli query distribution validator-outstanding-rewards [validator] [flags]
 

docs/setup/deploy.md

@@ -41,7 +41,7 @@ document.
     this can be done from the command line with
 
         sed -i -e '/^##### advanced configuration options #####/a \
-            output = "json"' ~/.blzd/config/config.toml
+                    output = "json"' ~/.blzd/config/config.toml
 
 4.  Edit “.blzd/config/genesis.json” to change bond_denom from “stake” to 
     “ubnt”. This genesis.json file will be used to initialize the blockchain 

x/crud/alias.go

@@ -23,6 +23,7 @@ const (
 	ModuleName = types.ModuleName
 	RouterKey  = types.RouterKey
 	StoreKey   = types.StoreKey
+	LeaseKey   = types.LeaseKey
 )
 
 var (

x/crud/client/cli/query.go

@@ -56,7 +56,7 @@ func GetCmdQRead(queryRoute string, cdc *codec.Codec) *cobra.Command {
 			res, _, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/read/%s/%s", queryRoute, UUID, key), nil)
 
 			if err != nil {
-				fmt.Printf("could not read key - %s : %s", UUID, key)
+				fmt.Printf("could not read key - %s : %s\n", UUID, key)
 				return nil
 			}
 			var out types.QueryResultRead

x/crud/client/cli/tx.go

@@ -28,6 +28,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
+var leaseValue int64
+
 func GetTxCmd(_ string, cdc *codec.Codec) *cobra.Command {
 	crudTxCmd := &cobra.Command{
 		Use:                        types.ModuleName,
@@ -54,7 +56,7 @@ func GetTxCmd(_ string, cdc *codec.Codec) *cobra.Command {
 }
 
 func GetCmdCreate(cdc *codec.Codec) *cobra.Command {
-	return &cobra.Command{
+	cc := cobra.Command{
 		Use:   "create [UUID] [key] [value]",
 		Short: "create a new entry in the database",
 		Args:  cobra.ExactArgs(3),
@@ -63,16 +65,17 @@ func GetCmdCreate(cdc *codec.Codec) *cobra.Command {
 			inBuf := bufio.NewReader(cmd.InOrStdin())
 			txBldr := auth.NewTxBuilderFromCLI(inBuf).WithTxEncoder(utils.GetTxEncoder(cdc))
 
-			msg := types.NewMsgCreate(args[0], args[1], args[2], cliCtx.GetFromAddress())
+			msg := types.NewMsgCreate(args[0], args[1], args[2], leaseValue, cliCtx.GetFromAddress())
 
 			err := msg.ValidateBasic()
 			if err != nil {
 				return err
 			}
-
 			return utils.GenerateOrBroadcastMsgs(cliCtx, txBldr, []sdk.Msg{msg})
 		},
 	}
+	cc.PersistentFlags().Int64Var(&leaseValue, "lease", 0, "lease in blocks (default 172800 (10 days))")
+	return &cc
 }
 
 func GetCmdRead(cdc *codec.Codec) *cobra.Command {
@@ -97,15 +100,15 @@ func GetCmdRead(cdc *codec.Codec) *cobra.Command {
 }
 
 func GetCmdUpdate(cdc *codec.Codec) *cobra.Command {
-	return &cobra.Command{
+	cc := cobra.Command{
 		Use:   "update [UUID] [key] [value]",
 		Short: "update an existing entry in the database",
 		Args:  cobra.ExactArgs(3),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cliCtx := context.NewCLIContext().WithCodec(cdc)
 			inBuf := bufio.NewReader(cmd.InOrStdin())
 			txBldr := auth.NewTxBuilderFromCLI(inBuf).WithTxEncoder(utils.GetTxEncoder(cdc))
-			msg := types.NewMsgUpdate(args[0], args[1], args[2], cliCtx.GetFromAddress())
+			msg := types.MsgUpdate{UUID: args[0], Key: args[1], Value: args[2], Lease: leaseValue, Owner: cliCtx.GetFromAddress()}
 
 			err := msg.ValidateBasic()
 			if err != nil {
@@ -115,6 +118,9 @@ func GetCmdUpdate(cdc *codec.Codec) *cobra.Command {
 			return utils.GenerateOrBroadcastMsgs(cliCtx, txBldr, []sdk.Msg{msg})
 		},
 	}
+
+	cc.PersistentFlags().Int64Var(&leaseValue, "lease", 0, "lease in blocks (default 0 (no change))")
+	return &cc
 }
 
 func GetCmdDelete(cdc *codec.Codec) *cobra.Command {

x/crud/client/rest/tx.go

@@ -30,6 +30,7 @@ type createReq struct {
 	UUID    string
 	Key     string
 	Value   string
+	Lease   int64
 	Owner   string
 }
 
@@ -53,7 +54,7 @@ func BlzCreateHandler(cliCtx context.CLIContext) http.HandlerFunc {
 			return
 		}
 
-		msg := types.NewMsgCreate(req.UUID, req.Key, req.Value, addr)
+		msg := types.NewMsgCreate(req.UUID, req.Key, req.Value, req.Lease, addr)
 		err = msg.ValidateBasic()
 		if err != nil {
 			rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error())
@@ -112,6 +113,7 @@ type updateReq struct {
 	UUID    string
 	Key     string
 	Value   string
+	Lease   int64
 	Owner   string
 }
 
@@ -135,7 +137,7 @@ func BlzUpdateHandler(cliCtx context.CLIContext) http.HandlerFunc {
 			return
 		}
 
-		msg := types.NewMsgUpdate(req.UUID, req.Key, req.Value, addr)
+		msg := types.MsgUpdate{req.UUID, req.Key, req.Value, req.Lease, addr}
 		err = msg.ValidateBasic()
 		if err != nil {
 			rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error())

x/crud/genesis_test.go

@@ -47,11 +47,11 @@ func TestValidateGenesis(t *testing.T) {
 
 	assert.Nil(t, ValidateGenesis(genesisState))
 
-	blzValues = append(blzValues, types.BLZValue{"test", []byte("notnilowner")})
+	blzValues = append(blzValues, types.BLZValue{"test", 0, 0, []byte("notnilowner")})
 
 	assert.Nil(t, ValidateGenesis(genesisState))
 
-	blzValues = append(blzValues, types.BLZValue{"test", nil})
+	blzValues = append(blzValues, types.BLZValue{"test", 0, 0, nil})
 
 	assert.Nil(t, ValidateGenesis(genesisState))
 }
@@ -65,7 +65,7 @@ func TestInitGenesis(t *testing.T) {
 	data.BlzValues = append(data.BlzValues, types.BLZValue{Value: "test", Owner: owner})
 
 	mockKeeper.EXPECT().
-		SetBLZValue(ctx, nil, "UUID-Genesis", "Key-Genesis",
+		SetValue(ctx, nil, "UUID-Genesis", "Key-Genesis",
 			types.BLZValue{Value: "test", Owner: owner})
 
 	mockKeeper.EXPECT().

x/crud/handler.go

@@ -63,10 +63,21 @@ func handleMsgCreate(ctx sdk.Context, keeper keeper.IKeeper, msg types.MsgCreate
 		return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "Key already exists")
 	}
 
+	// default lease...
+	if msg.Lease == 0 {
+		msg.Lease = keeper.GetDefaultLeaseBlocks()
+	}
+
 	keeper.SetValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key, types.BLZValue{
-		Value: msg.Value,
-		Owner: msg.Owner,
+		Value:  msg.Value,
+		Owner:  msg.Owner,
+		Lease:  msg.Lease,
+		Height: ctx.BlockHeight(),
 	})
+
+	leaseCtx := ctx.WithGasMeter(sdk.NewInfiniteGasMeter())
+	keeper.SetLease(keeper.GetLeaseStore(leaseCtx), msg.UUID, msg.Key, ctx.BlockHeight(), msg.Lease)
+
 	return &sdk.Result{}, nil
 }
 
@@ -80,7 +91,8 @@ func handleMsgRead(ctx sdk.Context, keeper keeper.IKeeper, msg types.MsgRead) (*
 		return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "Key does not exist")
 	}
 
-	json_data, err := json.Marshal(types.QueryResultRead{msg.UUID, msg.Key, keeper.GetValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key).Value})
+	blzValue := keeper.GetValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key)
+	json_data, err := json.Marshal(types.QueryResultRead{msg.UUID, msg.Key, blzValue.Value, blzValue.Height, blzValue.Lease})
 	if err != nil {
 		return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "could not marshal result to JSON")
 	}
@@ -102,8 +114,27 @@ func handleMsgUpdate(ctx sdk.Context, keeper keeper.IKeeper, msg types.MsgUpdate
 		return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "Incorrect Owner")
 	}
 
-	keeper.SetValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key, types.BLZValue{Value: msg.Value, Owner: msg.Owner})
+	oldBlzValue := keeper.GetValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key)
+
+	if msg.Lease != 0 { // 0 means no change to lease
+		newLease := oldBlzValue.Lease + msg.Lease
+		if newLease <= 0 {
+			return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "Invalid lease")
+		}
+
+		if (oldBlzValue.Height + newLease) <= ctx.BlockHeight() {
+			return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "Invalid lease")
+		}
 
+		keeper.SetValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key, types.BLZValue{Value: msg.Value, Lease: newLease, Height: oldBlzValue.Height, Owner: msg.Owner})
+
+		leaseCtx := ctx.WithGasMeter(sdk.NewInfiniteGasMeter())
+		keeper.DeleteLease(keeper.GetLeaseStore(leaseCtx), msg.UUID, msg.Key, oldBlzValue.Height, oldBlzValue.Lease)
+		keeper.SetLease(keeper.GetLeaseStore(leaseCtx), msg.UUID, msg.Key, oldBlzValue.Height, newLease)
+	} else {
+		keeper.SetValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key, types.BLZValue{Value: msg.Value, Lease: oldBlzValue.Lease,
+			Owner: msg.Owner, Height: oldBlzValue.Height})
+	}
 	return &sdk.Result{}, nil
 }
 
@@ -121,7 +152,8 @@ func handleMsgDelete(ctx sdk.Context, keeper keeper.IKeeper, msg types.MsgDelete
 		return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "Incorrect Owner")
 	}
 
-	keeper.DeleteValue(ctx, keeper.GetKVStore(ctx), msg.UUID, msg.Key)
+	newCtx := ctx.WithGasMeter(sdk.NewInfiniteGasMeter())
+	keeper.DeleteValue(ctx, keeper.GetKVStore(ctx), keeper.GetLeaseStore(newCtx), msg.UUID, msg.Key)
 
 	return &sdk.Result{}, nil
 }