Separate vesting from auth, add custom vesting schedules

x/auth/alias.go

@@ -44,11 +44,6 @@ var (
 	NewBaseAccount                    = types.NewBaseAccount
 	ProtoBaseAccount                  = types.ProtoBaseAccount
 	NewBaseAccountWithAddress         = types.NewBaseAccountWithAddress
-	NewBaseVestingAccount             = types.NewBaseVestingAccount
-	NewContinuousVestingAccountRaw    = types.NewContinuousVestingAccountRaw
-	NewContinuousVestingAccount       = types.NewContinuousVestingAccount
-	NewDelayedVestingAccountRaw       = types.NewDelayedVestingAccountRaw
-	NewDelayedVestingAccount          = types.NewDelayedVestingAccount
 	NewAccountRetriever               = types.NewAccountRetriever
 	RegisterCodec                     = types.RegisterCodec
 	RegisterAccountTypeCodec          = types.RegisterAccountTypeCodec
@@ -70,6 +65,7 @@ var (
 	NewTxBuilder                      = types.NewTxBuilder
 	NewTxBuilderFromCLI               = types.NewTxBuilderFromCLI
 	MakeSignature                     = types.MakeSignature
+	ValidateGenAccounts               = types.ValidateGenAccounts
 	GetGenesisStateFromAppState       = types.GetGenesisStateFromAppState
 
 	// variable aliases
@@ -86,12 +82,8 @@ var (
 type (
 	SignatureVerificationGasConsumer = ante.SignatureVerificationGasConsumer
 	Account                          = exported.Account
-	VestingAccount                   = exported.VestingAccount
 	AccountKeeper                    = keeper.AccountKeeper
 	BaseAccount                      = types.BaseAccount
-	BaseVestingAccount               = types.BaseVestingAccount
-	ContinuousVestingAccount         = types.ContinuousVestingAccount
-	DelayedVestingAccount            = types.DelayedVestingAccount
 	NodeQuerier                      = types.NodeQuerier
 	AccountRetriever                 = types.AccountRetriever
 	GenesisState                     = types.GenesisState

x/auth/client/cli/query.go

@@ -25,7 +25,7 @@ const (
 	flagLimit = "limit"
 )
 
-// GetTxCmd returns the transaction commands for this module
+// GetQueryCmd returns the transaction commands for this module
 func GetQueryCmd(cdc *codec.Codec) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:                        types.ModuleName,

x/auth/exported/exported.go

@@ -38,26 +38,6 @@ type Account interface {
 	String() string
 }
 
-// VestingAccount defines an account type that vests coins via a vesting schedule.
-type VestingAccount interface {
-	Account
-
-	// Delegation and undelegation accounting that returns the resulting base
-	// coins amount.
-	TrackDelegation(blockTime time.Time, amount sdk.Coins)
-	TrackUndelegation(amount sdk.Coins)
-
-	GetVestedCoins(blockTime time.Time) sdk.Coins
-	GetVestingCoins(blockTime time.Time) sdk.Coins
-
-	GetStartTime() int64
-	GetEndTime() int64
-
-	GetOriginalVesting() sdk.Coins
-	GetDelegatedFree() sdk.Coins
-	GetDelegatedVesting() sdk.Coins
-}
-
 // GenesisAccounts defines a slice of GenesisAccount objects
 type GenesisAccounts []GenesisAccount
 

x/auth/keeper/keeper_bench_test.go

@@ -28,12 +28,12 @@ func BenchmarkAccountMapperGetAccountFoundWithCoins(b *testing.B) {
 	app, ctx := createTestApp(false)
 
 	coins := sdk.Coins{
-		sdk.NewCoin("LTC", sdk.NewInt(1000)),
-		sdk.NewCoin("BTC", sdk.NewInt(1000)),
-		sdk.NewCoin("ETH", sdk.NewInt(1000)),
-		sdk.NewCoin("XRP", sdk.NewInt(1000)),
-		sdk.NewCoin("BCH", sdk.NewInt(1000)),
-		sdk.NewCoin("EOS", sdk.NewInt(1000)),
+		sdk.NewCoin("ltc", sdk.NewInt(1000)),
+		sdk.NewCoin("btc", sdk.NewInt(1000)),
+		sdk.NewCoin("eth", sdk.NewInt(1000)),
+		sdk.NewCoin("xrp", sdk.NewInt(1000)),
+		sdk.NewCoin("bch", sdk.NewInt(1000)),
+		sdk.NewCoin("eos", sdk.NewInt(1000)),
 	}
 
 	// assumes b.N < 2**24
@@ -70,12 +70,12 @@ func BenchmarkAccountMapperSetAccountWithCoins(b *testing.B) {
 	app, ctx := createTestApp(false)
 
 	coins := sdk.Coins{
-		sdk.NewCoin("LTC", sdk.NewInt(1000)),
-		sdk.NewCoin("BTC", sdk.NewInt(1000)),
-		sdk.NewCoin("ETH", sdk.NewInt(1000)),
-		sdk.NewCoin("XRP", sdk.NewInt(1000)),
-		sdk.NewCoin("BCH", sdk.NewInt(1000)),
-		sdk.NewCoin("EOS", sdk.NewInt(1000)),
+		sdk.NewCoin("ltc", sdk.NewInt(1000)),
+		sdk.NewCoin("btc", sdk.NewInt(1000)),
+		sdk.NewCoin("eth", sdk.NewInt(1000)),
+		sdk.NewCoin("xrp", sdk.NewInt(1000)),
+		sdk.NewCoin("bch", sdk.NewInt(1000)),
+		sdk.NewCoin("eos", sdk.NewInt(1000)),
 	}
 
 	b.ResetTimer()

x/auth/module.go

@@ -16,6 +16,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/auth/client/rest"
 	"github.com/cosmos/cosmos-sdk/x/auth/simulation"
 	"github.com/cosmos/cosmos-sdk/x/auth/types"
+	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
 	sim "github.com/cosmos/cosmos-sdk/x/simulation"
 )
 
@@ -36,6 +37,7 @@ func (AppModuleBasic) Name() string {
 // RegisterCodec registers the auth module's types for the given codec.
 func (AppModuleBasic) RegisterCodec(cdc *codec.Codec) {
 	types.RegisterCodec(cdc)
+	vestingtypes.RegisterCodec(cdc)
 }
 
 // DefaultGenesis returns default genesis state as raw bytes for the auth

x/auth/simulation/genesis.go

@@ -11,6 +11,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/module"
 	"github.com/cosmos/cosmos-sdk/x/auth/exported"
 	"github.com/cosmos/cosmos-sdk/x/auth/types"
+	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
 	"github.com/cosmos/cosmos-sdk/x/simulation"
 )
 
@@ -116,9 +117,9 @@ func RandomGenesisAccounts(simState *module.SimulationState) (genesisAccs export
 			}
 
 			if simState.Rand.Intn(100) < 50 {
-				gacc = types.NewContinuousVestingAccount(&bacc, startTime, endTime)
+				gacc = vestingtypes.NewContinuousVestingAccount(&bacc, startTime, endTime)
 			} else {
-				gacc = types.NewDelayedVestingAccount(&bacc, endTime)
+				gacc = vestingtypes.NewDelayedVestingAccount(&bacc, endTime)
 			}
 		}
 		genesisAccs = append(genesisAccs, gacc)

x/auth/spec/05_vesting.md

@@ -22,20 +22,17 @@
 
 ## Intro and Requirements
 
-This specification describes the vesting account implementation for the Cosmos Hub.
-The requirements for this vesting account is that it should be initialized
-during genesis with a starting balance `X` and a vesting end time `T`.
+This specification defines the vesting account implementation that is used by the Cosmos Hub. The requirements for this vesting account is that it should be initialized during genesis with a starting balance `X` and a vesting end time `T`. A vesting account may be initialized with a vesting start time `T'` and a number of vesting periods `P`. If a vesting start time is included, the vesting period will not begin until start time is reached. If vesting periods are included, the vesting will occur over the specified number of periods.
 
-The owner of this account should be able to delegate to and undelegate from
-validators, however they cannot send locked coins to other accounts until those
-coins have been fully vested.
+For all vesting accounts, the owner of the vesting account is able to delegate and undelegate from validators, however they cannot transfer coins to another account until those coins are vested. This specification allows for three different kinds of vesting:
+* Delayed vesting, where all coins are vested once `T` is reached.
+* Continous vesting, where coins begin to vest at `T'` and vest linearly with respect to time until `T` is reached
+* Periodic vesting, where coins begin to vest at `T'` and vest periodically according to number of periods and the vesting amount per period. The number of periods, length per period, and amount per period are configurable. A periodic vesting account is distinguished from a continuous vesting account in that coins can be released in staggered tranches. For example, a periodic vesting account could be used for vesting arrangements where coins are relased quarterly, yearly, or over any other function of tokens over time.
 
-In addition, a vesting account vests all of its coin denominations at the same
-rate. This may be subject to change.
-
-**Note**: A vesting account could have some vesting and non-vesting coins. To
-support such a feature, the `GenesisAccount` type will need to be updated in
-order to make such a distinction.
+## Note
+Vesting accounts can be initialized with some vesting and non-vesting coins. The non-vesting coins would be immediately transferable.
+The current specification does not allow for vesting accounts to be created with normal messages after genesis. All vesting accounts must be created at genesis, or as part of a manual network upgrade.
+The current specification only allows for _unconditional_ vesting (ie. there is no possibility of reaching `T` and having coins fail to vest).
 
 ## Vesting Account Types
 
@@ -83,6 +80,22 @@ type ContinuousVestingAccount struct {
 type DelayedVestingAccount struct {
     BaseVestingAccount
 }
+
+// VestingPeriod defines a length of time and amount of coins that will vest
+type Period struct {
+  Length int64 // length of the period, in seconds
+  Amount Coins // amount of coins vesting during this period
+}
+
+// Stores all vesting periods passed as part of a PeriodicVestingAccount
+type Periods []Period
+
+// PeriodicVestingAccount implements the VestingAccount interface. It
+// periodically vests by unlocking coins during each specified period
+type PeriodicVestingAccount struct {
+  ContinuousVestingAccount
+  Periods Periods // the vesting schedule
+}
 ```
 
 In order to facilitate less ad-hoc type checking and assertions and to support
@@ -150,6 +163,42 @@ func (cva ContinuousVestingAccount) GetVestingCoins(t Time) Coins {
 }
 ```
 
+### Periodic Vesting Accounts
+Periodic vesting accounts require calculating the coins released during each period for a given block time `T`. Note that multiple periods could have passed when calculating GetVestedCoins, so we must iterate over each period until the end of that period is after `T`.
+
+Set `CT := StartTime`
+Set `V' := 0`
+For each Period P:
+  1. Compute `X := T - CT`
+  2. IF `X >= P.Length`
+    a. Compute `V' += P.Amount`
+    b. Compute `CT += P.Length`
+    ELSE break
+  3. Compute `V := OV = V'`
+
+```go
+func (pva PeriodicVestingAccount) GetVestedCoins(t Time) Coins {
+  if t < pva.StartTime {
+    return ZeroCoins
+  }
+  ct := pva.StartTime // The time of the current period start
+  vested := 0
+  periods = pva.GetPeriods()
+  for i := 0; i < len(periods); i++ {
+    if t - ct < periods[i].Length {
+      break
+    }
+    vested += periods[i].Amount
+    ct += periods[i].Length
+  }
+  return vested
+}
+
+func (pva PeriodicVestingAccount) GetVestingCoins(t Time) Coins {
+    return pva.OriginalVesting - cva.GetVestedCoins(t)
+}
+```
+
 #### Delayed/Discrete Vesting Accounts
 
 Delayed vesting accounts are easier to reason about as they only have the full
@@ -426,6 +475,82 @@ Same initial starting conditions as the simple example.
 
     Notice how we have an excess amount of `DV`.
 
+### Periodic Vesting
+A vesting account is created where 100 tokens will be released over 1 year, with 1/4 of tokens vesting each quarter. The vesting schedule would be as follows:
+
+```json
+{
+  "vesting_periods": [
+    {
+      "period_length": 7884000,
+      "vesting_amount": [
+        {
+        "denom": "stake",
+        "amount": "25"
+      }
+    ]
+    },
+    {
+      "period_length": 7884000,
+      "vesting_amount": [
+        {
+        "denom": "stake",
+        "amount": "25"
+      }
+    ]
+    },
+    {
+      "period_length": 7884000,
+      "vesting_amount": [
+        {
+        "denom": "stake",
+        "amount": "25"
+      }
+    ]
+    },
+    {
+      "period_length": 7884000,
+      "vesting_amount": [
+        {
+        "denom": "stake",
+        "amount": "25"
+      }
+    ]
+    }
+  ]
+}
+```
+
+```
+OV = 100
+DF = 0
+DV = 0
+BC = 100
+V = 100
+V' = 0
+```
+
+1. Immediately receives 1 coin
+    ```
+    BC = 101
+    ```
+2. Vesting period 1 passes, 25 coins vest
+    ```
+    V = 75
+    V' = 25
+    ```
+3. During vesting period 2, 5 coins are transfered and 5 coins are delegated
+    ```
+    DV = 4
+    BC = 91
+    ```
+4. Vesting period 2 passes, 25 coins vest
+    ```
+    V = 50
+    V' = 50
+    ```
+
+
 ## Glossary
 
 - OriginalVesting: The amount of coins (per denomination) that are initially part of a vesting account. These coins are set at genesis.
@@ -435,3 +560,4 @@ Same initial starting conditions as the simple example.
 - DelegatedVesting: The tracked amount of coins (per denomination) that are delegated from a vesting account that were vesting at time of delegation.
 - ContinuousVestingAccount: A vesting account implementation that vests coins linearly over time.
 - DelayedVestingAccount: A vesting account implementation that only fully vests all coins at a given time.
+- PeriodicVestingAccount: A vesting account implementation that vests coins according to a custom vesting schedule.