Unbonding, Redelegation

CHANGELOG.md

@@ -1,7 +1,5 @@
 # Changelog
 
-## 0.20.0
-
 *TBD*
 
 BREAKING CHANGES
@@ -13,7 +11,39 @@ FEATURES
 * [lcd] Queried TXs now include the tx hash to identify each tx
 * [mockapp] CompleteSetup() no longer takes a testing parameter
 
+FIXES 
+* [gaia] Added self delegation for validators in the genesis creation
+
+## 0.20.0
+
+BREAKING CHANGES
+* [cli] rearranged commands under subcommands
+* [stake] remove Tick and add EndBlocker
+* [stake] introduce concept of unbonding for delegations and validators
+  * `gaiacli stake unbond` replaced with `gaiacli stake begin-unbonding`
+  * introduced: 
+    * `gaiacli stake complete-unbonding`
+    * `gaiacli stake begin-redelegation`
+    * `gaiacli stake complete-redelegation`
+
+IMPROVEMENTS
+* bank module uses go-wire codec instead of 'encoding/json'
+* auth module uses go-wire codec instead of 'encoding/json'
+* revised use of endblock and beginblock
+* [stake] module reorganized to include `types` and `keeper` package
+* [stake] keeper always loads the store (instead passing around which doesn't really boost efficiency)
+* [stake] edit-validator changes now can use the keyword [do-not-modify] to not modify unspecified `--flag` (aka won't set them to `""` value)
+* [types] added common tag constants
+* [stake] offload more generic functionality from the handler into the keeper
+
 FIXES
+* [cli] fixed cli-bash tests
+* [ci] added cli-bash tests
+* [basecoin] updated basecoin for stake and slashing
+* [docs] fixed references to old cli commands
+* [lcd] tests now don't depend on raw json text
+* [stake] error strings lower case
+* [stake] pool loose tokens now accounts for unbonding and unbonding tokens not associated with any validator
 * \#1259 - fix bug where certain tests that could have a nil pointer in defer
 * Retry on HTTP request failure in CLI tests, add option to retry tests in Makefile
 * Fixed bug where chain ID wasn't passed properly in x/bank REST handler

client/lcd/lcd_test.go

@@ -374,6 +374,7 @@ func TestValidatorsQuery(t *testing.T) {
 	assert.True(t, foundVal2, "pk2Bech %v, owner1 %v, owner2 %v", pk2Bech, validators[0].Owner, validators[1].Owner)
 }
 
+// XXX Test Redelegation
 func TestBonding(t *testing.T) {
 	name, password, denom := "test", "1234567890", "steak"
 	addr, seed := CreateAddr(t, "test", password, GetKB(t))
@@ -383,7 +384,7 @@ func TestBonding(t *testing.T) {
 	validator1Owner := pks[0].Address()
 
 	// create bond TX
-	resultTx := doBond(t, port, seed, name, password, addr, validator1Owner)
+	resultTx := doDelegate(t, port, seed, name, password, addr, validator1Owner)
 	tests.WaitForHeight(resultTx.Height+1, port)
 
 	// check if tx was commited
@@ -404,7 +405,7 @@ func TestBonding(t *testing.T) {
 	// testing unbonding
 
 	// create unbond TX
-	resultTx = doUnbond(t, port, seed, name, password, addr, validator1Owner)
+	resultTx = doBeginUnbonding(t, port, seed, name, password, addr, validator1Owner)
 	tests.WaitForHeight(resultTx.Height+1, port)
 
 	// query validator
@@ -523,7 +524,7 @@ func getDelegation(t *testing.T, port string, delegatorAddr, validatorAddr sdk.A
 	return bond
 }
 
-func doBond(t *testing.T, port, seed, name, password string, delegatorAddr, validatorAddr sdk.Address) (resultTx ctypes.ResultBroadcastTxCommit) {
+func doDelegate(t *testing.T, port, seed, name, password string, delegatorAddr, validatorAddr sdk.Address) (resultTx ctypes.ResultBroadcastTxCommit) {
 	// get the account to get the sequence
 	acc := getAccount(t, port, delegatorAddr)
 	accnum := acc.GetAccountNumber()
@@ -539,14 +540,17 @@ func doBond(t *testing.T, port, seed, name, password string, delegatorAddr, vali
 		"account_number": %d,
 		"sequence": %d,
 		"gas": 10000,
-		"delegate": [
+		"delegations": [
 			{
 				"delegator_addr": "%s",
 				"validator_addr": "%s",
 				"bond": { "denom": "%s", "amount": 60 }
 			}
 		],
-		"unbond": []
+		"begin_unbondings": [], 
+		"complete_unbondings": [], 
+		"begin_redelegates": [], 
+		"complete_redelegates": []
 	}`, name, password, accnum, sequence, delegatorAddrBech, validatorAddrBech, "steak"))
 	res, body := Request(t, port, "POST", "/stake/delegations", jsonStr)
 	require.Equal(t, http.StatusOK, res.StatusCode, body)
@@ -558,7 +562,9 @@ func doBond(t *testing.T, port, seed, name, password string, delegatorAddr, vali
 	return results[0]
 }
 
-func doUnbond(t *testing.T, port, seed, name, password string, delegatorAddr, validatorAddr sdk.Address) (resultTx ctypes.ResultBroadcastTxCommit) {
+func doBeginUnbonding(t *testing.T, port, seed, name, password string,
+	delegatorAddr, validatorAddr sdk.Address) (resultTx ctypes.ResultBroadcastTxCommit) {
+
 	// get the account to get the sequence
 	acc := getAccount(t, port, delegatorAddr)
 	accnum := acc.GetAccountNumber()
@@ -574,14 +580,17 @@ func doUnbond(t *testing.T, port, seed, name, password string, delegatorAddr, va
 		"account_number": %d,
 		"sequence": %d,
 		"gas": 10000,
-		"delegate": [],
-		"unbond": [
+		"delegations": [],
+		"begin_unbondings": [
 			{
 				"delegator_addr": "%s",
 				"validator_addr": "%s",
 				"shares": "30"
 			}
-		]
+		], 
+		"complete_unbondings": [], 
+		"begin_redelegates": [], 
+		"complete_redelegates": []
 	}`, name, password, accnum, sequence, delegatorAddrBech, validatorAddrBech))
 	res, body := Request(t, port, "POST", "/stake/delegations", jsonStr)
 	require.Equal(t, http.StatusOK, res.StatusCode, body)
@@ -593,6 +602,48 @@ func doUnbond(t *testing.T, port, seed, name, password string, delegatorAddr, va
 	return results[0]
 }
 
+func doBeginRedelegation(t *testing.T, port, seed, name, password string,
+	delegatorAddr, validatorSrcAddr, validatorDstAddr sdk.Address) (resultTx ctypes.ResultBroadcastTxCommit) {
+
+	// get the account to get the sequence
+	acc := getAccount(t, port, delegatorAddr)
+	accnum := acc.GetAccountNumber()
+	sequence := acc.GetSequence()
+
+	delegatorAddrBech := sdk.MustBech32ifyAcc(delegatorAddr)
+	validatorSrcAddrBech := sdk.MustBech32ifyVal(validatorSrcAddr)
+	validatorDstAddrBech := sdk.MustBech32ifyVal(validatorDstAddr)
+
+	// send
+	jsonStr := []byte(fmt.Sprintf(`{
+		"name": "%s",
+		"password": "%s",
+		"account_number": %d,
+		"sequence": %d,
+		"gas": 10000,
+		"delegations": [],
+		"begin_unbondings": [], 
+		"complete_unbondings": [], 
+		"begin_redelegates": [
+			{
+				"delegator_addr": "%s",
+				"validator_src_addr": "%s",
+				"validator_dst_addr": "%s",
+				"shares": "30"
+			}
+		], 
+		"complete_redelegates": []
+	}`, name, password, accnum, sequence, delegatorAddrBech, validatorSrcAddrBech, validatorDstAddrBech))
+	res, body := Request(t, port, "POST", "/stake/delegations", jsonStr)
+	require.Equal(t, http.StatusOK, res.StatusCode, body)
+
+	var results []ctypes.ResultBroadcastTxCommit
+	err := cdc.UnmarshalJSON([]byte(body), &results)
+	require.Nil(t, err)
+
+	return results[0]
+}
+
 func getValidators(t *testing.T, port string) []stakerest.StakeValidatorOutput {
 	// get the account to get the sequence
 	res, body := Request(t, port, "GET", "/stake/validators", nil)

client/lcd/test_helpers.go

@@ -100,7 +100,7 @@ func InitializeTestLCD(t *testing.T, nValidators int, initAddrs []sdk.Address) (
 	config.TxIndex.IndexAllTags = true
 
 	logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
-	logger = log.NewFilter(logger, log.AllowError())
+	logger = log.NewFilter(logger, log.AllowDebug())
 	privValidatorFile := config.PrivValidatorFile()
 	privVal := pvm.LoadOrGenFilePV(privValidatorFile)
 	privVal.Reset()

cmd/gaia/app/app.go

@@ -150,7 +150,7 @@ func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci
 	}
 
 	// load the initial stake information
-	stake.InitGenesis(ctx, app.stakeKeeper, genesisState.StakeData)
+	app.stakeKeeper.InitGenesis(ctx, genesisState.StakeData)
 
 	return abci.ResponseInitChain{}
 }
@@ -170,12 +170,12 @@ func (app *GaiaApp) ExportAppStateAndValidators() (appState json.RawMessage, val
 
 	genState := GenesisState{
 		Accounts:  accounts,
-		StakeData: stake.WriteGenesis(ctx, app.stakeKeeper),
+		StakeData: app.stakeKeeper.WriteGenesis(ctx),
 	}
 	appState, err = wire.MarshalJSONIndent(app.cdc, genState)
 	if err != nil {
 		return nil, nil, err
 	}
-	validators = stake.WriteValidators(ctx, app.stakeKeeper)
+	validators = app.stakeKeeper.WriteValidators(ctx)
 	return appState, validators, nil
 }

cmd/gaia/app/genesis.go

@@ -3,6 +3,7 @@ package app
 import (
 	"encoding/json"
 	"errors"
+
 	"github.com/spf13/pflag"
 	crypto "github.com/tendermint/go-crypto"
 	tmtypes "github.com/tendermint/tendermint/types"
@@ -17,8 +18,8 @@ import (
 
 var (
 	// bonded tokens given to genesis validators/accounts
-	freeFermionVal  = sdk.NewInt(100)
-	freeFermionsAcc = sdk.NewInt(50)
+	freeFermionVal  = int64(100)
+	freeFermionsAcc = int64(50)
 )
 
 // State to Unmarshal
@@ -123,7 +124,7 @@ func GaiaAppGenTxNF(cdc *wire.Codec, pk crypto.PubKey, addr sdk.Address, name st
 
 	validator = tmtypes.GenesisValidator{
 		PubKey: pk,
-		Power:  freeFermionVal.Int64(),
+		Power:  freeFermionVal,
 	}
 	return
 }
@@ -154,22 +155,31 @@ func GaiaAppGenState(cdc *wire.Codec, appGenTxs []json.RawMessage) (genesisState
 		accAuth := auth.NewBaseAccountWithAddress(genTx.Address)
 		accAuth.Coins = sdk.Coins{
 			{genTx.Name + "Token", sdk.NewInt(1000)},
-			{"steak", freeFermionsAcc},
+			{"steak", sdk.NewInt(freeFermionsAcc)},
 		}
 		acc := NewGenesisAccount(&accAuth)
 		genaccs[i] = acc
-		stakeData.Pool.LooseUnbondedTokens = stakeData.Pool.LooseUnbondedTokens.Add(freeFermionsAcc) // increase the supply
+		stakeData.Pool.LooseTokens = stakeData.Pool.LooseTokens + freeFermionsAcc // increase the supply
 
 		// add the validator
 		if len(genTx.Name) > 0 {
 			desc := stake.NewDescription(genTx.Name, "", "", "")
 			validator := stake.NewValidator(genTx.Address, genTx.PubKey, desc)
-			validator.PoolShares = stake.NewBondedShares(sdk.NewRatFromInt(freeFermionVal))
+
+			// add some new shares to the validator
+			var issuedDelShares sdk.Rat
+			validator, stakeData.Pool, issuedDelShares = validator.AddTokensFromDel(stakeData.Pool, freeFermionVal)
 			stakeData.Validators = append(stakeData.Validators, validator)
 
-			// pool logic
-			stakeData.Pool.BondedTokens = stakeData.Pool.BondedTokens.Add(freeFermionVal)
-			stakeData.Pool.BondedShares = sdk.NewRatFromInt(stakeData.Pool.BondedTokens)
+			// create the self delegation from the issuedDelShares
+			delegation := stake.Delegation{
+				DelegatorAddr: validator.Owner,
+				ValidatorAddr: validator.Owner,
+				Shares:        issuedDelShares,
+				Height:        0,
+			}
+
+			stakeData.Bonds = append(stakeData.Bonds, delegation)
 		}
 	}
 

cmd/gaia/cmd/gaiacli/main.go

@@ -94,7 +94,8 @@ func main() {
 			stakecmd.GetCmdCreateValidator(cdc),
 			stakecmd.GetCmdEditValidator(cdc),
 			stakecmd.GetCmdDelegate(cdc),
-			stakecmd.GetCmdUnbond(cdc),
+			stakecmd.GetCmdUnbond("stake", cdc),
+			stakecmd.GetCmdRedelegate("stake", cdc),
 			slashingcmd.GetCmdUnrevoke(cdc),
 		)...)
 	rootCmd.AddCommand(

cmd/gaia/cmd/gaiadebug/hack.go

@@ -237,7 +237,7 @@ func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci
 	}
 
 	// load the initial stake information
-	stake.InitGenesis(ctx, app.stakeKeeper, genesisState.StakeData)
+	app.stakeKeeper.InitGenesis(ctx, genesisState.StakeData)
 	return abci.ResponseInitChain{}
 
 }

docs/spec/staking/end_block.md

@@ -37,8 +37,8 @@ processProvisions():
 
         provisions = pool.Inflation * (pool.TotalSupply / hrsPerYr)
 
-        pool.LooseUnbondedTokens += provisions
-        feePool += LooseUnbondedTokens
+        pool.LooseTokens += provisions
+        feePool += LooseTokens
 
         setPool(pool)
 

docs/spec/staking/state.md

@@ -12,7 +12,7 @@ information, etc.
 
 ```golang
 type Pool struct {
-    LooseUnbondedTokens int64   // tokens not associated with any validator
+    LooseTokens int64   // tokens not associated with any validator
     UnbondedTokens      int64   // reserve of unbonded tokens held with validators
     UnbondingTokens     int64   // tokens moving from bonded to unbonded pool
     BondedTokens        int64   // reserve of bonded tokens

examples/basecoin/app/app.go

@@ -151,7 +151,7 @@ func (app *BasecoinApp) initChainer(ctx sdk.Context, req abci.RequestInitChain)
 	}
 
 	// load the initial stake information
-	stake.InitGenesis(ctx, app.stakeKeeper, genesisState.StakeData)
+	app.stakeKeeper.InitGenesis(ctx, genesisState.StakeData)
 
 	return abci.ResponseInitChain{}
 }
@@ -179,6 +179,6 @@ func (app *BasecoinApp) ExportAppStateAndValidators() (appState json.RawMessage,
 	if err != nil {
 		return nil, nil, err
 	}
-	validators = stake.WriteValidators(ctx, app.stakeKeeper)
+	validators = app.stakeKeeper.WriteValidators(ctx)
 	return appState, validators, err
 }

examples/basecoin/cmd/basecli/main.go

@@ -51,6 +51,10 @@ func main() {
 	// add query/post commands (custom to binary)
 	rootCmd.AddCommand(
 		client.GetCommands(
+			stakecmd.GetCmdQueryValidator("stake", cdc),
+			stakecmd.GetCmdQueryValidators("stake", cdc),
+			stakecmd.GetCmdQueryDelegation("stake", cdc),
+			stakecmd.GetCmdQueryDelegations("stake", cdc),
 			authcmd.GetAccountCmd("acc", cdc, types.GetAccountDecoder(cdc)),
 		)...)
 
@@ -62,7 +66,7 @@ func main() {
 			stakecmd.GetCmdCreateValidator(cdc),
 			stakecmd.GetCmdEditValidator(cdc),
 			stakecmd.GetCmdDelegate(cdc),
-			stakecmd.GetCmdUnbond(cdc),
+			stakecmd.GetCmdUnbond("stake", cdc),
 		)...)
 
 	// add proxy, version and key info

types/rational.go

@@ -110,7 +110,9 @@ func (r Rat) Denom() int64      { return r.Rat.Denom().Int64() } // Denom  - ret
 func (r Rat) IsZero() bool      { return r.Num() == 0 }          // IsZero - Is the Rat equal to zero
 func (r Rat) Equal(r2 Rat) bool { return (&(r.Rat)).Cmp(&(r2.Rat)) == 0 }
 func (r Rat) GT(r2 Rat) bool    { return (&(r.Rat)).Cmp(&(r2.Rat)) == 1 }              // greater than
+func (r Rat) GTE(r2 Rat) bool   { return !r.LT(r2) }                                   // greater than or equal
 func (r Rat) LT(r2 Rat) bool    { return (&(r.Rat)).Cmp(&(r2.Rat)) == -1 }             // less than
+func (r Rat) LTE(r2 Rat) bool   { return !r.GT(r2) }                                   // less than or equal
 func (r Rat) Mul(r2 Rat) Rat    { return Rat{*new(big.Rat).Mul(&(r.Rat), &(r2.Rat))} } // Mul - multiplication
 func (r Rat) Quo(r2 Rat) Rat    { return Rat{*new(big.Rat).Quo(&(r.Rat), &(r2.Rat))} } // Quo - quotient
 func (r Rat) Add(r2 Rat) Rat    { return Rat{*new(big.Rat).Add(&(r.Rat), &(r2.Rat))} } // Add - addition

types/stake.go

@@ -58,8 +58,13 @@ type ValidatorSet interface {
 	IterateValidatorsBonded(Context,
 		func(index int64, validator Validator) (stop bool))
 
-	Validator(Context, Address) Validator     // get a particular validator by owner address
-	TotalPower(Context) Rat                   // total power of the validator set
+	Validator(Context, Address) Validator // get a particular validator by owner address
+	TotalPower(Context) Rat               // total power of the validator set
+}
+
+// ValidatorSet that can slash and revoke (affect the validator set)
+type SlashValidatorSet interface {
+	ValidatorSet
 	Slash(Context, crypto.PubKey, int64, Rat) // slash the validator and delegators of the validator, specifying offence height & slash fraction
 	Revoke(Context, crypto.PubKey)            // revoke a validator
 	Unrevoke(Context, crypto.PubKey)          // unrevoke a validator
@@ -79,6 +84,6 @@ type DelegationSet interface {
 
 	// iterate through all delegations from one delegator by validator-address,
 	//   execute func for each validator
-	IterateDelegators(Context, delegator Address,
+	IterateDelegators(context Context, delegator Address,
 		fn func(index int64, delegation Delegation) (stop bool))
 }