import "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
nolint noalias
codec.go period.go test_common.go vesting_account.go
VestingCdc module wide codec
KeyTestPubAddr generates a test key pair
NewTestCoins coins to more than cover the fee
func NewTestMsg(addrs ...sdk.AccAddress) *sdk.TestMsg
NewTestMsg generates a test message
RegisterCodec registers concrete types on the codec
type BaseVestingAccount struct {
*authtypes.BaseAccount
OriginalVesting sdk.Coins `json:"original_vesting" yaml:"original_vesting"` // coins in account upon initialization
DelegatedFree sdk.Coins `json:"delegated_free" yaml:"delegated_free"` // coins that are vested and delegated
DelegatedVesting sdk.Coins `json:"delegated_vesting" yaml:"delegated_vesting"` // coins that vesting and delegated
EndTime int64 `json:"end_time" yaml:"end_time"` // when the coins become unlocked
}BaseVestingAccount implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation.
func NewBaseVestingAccount(baseAccount *authtypes.BaseAccount, originalVesting sdk.Coins, endTime int64) (*BaseVestingAccount, error)
NewBaseVestingAccount creates a new BaseVestingAccount object
func (bva BaseVestingAccount) GetDelegatedFree() sdk.Coins
GetDelegatedFree returns a vesting account's delegation amount that is not vesting.
func (bva BaseVestingAccount) GetDelegatedVesting() sdk.Coins
GetDelegatedVesting returns a vesting account's delegation amount that is still vesting.
func (bva BaseVestingAccount) GetEndTime() int64
GetEndTime returns a vesting account's end time
func (bva BaseVestingAccount) GetOriginalVesting() sdk.Coins
GetOriginalVesting returns a vesting account's original vesting amount
func (bva BaseVestingAccount) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON representation of a BaseVestingAccount.
func (bva BaseVestingAccount) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML representation of a BaseVestingAccount.
SpendableCoinsVestingAccount returns all the spendable coins for a vesting account given a set of vesting coins.
CONTRACT: The account's coins, delegated vesting coins, vestingCoins must be sorted.
func (bva BaseVestingAccount) String() string
func (bva *BaseVestingAccount) TrackDelegation(vestingCoins, amount sdk.Coins)
TrackDelegation tracks a delegation amount for any given vesting account type given the amount of coins currently vesting.
CONTRACT: The account's coins, delegation coins, vesting coins, and delegated vesting coins must be sorted.
func (bva *BaseVestingAccount) TrackUndelegation(amount sdk.Coins)
TrackUndelegation tracks an undelegation amount by setting the necessary values by which delegated vesting and delegated vesting need to decrease and by which amount the base coins need to increase.
NOTE: The undelegation (bond refund) amount may exceed the delegated vesting (bond) amount due to the way undelegation truncates the bond refund, which can increase the validator's exchange rate (tokens/shares) slightly if the undelegated tokens are non-integral.
CONTRACT: The account's coins and undelegation coins must be sorted.
func (bva *BaseVestingAccount) UnmarshalJSON(bz []byte) error
UnmarshalJSON unmarshals raw JSON bytes into a BaseVestingAccount.
func (bva BaseVestingAccount) Validate() error
Validate checks for errors on the account fields
type ContinuousVestingAccount struct {
*BaseVestingAccount
StartTime int64 `json:"start_time" yaml:"start_time"` // when the coins start to vest
}ContinuousVestingAccount implements the VestingAccount interface. It continuously vests by unlocking coins linearly with respect to time.
func NewContinuousVestingAccount(baseAcc *authtypes.BaseAccount, startTime, endTime int64) *ContinuousVestingAccount
NewContinuousVestingAccount returns a new ContinuousVestingAccount
func NewContinuousVestingAccountRaw(bva *BaseVestingAccount, startTime int64) *ContinuousVestingAccount
NewContinuousVestingAccountRaw creates a new ContinuousVestingAccount object from BaseVestingAccount
func (cva ContinuousVestingAccount) GetStartTime() int64
GetStartTime returns the time when vesting starts for a continuous vesting account.
GetVestedCoins returns the total number of vested coins. If no coins are vested, nil is returned.
GetVestingCoins returns the total number of vesting coins. If no coins are vesting, nil is returned.
func (cva ContinuousVestingAccount) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON representation of a ContinuousVestingAccount.
func (cva ContinuousVestingAccount) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML representation of a ContinuousVestingAccount.
SpendableCoins returns the total number of spendable coins per denom for a continuous vesting account.
func (cva ContinuousVestingAccount) String() string
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 (cva *ContinuousVestingAccount) UnmarshalJSON(bz []byte) error
UnmarshalJSON unmarshals raw JSON bytes into a ContinuousVestingAccount.
func (cva ContinuousVestingAccount) Validate() error
Validate checks for errors on the account fields
type DelayedVestingAccount struct {
*BaseVestingAccount
}DelayedVestingAccount implements the VestingAccount interface. It vests all coins after a specific time, but non prior. In other words, it keeps them locked until a specified time.
func NewDelayedVestingAccount(baseAcc *authtypes.BaseAccount, endTime int64) *DelayedVestingAccount
NewDelayedVestingAccount returns a DelayedVestingAccount
func NewDelayedVestingAccountRaw(bva *BaseVestingAccount) *DelayedVestingAccount
NewDelayedVestingAccountRaw creates a new DelayedVestingAccount object from BaseVestingAccount
func (dva DelayedVestingAccount) GetStartTime() int64
GetStartTime returns zero since a delayed vesting account has no start time.
GetVestedCoins returns the total amount of vested coins for a delayed vesting account. All coins are only vested once the schedule has elapsed.
GetVestingCoins returns the total number of vesting coins for a delayed vesting account.
func (dva DelayedVestingAccount) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON representation of a DelayedVestingAccount.
SpendableCoins returns the total number of spendable coins for a delayed vesting account.
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 (dva *DelayedVestingAccount) UnmarshalJSON(bz []byte) error
UnmarshalJSON unmarshals raw JSON bytes into a DelayedVestingAccount.
func (dva DelayedVestingAccount) Validate() error
Validate checks for errors on the account fields
type Period struct {
Length int64 `json:"length" yaml:"length"` // length of the period, in seconds
Amount sdk.Coins `json:"amount" yaml:"amount"` // amount of coins vesting during this period
}Period defines a length of time and amount of coins that will vest
String Period implements stringer interface
type PeriodicVestingAccount struct {
*BaseVestingAccount
StartTime int64 `json:"start_time" yaml:"start_time"` // when the coins start to vest
VestingPeriods Periods `json:"vesting_periods" yaml:"vesting_periods"` // the vesting schedule
}PeriodicVestingAccount implements the VestingAccount interface. It periodically vests by unlocking coins during each specified period
func NewPeriodicVestingAccount(baseAcc *authtypes.BaseAccount, startTime int64, periods Periods) *PeriodicVestingAccount
NewPeriodicVestingAccount returns a new PeriodicVestingAccount
func NewPeriodicVestingAccountRaw(bva *BaseVestingAccount, startTime int64, periods Periods) *PeriodicVestingAccount
NewPeriodicVestingAccountRaw creates a new PeriodicVestingAccount object from BaseVestingAccount
func (pva PeriodicVestingAccount) GetStartTime() int64
GetStartTime returns the time when vesting starts for a periodic vesting account.
GetVestedCoins returns the total number of vested coins. If no coins are vested, nil is returned.
GetVestingCoins returns the total number of vesting coins. If no coins are vesting, nil is returned.
func (pva PeriodicVestingAccount) GetVestingPeriods() Periods
GetVestingPeriods returns vesting periods associated with periodic vesting account.
func (pva PeriodicVestingAccount) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON representation of a PeriodicVestingAccount.
func (pva PeriodicVestingAccount) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML representation of a PeriodicVestingAccount.
SpendableCoins returns the total number of spendable coins per denom for a periodic vesting account.
func (pva PeriodicVestingAccount) String() string
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) UnmarshalJSON(bz []byte) error
UnmarshalJSON unmarshals raw JSON bytes into a PeriodicVestingAccount.
func (pva PeriodicVestingAccount) Validate() error
Validate checks for errors on the account fields
Periods stores all vesting periods passed as part of a PeriodicVestingAccount
String Periods implements stringer interface
Package types imports 13 packages (graph) and is imported by 3 packages. Updated 2019-12-08. Refresh now. Tools for package owners.