WIP: Custom vesting curves

docs/spec/vesting/02_messages.md

@@ -0,0 +1,3 @@
+# Messages
+
+The vesting module currently has no messages. All accounts must be created as part of a genesis event.

x/auth/alias.go

@@ -29,45 +29,35 @@ const (
 
 var (
 	// functions aliases
-	NewAnteHandler                    = ante.NewAnteHandler
-	GetSignerAcc                      = ante.GetSignerAcc
-	ValidateSigCount                  = ante.ValidateSigCount
-	ValidateMemo                      = ante.ValidateMemo
-	ProcessPubKey                     = ante.ProcessPubKey
-	DefaultSigVerificationGasConsumer = ante.DefaultSigVerificationGasConsumer
-	DeductFees                        = ante.DeductFees
-	EnsureSufficientMempoolFees       = ante.EnsureSufficientMempoolFees
-	SetGasMeter                       = ante.SetGasMeter
-	GetSignBytes                      = ante.GetSignBytes
-	NewAccountKeeper                  = keeper.NewAccountKeeper
-	NewQuerier                        = keeper.NewQuerier
-	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
-	NewGenesisState                   = types.NewGenesisState
-	DefaultGenesisState               = types.DefaultGenesisState
-	ValidateGenesis                   = types.ValidateGenesis
-	AddressStoreKey                   = types.AddressStoreKey
-	NewParams                         = types.NewParams
-	ParamKeyTable                     = types.ParamKeyTable
-	DefaultParams                     = types.DefaultParams
-	NewQueryAccountParams             = types.NewQueryAccountParams
-	NewStdTx                          = types.NewStdTx
-	CountSubKeys                      = types.CountSubKeys
-	NewStdFee                         = types.NewStdFee
-	StdSignBytes                      = types.StdSignBytes
-	DefaultTxDecoder                  = types.DefaultTxDecoder
-	DefaultTxEncoder                  = types.DefaultTxEncoder
-	NewTxBuilder                      = types.NewTxBuilder
-	NewTxBuilderFromCLI               = types.NewTxBuilderFromCLI
-	MakeSignature                     = types.MakeSignature
+	NewBaseAccount                 = types.NewBaseAccount
+	ProtoBaseAccount               = types.ProtoBaseAccount
+	NewBaseAccountWithAddress      = types.NewBaseAccountWithAddress
+	NewBaseVestingAccount          = types.NewBaseVestingAccount
+	NewContinuousVestingAccountRaw = types.NewContinuousVestingAccountRaw
+	NewContinuousVestingAccount    = types.NewContinuousVestingAccount
+	NewDelayedVestingAccountRaw    = types.NewDelayedVestingAccountRaw
+	NewDelayedVestingAccount       = types.NewDelayedVestingAccount
+	NewPeriodicVestingAccountRaw   = types.NewPeriodicVestingAccountRaw
+	NewPeriodicVestingAccount      = types.NewPeriodicVestingAccount
+	RegisterCodec                  = types.RegisterCodec
+	NewGenesisState                = types.NewGenesisState
+	DefaultGenesisState            = types.DefaultGenesisState
+	ValidateGenesis                = types.ValidateGenesis
+	AddressStoreKey                = types.AddressStoreKey
+	NewParams                      = types.NewParams
+	ParamKeyTable                  = types.ParamKeyTable
+	DefaultParams                  = types.DefaultParams
+	NewQueryAccountParams          = types.NewQueryAccountParams
+	NewStdTx                       = types.NewStdTx
+	CountSubKeys                   = types.CountSubKeys
+	NewStdFee                      = types.NewStdFee
+	StdSignBytes                   = types.StdSignBytes
+	DefaultTxDecoder               = types.DefaultTxDecoder
+	DefaultTxEncoder               = types.DefaultTxEncoder
+	NewTxBuilder                   = types.NewTxBuilder
+	NewTxBuilderFromCLI            = types.NewTxBuilderFromCLI
+	MakeSignature                  = types.MakeSignature
+	NewAccountRetriever            = types.NewAccountRetriever
 
 	// variable aliases
 	ModuleCdc                 = types.ModuleCdc
@@ -81,23 +71,20 @@ 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
-	Params                           = types.Params
-	QueryAccountParams               = types.QueryAccountParams
-	StdSignMsg                       = types.StdSignMsg
-	StdTx                            = types.StdTx
-	StdFee                           = types.StdFee
-	StdSignDoc                       = types.StdSignDoc
-	StdSignature                     = types.StdSignature
-	TxBuilder                        = types.TxBuilder
+	Account                  = exported.Account
+	VestingAccount           = exported.VestingAccount
+	BaseAccount              = types.BaseAccount
+	BaseVestingAccount       = types.BaseVestingAccount
+	ContinuousVestingAccount = types.ContinuousVestingAccount
+	DelayedVestingAccount    = types.DelayedVestingAccount
+	PeriodicVestingAccount   = types.PeriodicVestingAccount
+	GenesisState             = types.GenesisState
+	Params                   = types.Params
+	QueryAccountParams       = types.QueryAccountParams
+	StdSignMsg               = types.StdSignMsg
+	StdTx                    = types.StdTx
+	StdFee                   = types.StdFee
+	StdSignDoc               = types.StdSignDoc
+	StdSignature             = types.StdSignature
+	TxBuilder                = types.TxBuilder
 )

x/auth/exported/exported.go

@@ -2,6 +2,8 @@ package exported
 
 import (
 	"time"
+	"fmt"
+	"strings"
 
 	"github.com/tendermint/tendermint/crypto"
 
@@ -56,4 +58,31 @@ type VestingAccount interface {
 	GetOriginalVesting() sdk.Coins
 	GetDelegatedFree() sdk.Coins
 	GetDelegatedVesting() sdk.Coins
+
+	GetVestingPeriods() VestingPeriods
+}
+
+// VestingPeriod defines a length of time and amount of coins that will vest
+type VestingPeriod struct {
+	PeriodLength  int64     // length of the period, in seconds
+	VestingAmount sdk.Coins // amount of coins vesting during this period
 }
+
+// VestingPeriods stores all vesting periods passed as part of a PeriodicVestingAccount
+type VestingPeriods []VestingPeriod
+
+// String VestingPeriod implements stringer interface
+func (p VestingPeriod) String() string {
+	return fmt.Sprintf(`Period Length: %d
+	VestingAmount: %s`, p.PeriodLength, p.VestingAmount)
+}
+
+// String VestingPeriods implements stringer interface
+func (vp VestingPeriods) String() string {
+	var periodsListString []string
+	for _, period := range vp {
+		periodsListString = append(periodsListString, period.String())
+	}
+	return strings.TrimSpace(fmt.Sprintf(`Vesting Periods:
+		%s`, strings.Join(periodsListString, ", ")))
+}

x/auth/types/account.go

@@ -467,6 +467,160 @@ func (cva *ContinuousVestingAccount) GetEndTime() int64 {
 	return cva.EndTime
 }
 
+// GetVestingPeriods returns empty since a continuous vesting account has no vesting periods.
+func (cva *ContinuousVestingAccount) GetVestingPeriods() exported.VestingPeriods {
+	return exported.VestingPeriods{}
+}
+
+//-----------------------------------------------------------------------------
+// Continuous Vesting Account
+
+var _ exported.VestingAccount = (*PeriodicVestingAccount)(nil)
+
+// PeriodicVestingAccount implements the VestingAccount interface. It
+// periodically vests by unlocking coins during each specified period
+type PeriodicVestingAccount struct {
+	*ContinuousVestingAccount
+	VestingPeriods exported.VestingPeriods // the vesting schedule
+}
+
+// NewPeriodicVestingAccountRaw creates a new PeriodicVestingAccount object from BaseVestingAccount
+func NewPeriodicVestingAccountRaw(bva *BaseVestingAccount,
+	startTime int64, periods exported.VestingPeriods) *PeriodicVestingAccount {
+
+	cva := &ContinuousVestingAccount{
+		StartTime:          startTime,
+		BaseVestingAccount: bva,
+	}
+	return &PeriodicVestingAccount{
+		ContinuousVestingAccount: cva,
+		VestingPeriods:           periods,
+	}
+}
+
+// NewPeriodicVestingAccount returns a new PeriodicVestingAccount
+func NewPeriodicVestingAccount(
+	baseAcc *BaseAccount, StartTime int64, periods exported.VestingPeriods) *PeriodicVestingAccount {
+
+	endTime := StartTime
+	for _, p := range periods {
+		endTime += p.PeriodLength
+	}
+	baseVestingAcc := &BaseVestingAccount{
+		BaseAccount:     baseAcc,
+		OriginalVesting: baseAcc.Coins,
+		EndTime:         endTime,
+	}
+
+	cva := &ContinuousVestingAccount{
+		StartTime:          StartTime,
+		BaseVestingAccount: baseVestingAcc,
+	}
+
+	return &PeriodicVestingAccount{
+		ContinuousVestingAccount: cva,
+		VestingPeriods:           periods,
+	}
+}
+
+func (pva PeriodicVestingAccount) String() string {
+	var pubkey string
+
+	if pva.PubKey != nil {
+		pubkey = sdk.MustBech32ifyAccPub(pva.PubKey)
+	}
+
+	return fmt.Sprintf(`Periodic Vesting Account:
+  Address:          %s
+  Pubkey:           %s
+  Coins:            %s
+  AccountNumber:    %d
+  Sequence:         %d
+  OriginalVesting:  %s
+  DelegatedFree:    %s
+  DelegatedVesting: %s
+	StartTime:        %d
+	End Time: 				%d
+  VestingPeriods:          %s `,
+		pva.Address, pubkey, pva.Coins, pva.AccountNumber, pva.Sequence,
+		pva.OriginalVesting, pva.DelegatedFree, pva.DelegatedVesting,
+		pva.StartTime, pva.EndTime, pva.VestingPeriods,
+	)
+}
+
+// GetVestedCoins returns the total number of vested coins. If no coins are vested,
+// nil is returned.
+func (pva PeriodicVestingAccount) GetVestedCoins(blockTime time.Time) sdk.Coins {
+	var vestedCoins sdk.Coins
+
+	// We must handle the case where the start time for a vesting account has
+	// been set into the future or when the start of the chain is not exactly
+	// known.
+	if blockTime.Unix() <= pva.StartTime {
+		return vestedCoins
+	} else if blockTime.Unix() >= pva.EndTime {
+		return pva.OriginalVesting
+	}
+
+	// track the start time of the next period
+	currentPeriodStartTime := pva.StartTime
+	numberPeriods := len(pva.VestingPeriods)
+	for i := 0; i < numberPeriods; i++ {
+		x := blockTime.Unix() - currentPeriodStartTime
+		// fmt.Printf(`Current Period: %v
+		// 	Current Period Start Time: %v
+		// 	Current value of x: %v
+		// 	Current Period Length: %v
+		// 	`, i, currentPeriodStartTime, x, pva.VestingPeriods[i].PeriodLength)
+		if x >= pva.VestingPeriods[i].PeriodLength {
+			// fmt.Printf(`
+			// Adding some coins for period %v
+			// `, i)
+			vestedCoins = vestedCoins.Add(pva.VestingPeriods[i].VestingAmount)
+			// Update the start time of the next period
+			currentPeriodStartTime += pva.VestingPeriods[i].PeriodLength
+		} else {
+			break
+		}
+	}
+	return vestedCoins
+}
+
+// GetVestingCoins returns the total number of vesting coins. If no coins are
+// vesting, nil is returned.
+func (pva PeriodicVestingAccount) GetVestingCoins(blockTime time.Time) sdk.Coins {
+	return pva.OriginalVesting.Sub(pva.GetVestedCoins(blockTime))
+}
+
+// SpendableCoins returns the total number of spendable coins per denom for a
+// periodic vesting account.
+func (pva PeriodicVestingAccount) SpendableCoins(blockTime time.Time) sdk.Coins {
+	return pva.spendableCoins(pva.GetVestingCoins(blockTime))
+}
+
+// TrackDelegation tracks a desired delegation amount by setting the appropriate
+// values for the amount of delegated vesting, delegated free, and reducing the
+// overall amount of base coins.
+func (pva *PeriodicVestingAccount) TrackDelegation(blockTime time.Time, amount sdk.Coins) {
+	pva.trackDelegation(pva.GetVestingCoins(blockTime), amount)
+}
+
+// GetStartTime returns the time when vesting starts for a periodic vesting
+// account.
+func (pva *PeriodicVestingAccount) GetStartTime() int64 {
+	return pva.StartTime
+}
+
+// GetEndTime returns the time when vesting ends for a periodic vesting account.
+func (pva *PeriodicVestingAccount) GetEndTime() int64 {
+	return pva.EndTime
+}
+
+// GetVestingPeriods returns vesting periods associated with periodic vesting account.
+func (pva *PeriodicVestingAccount) GetVestingPeriods() exported.VestingPeriods {
+	return pva.VestingPeriods
+}
+
 //-----------------------------------------------------------------------------
 // Delayed Vesting Account
 
@@ -535,3 +689,8 @@ func (dva *DelayedVestingAccount) GetStartTime() int64 {
 func (dva *DelayedVestingAccount) GetEndTime() int64 {
 	return dva.EndTime
 }
+
+// GetVestingPeriods returns empty since a continuous vesting account has no vesting periods.
+func (dva *DelayedVestingAccount) GetVestingPeriods() exported.VestingPeriods {
+	return exported.VestingPeriods{}
+}

x/auth/types/account_retriever_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/tests/mocks"
 )
 
-var errFoo = errors.New("dummy")
+var errDummy = errors.New("dummy")
 
 func TestAccountRetriever(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
@@ -23,18 +23,18 @@ func TestAccountRetriever(t *testing.T) {
 	require.NoError(t, err)
 
 	mockNodeQuerier.EXPECT().QueryWithData(gomock.Eq("custom/acc/account"),
-		gomock.Eq(bs)).Return(nil, int64(0), errFoo).Times(1)
+		gomock.Eq(bs)).Return(nil, int64(0), errDummy).Times(1)
 	_, err = accRetr.GetAccount(addr)
 	require.Error(t, err)
 
 	mockNodeQuerier.EXPECT().QueryWithData(gomock.Eq("custom/acc/account"),
-		gomock.Eq(bs)).Return(nil, int64(0), errFoo).Times(1)
+		gomock.Eq(bs)).Return(nil, int64(0), errDummy).Times(1)
 	n, s, err := accRetr.GetAccountNumberSequence(addr)
 	require.Error(t, err)
 	require.Equal(t, uint64(0), n)
 	require.Equal(t, uint64(0), s)
 
 	mockNodeQuerier.EXPECT().QueryWithData(gomock.Eq("custom/acc/account"),
-		gomock.Eq(bs)).Return(nil, int64(0), errFoo).Times(1)
+		gomock.Eq(bs)).Return(nil, int64(0), errDummy).Times(1)
 	require.Error(t, accRetr.EnsureExists(addr))
 }