cosmos-sdk: github.com/cosmos/cosmos-sdk/x/auth/vesting/types Index | Files

package types

import "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"

Index

Package Files

codec.go constants.go expected_keepers.go msgs.go period.go test_common.go tx.pb.go vesting.pb.go vesting_account.go

Constants

const (
    // ModuleName defines the module's name.
    ModuleName = "vesting"

    // AttributeValueCategory is an alias for the message event value.
    AttributeValueCategory = ModuleName

    // RouterKey defines the module's message routing key
    RouterKey = ModuleName
)
const TypeMsgCreateVestingAccount = "msg_create_vesting_account"

TypeMsgCreateVestingAccount defines the type value for a MsgCreateVestingAccount.

Variables

var (
    ErrInvalidLengthTx        = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowTx          = fmt.Errorf("proto: integer overflow")
    ErrUnexpectedEndOfGroupTx = fmt.Errorf("proto: unexpected end of group")
)
var (
    ErrInvalidLengthVesting        = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowVesting          = fmt.Errorf("proto: integer overflow")
    ErrUnexpectedEndOfGroupVesting = fmt.Errorf("proto: unexpected end of group")
)

func KeyTestPubAddr Uses

func KeyTestPubAddr() (cryptotypes.PrivKey, cryptotypes.PubKey, sdk.AccAddress)

KeyTestPubAddr generates a test key pair

func NewTestCoins Uses

func NewTestCoins() sdk.Coins

NewTestCoins coins to more than cover the fee

func NewTestMsg Uses

func NewTestMsg(addrs ...sdk.AccAddress) *testdata.TestMsg

NewTestMsg generates a test message

func RegisterInterfaces Uses

func RegisterInterfaces(registry types.InterfaceRegistry)

RegisterInterface associates protoName with AccountI and VestingAccount Interfaces and creates a registry of it's concrete implementations

func RegisterLegacyAminoCodec Uses

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

RegisterLegacyAminoCodec registers the vesting interfaces and concrete types on the provided LegacyAmino codec. These types are used for Amino JSON serialization

func RegisterMsgServer Uses

func RegisterMsgServer(s grpc1.Server, srv MsgServer)

type BankKeeper Uses

type BankKeeper interface {
    SendEnabledCoins(ctx sdk.Context, coins ...sdk.Coin) error
    SendCoins(ctx sdk.Context, fromAddr sdk.AccAddress, toAddr sdk.AccAddress, amt sdk.Coins) error
    BlockedAddr(addr sdk.AccAddress) bool
}

BankKeeper defines the expected interface contract the vesting module requires for creating vesting accounts with funds.

type BaseVestingAccount Uses

type BaseVestingAccount struct {
    *types.BaseAccount `protobuf:"bytes,1,opt,name=base_account,json=baseAccount,proto3,embedded=base_account" json:"base_account,omitempty"`
    OriginalVesting    github_com_cosmos_cosmos_sdk_types.Coins `protobuf:"bytes,2,rep,name=original_vesting,json=originalVesting,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"original_vesting" yaml:"original_vesting"`
    DelegatedFree      github_com_cosmos_cosmos_sdk_types.Coins `protobuf:"bytes,3,rep,name=delegated_free,json=delegatedFree,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"delegated_free" yaml:"delegated_free"`
    DelegatedVesting   github_com_cosmos_cosmos_sdk_types.Coins `protobuf:"bytes,4,rep,name=delegated_vesting,json=delegatedVesting,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"delegated_vesting" yaml:"delegated_vesting"`
    EndTime            int64                                    `protobuf:"varint,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty" yaml:"end_time"`
}

BaseVestingAccount implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation.

func NewBaseVestingAccount Uses

func NewBaseVestingAccount(baseAccount *authtypes.BaseAccount, originalVesting sdk.Coins, endTime int64) *BaseVestingAccount

NewBaseVestingAccount creates a new BaseVestingAccount object. It is the callers responsibility to ensure the base account has sufficient funds with regards to the original vesting amount.

func (*BaseVestingAccount) Descriptor Uses

func (*BaseVestingAccount) Descriptor() ([]byte, []int)

func (BaseVestingAccount) GetDelegatedFree Uses

func (bva BaseVestingAccount) GetDelegatedFree() sdk.Coins

GetDelegatedFree returns a vesting account's delegation amount that is not vesting.

func (BaseVestingAccount) GetDelegatedVesting Uses

func (bva BaseVestingAccount) GetDelegatedVesting() sdk.Coins

GetDelegatedVesting returns a vesting account's delegation amount that is still vesting.

func (BaseVestingAccount) GetEndTime Uses

func (bva BaseVestingAccount) GetEndTime() int64

GetEndTime returns a vesting account's end time

func (BaseVestingAccount) GetOriginalVesting Uses

func (bva BaseVestingAccount) GetOriginalVesting() sdk.Coins

GetOriginalVesting returns a vesting account's original vesting amount

func (BaseVestingAccount) LockedCoinsFromVesting Uses

func (bva BaseVestingAccount) LockedCoinsFromVesting(vestingCoins sdk.Coins) sdk.Coins

LockedCoinsFromVesting returns all the coins that are not spendable (i.e. locked) for a vesting account given the current vesting coins. If no coins are locked, an empty slice of Coins is returned.

CONTRACT: Delegated vesting coins and vestingCoins must be sorted.

func (*BaseVestingAccount) Marshal Uses

func (m *BaseVestingAccount) Marshal() (dAtA []byte, err error)

func (*BaseVestingAccount) MarshalTo Uses

func (m *BaseVestingAccount) MarshalTo(dAtA []byte) (int, error)

func (*BaseVestingAccount) MarshalToSizedBuffer Uses

func (m *BaseVestingAccount) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (BaseVestingAccount) MarshalYAML Uses

func (bva BaseVestingAccount) MarshalYAML() (interface{}, error)

MarshalYAML returns the YAML representation of a BaseVestingAccount.

func (*BaseVestingAccount) ProtoMessage Uses

func (*BaseVestingAccount) ProtoMessage()

func (*BaseVestingAccount) Reset Uses

func (m *BaseVestingAccount) Reset()

func (*BaseVestingAccount) Size Uses

func (m *BaseVestingAccount) Size() (n int)

func (BaseVestingAccount) String Uses

func (bva BaseVestingAccount) String() string

func (*BaseVestingAccount) TrackDelegation Uses

func (bva *BaseVestingAccount) TrackDelegation(balance, vestingCoins, amount sdk.Coins)

TrackDelegation tracks a delegation amount for any given vesting account type given the amount of coins currently vesting and the current account balance of the delegation denominations.

CONTRACT: The account's coins, delegation coins, vesting coins, and delegated vesting coins must be sorted.

func (*BaseVestingAccount) TrackUndelegation Uses

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 (*BaseVestingAccount) Unmarshal Uses

func (m *BaseVestingAccount) Unmarshal(dAtA []byte) error

func (BaseVestingAccount) Validate Uses

func (bva BaseVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*BaseVestingAccount) XXX_DiscardUnknown Uses

func (m *BaseVestingAccount) XXX_DiscardUnknown()

func (*BaseVestingAccount) XXX_Marshal Uses

func (m *BaseVestingAccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BaseVestingAccount) XXX_Merge Uses

func (m *BaseVestingAccount) XXX_Merge(src proto.Message)

func (*BaseVestingAccount) XXX_Size Uses

func (m *BaseVestingAccount) XXX_Size() int

func (*BaseVestingAccount) XXX_Unmarshal Uses

func (m *BaseVestingAccount) XXX_Unmarshal(b []byte) error

type ContinuousVestingAccount Uses

type ContinuousVestingAccount struct {
    *BaseVestingAccount `protobuf:"bytes,1,opt,name=base_vesting_account,json=baseVestingAccount,proto3,embedded=base_vesting_account" json:"base_vesting_account,omitempty"`
    StartTime           int64 `protobuf:"varint,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty" yaml:"start_time"`
}

ContinuousVestingAccount implements the VestingAccount interface. It continuously vests by unlocking coins linearly with respect to time.

func NewContinuousVestingAccount Uses

func NewContinuousVestingAccount(baseAcc *authtypes.BaseAccount, originalVesting sdk.Coins, startTime, endTime int64) *ContinuousVestingAccount

NewContinuousVestingAccount returns a new ContinuousVestingAccount

func NewContinuousVestingAccountRaw Uses

func NewContinuousVestingAccountRaw(bva *BaseVestingAccount, startTime int64) *ContinuousVestingAccount

NewContinuousVestingAccountRaw creates a new ContinuousVestingAccount object from BaseVestingAccount

func (*ContinuousVestingAccount) Descriptor Uses

func (*ContinuousVestingAccount) Descriptor() ([]byte, []int)

func (ContinuousVestingAccount) GetStartTime Uses

func (cva ContinuousVestingAccount) GetStartTime() int64

GetStartTime returns the time when vesting starts for a continuous vesting account.

func (ContinuousVestingAccount) GetVestedCoins Uses

func (cva ContinuousVestingAccount) GetVestedCoins(blockTime time.Time) sdk.Coins

GetVestedCoins returns the total number of vested coins. If no coins are vested, nil is returned.

func (ContinuousVestingAccount) GetVestingCoins Uses

func (cva ContinuousVestingAccount) GetVestingCoins(blockTime time.Time) sdk.Coins

GetVestingCoins returns the total number of vesting coins. If no coins are vesting, nil is returned.

func (ContinuousVestingAccount) LockedCoins Uses

func (cva ContinuousVestingAccount) LockedCoins(blockTime time.Time) sdk.Coins

LockedCoins returns the set of coins that are not spendable (i.e. locked).

func (*ContinuousVestingAccount) Marshal Uses

func (m *ContinuousVestingAccount) Marshal() (dAtA []byte, err error)

func (*ContinuousVestingAccount) MarshalTo Uses

func (m *ContinuousVestingAccount) MarshalTo(dAtA []byte) (int, error)

func (*ContinuousVestingAccount) MarshalToSizedBuffer Uses

func (m *ContinuousVestingAccount) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (ContinuousVestingAccount) MarshalYAML Uses

func (cva ContinuousVestingAccount) MarshalYAML() (interface{}, error)

MarshalYAML returns the YAML representation of a ContinuousVestingAccount.

func (*ContinuousVestingAccount) ProtoMessage Uses

func (*ContinuousVestingAccount) ProtoMessage()

func (*ContinuousVestingAccount) Reset Uses

func (m *ContinuousVestingAccount) Reset()

func (*ContinuousVestingAccount) Size Uses

func (m *ContinuousVestingAccount) Size() (n int)

func (ContinuousVestingAccount) String Uses

func (cva ContinuousVestingAccount) String() string

func (*ContinuousVestingAccount) TrackDelegation Uses

func (cva *ContinuousVestingAccount) TrackDelegation(blockTime time.Time, balance, amount sdk.Coins)

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 (*ContinuousVestingAccount) Unmarshal Uses

func (m *ContinuousVestingAccount) Unmarshal(dAtA []byte) error

func (ContinuousVestingAccount) Validate Uses

func (cva ContinuousVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*ContinuousVestingAccount) XXX_DiscardUnknown Uses

func (m *ContinuousVestingAccount) XXX_DiscardUnknown()

func (*ContinuousVestingAccount) XXX_Marshal Uses

func (m *ContinuousVestingAccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ContinuousVestingAccount) XXX_Merge Uses

func (m *ContinuousVestingAccount) XXX_Merge(src proto.Message)

func (*ContinuousVestingAccount) XXX_Size Uses

func (m *ContinuousVestingAccount) XXX_Size() int

func (*ContinuousVestingAccount) XXX_Unmarshal Uses

func (m *ContinuousVestingAccount) XXX_Unmarshal(b []byte) error

type DelayedVestingAccount Uses

type DelayedVestingAccount struct {
    *BaseVestingAccount `protobuf:"bytes,1,opt,name=base_vesting_account,json=baseVestingAccount,proto3,embedded=base_vesting_account" json:"base_vesting_account,omitempty"`
}

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 Uses

func NewDelayedVestingAccount(baseAcc *authtypes.BaseAccount, originalVesting sdk.Coins, endTime int64) *DelayedVestingAccount

NewDelayedVestingAccount returns a DelayedVestingAccount

func NewDelayedVestingAccountRaw Uses

func NewDelayedVestingAccountRaw(bva *BaseVestingAccount) *DelayedVestingAccount

NewDelayedVestingAccountRaw creates a new DelayedVestingAccount object from BaseVestingAccount

func (*DelayedVestingAccount) Descriptor Uses

func (*DelayedVestingAccount) Descriptor() ([]byte, []int)

func (DelayedVestingAccount) GetStartTime Uses

func (dva DelayedVestingAccount) GetStartTime() int64

GetStartTime returns zero since a delayed vesting account has no start time.

func (DelayedVestingAccount) GetVestedCoins Uses

func (dva DelayedVestingAccount) GetVestedCoins(blockTime time.Time) sdk.Coins

GetVestedCoins returns the total amount of vested coins for a delayed vesting account. All coins are only vested once the schedule has elapsed.

func (DelayedVestingAccount) GetVestingCoins Uses

func (dva DelayedVestingAccount) GetVestingCoins(blockTime time.Time) sdk.Coins

GetVestingCoins returns the total number of vesting coins for a delayed vesting account.

func (DelayedVestingAccount) LockedCoins Uses

func (dva DelayedVestingAccount) LockedCoins(blockTime time.Time) sdk.Coins

LockedCoins returns the set of coins that are not spendable (i.e. locked).

func (*DelayedVestingAccount) Marshal Uses

func (m *DelayedVestingAccount) Marshal() (dAtA []byte, err error)

func (*DelayedVestingAccount) MarshalTo Uses

func (m *DelayedVestingAccount) MarshalTo(dAtA []byte) (int, error)

func (*DelayedVestingAccount) MarshalToSizedBuffer Uses

func (m *DelayedVestingAccount) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DelayedVestingAccount) ProtoMessage Uses

func (*DelayedVestingAccount) ProtoMessage()

func (*DelayedVestingAccount) Reset Uses

func (m *DelayedVestingAccount) Reset()

func (*DelayedVestingAccount) Size Uses

func (m *DelayedVestingAccount) Size() (n int)

func (DelayedVestingAccount) String Uses

func (dva DelayedVestingAccount) String() string

func (*DelayedVestingAccount) TrackDelegation Uses

func (dva *DelayedVestingAccount) TrackDelegation(blockTime time.Time, balance, amount sdk.Coins)

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 (*DelayedVestingAccount) Unmarshal Uses

func (m *DelayedVestingAccount) Unmarshal(dAtA []byte) error

func (DelayedVestingAccount) Validate Uses

func (dva DelayedVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*DelayedVestingAccount) XXX_DiscardUnknown Uses

func (m *DelayedVestingAccount) XXX_DiscardUnknown()

func (*DelayedVestingAccount) XXX_Marshal Uses

func (m *DelayedVestingAccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DelayedVestingAccount) XXX_Merge Uses

func (m *DelayedVestingAccount) XXX_Merge(src proto.Message)

func (*DelayedVestingAccount) XXX_Size Uses

func (m *DelayedVestingAccount) XXX_Size() int

func (*DelayedVestingAccount) XXX_Unmarshal Uses

func (m *DelayedVestingAccount) XXX_Unmarshal(b []byte) error

type MsgClient Uses

type MsgClient interface {
    // CreateVestingAccount defines a method that enables creating a vesting
    // account.
    CreateVestingAccount(ctx context.Context, in *MsgCreateVestingAccount, opts ...grpc.CallOption) (*MsgCreateVestingAccountResponse, error)
}

MsgClient is the client API for Msg service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewMsgClient Uses

func NewMsgClient(cc grpc1.ClientConn) MsgClient

type MsgCreateVestingAccount Uses

type MsgCreateVestingAccount struct {
    FromAddress string                                   `protobuf:"bytes,1,opt,name=from_address,json=fromAddress,proto3" json:"from_address,omitempty" yaml:"from_address"`
    ToAddress   string                                   `protobuf:"bytes,2,opt,name=to_address,json=toAddress,proto3" json:"to_address,omitempty" yaml:"to_address"`
    Amount      github_com_cosmos_cosmos_sdk_types.Coins `protobuf:"bytes,3,rep,name=amount,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"amount"`
    EndTime     int64                                    `protobuf:"varint,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty" yaml:"end_time"`
    Delayed     bool                                     `protobuf:"varint,5,opt,name=delayed,proto3" json:"delayed,omitempty"`
}

MsgCreateVestingAccount defines a message that enables creating a vesting account.

func NewMsgCreateVestingAccount Uses

func NewMsgCreateVestingAccount(fromAddr, toAddr sdk.AccAddress, amount sdk.Coins, endTime int64, delayed bool) *MsgCreateVestingAccount

NewMsgCreateVestingAccount returns a reference to a new MsgCreateVestingAccount.

func (*MsgCreateVestingAccount) Descriptor Uses

func (*MsgCreateVestingAccount) Descriptor() ([]byte, []int)

func (*MsgCreateVestingAccount) Equal Uses

func (this *MsgCreateVestingAccount) Equal(that interface{}) bool

func (*MsgCreateVestingAccount) GetAmount Uses

func (m *MsgCreateVestingAccount) GetAmount() github_com_cosmos_cosmos_sdk_types.Coins

func (*MsgCreateVestingAccount) GetDelayed Uses

func (m *MsgCreateVestingAccount) GetDelayed() bool

func (*MsgCreateVestingAccount) GetEndTime Uses

func (m *MsgCreateVestingAccount) GetEndTime() int64

func (*MsgCreateVestingAccount) GetFromAddress Uses

func (m *MsgCreateVestingAccount) GetFromAddress() string

func (MsgCreateVestingAccount) GetSignBytes Uses

func (msg MsgCreateVestingAccount) GetSignBytes() []byte

GetSignBytes returns the bytes all expected signers must sign over for a MsgCreateVestingAccount.

func (MsgCreateVestingAccount) GetSigners Uses

func (msg MsgCreateVestingAccount) GetSigners() []sdk.AccAddress

GetSigners returns the expected signers for a MsgCreateVestingAccount.

func (*MsgCreateVestingAccount) GetToAddress Uses

func (m *MsgCreateVestingAccount) GetToAddress() string

func (*MsgCreateVestingAccount) Marshal Uses

func (m *MsgCreateVestingAccount) Marshal() (dAtA []byte, err error)

func (*MsgCreateVestingAccount) MarshalTo Uses

func (m *MsgCreateVestingAccount) MarshalTo(dAtA []byte) (int, error)

func (*MsgCreateVestingAccount) MarshalToSizedBuffer Uses

func (m *MsgCreateVestingAccount) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MsgCreateVestingAccount) ProtoMessage Uses

func (*MsgCreateVestingAccount) ProtoMessage()

func (*MsgCreateVestingAccount) Reset Uses

func (m *MsgCreateVestingAccount) Reset()

func (MsgCreateVestingAccount) Route Uses

func (msg MsgCreateVestingAccount) Route() string

Route returns the message route for a MsgCreateVestingAccount.

func (*MsgCreateVestingAccount) Size Uses

func (m *MsgCreateVestingAccount) Size() (n int)

func (*MsgCreateVestingAccount) String Uses

func (m *MsgCreateVestingAccount) String() string

func (MsgCreateVestingAccount) Type Uses

func (msg MsgCreateVestingAccount) Type() string

Type returns the message type for a MsgCreateVestingAccount.

func (*MsgCreateVestingAccount) Unmarshal Uses

func (m *MsgCreateVestingAccount) Unmarshal(dAtA []byte) error

func (MsgCreateVestingAccount) ValidateBasic Uses

func (msg MsgCreateVestingAccount) ValidateBasic() error

ValidateBasic Implements Msg.

func (*MsgCreateVestingAccount) XXX_DiscardUnknown Uses

func (m *MsgCreateVestingAccount) XXX_DiscardUnknown()

func (*MsgCreateVestingAccount) XXX_Marshal Uses

func (m *MsgCreateVestingAccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MsgCreateVestingAccount) XXX_Merge Uses

func (m *MsgCreateVestingAccount) XXX_Merge(src proto.Message)

func (*MsgCreateVestingAccount) XXX_Size Uses

func (m *MsgCreateVestingAccount) XXX_Size() int

func (*MsgCreateVestingAccount) XXX_Unmarshal Uses

func (m *MsgCreateVestingAccount) XXX_Unmarshal(b []byte) error

type MsgCreateVestingAccountResponse Uses

type MsgCreateVestingAccountResponse struct {
}

MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type.

func (*MsgCreateVestingAccountResponse) Descriptor Uses

func (*MsgCreateVestingAccountResponse) Descriptor() ([]byte, []int)

func (*MsgCreateVestingAccountResponse) Marshal Uses

func (m *MsgCreateVestingAccountResponse) Marshal() (dAtA []byte, err error)

func (*MsgCreateVestingAccountResponse) MarshalTo Uses

func (m *MsgCreateVestingAccountResponse) MarshalTo(dAtA []byte) (int, error)

func (*MsgCreateVestingAccountResponse) MarshalToSizedBuffer Uses

func (m *MsgCreateVestingAccountResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MsgCreateVestingAccountResponse) ProtoMessage Uses

func (*MsgCreateVestingAccountResponse) ProtoMessage()

func (*MsgCreateVestingAccountResponse) Reset Uses

func (m *MsgCreateVestingAccountResponse) Reset()

func (*MsgCreateVestingAccountResponse) Size Uses

func (m *MsgCreateVestingAccountResponse) Size() (n int)

func (*MsgCreateVestingAccountResponse) String Uses

func (m *MsgCreateVestingAccountResponse) String() string

func (*MsgCreateVestingAccountResponse) Unmarshal Uses

func (m *MsgCreateVestingAccountResponse) Unmarshal(dAtA []byte) error

func (*MsgCreateVestingAccountResponse) XXX_DiscardUnknown Uses

func (m *MsgCreateVestingAccountResponse) XXX_DiscardUnknown()

func (*MsgCreateVestingAccountResponse) XXX_Marshal Uses

func (m *MsgCreateVestingAccountResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MsgCreateVestingAccountResponse) XXX_Merge Uses

func (m *MsgCreateVestingAccountResponse) XXX_Merge(src proto.Message)

func (*MsgCreateVestingAccountResponse) XXX_Size Uses

func (m *MsgCreateVestingAccountResponse) XXX_Size() int

func (*MsgCreateVestingAccountResponse) XXX_Unmarshal Uses

func (m *MsgCreateVestingAccountResponse) XXX_Unmarshal(b []byte) error

type MsgServer Uses

type MsgServer interface {
    // CreateVestingAccount defines a method that enables creating a vesting
    // account.
    CreateVestingAccount(context.Context, *MsgCreateVestingAccount) (*MsgCreateVestingAccountResponse, error)
}

MsgServer is the server API for Msg service.

type Period Uses

type Period struct {
    Length int64                                    `protobuf:"varint,1,opt,name=length,proto3" json:"length,omitempty"`
    Amount github_com_cosmos_cosmos_sdk_types.Coins `protobuf:"bytes,2,rep,name=amount,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"amount"`
}

Period defines a length of time and amount of coins that will vest.

func (*Period) Descriptor Uses

func (*Period) Descriptor() ([]byte, []int)

func (*Period) GetAmount Uses

func (m *Period) GetAmount() github_com_cosmos_cosmos_sdk_types.Coins

func (*Period) GetLength Uses

func (m *Period) GetLength() int64

func (*Period) Marshal Uses

func (m *Period) Marshal() (dAtA []byte, err error)

func (*Period) MarshalTo Uses

func (m *Period) MarshalTo(dAtA []byte) (int, error)

func (*Period) MarshalToSizedBuffer Uses

func (m *Period) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Period) ProtoMessage Uses

func (*Period) ProtoMessage()

func (*Period) Reset Uses

func (m *Period) Reset()

func (*Period) Size Uses

func (m *Period) Size() (n int)

func (Period) String Uses

func (p Period) String() string

String Period implements stringer interface

func (*Period) Unmarshal Uses

func (m *Period) Unmarshal(dAtA []byte) error

func (*Period) XXX_DiscardUnknown Uses

func (m *Period) XXX_DiscardUnknown()

func (*Period) XXX_Marshal Uses

func (m *Period) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Period) XXX_Merge Uses

func (m *Period) XXX_Merge(src proto.Message)

func (*Period) XXX_Size Uses

func (m *Period) XXX_Size() int

func (*Period) XXX_Unmarshal Uses

func (m *Period) XXX_Unmarshal(b []byte) error

type PeriodicVestingAccount Uses

type PeriodicVestingAccount struct {
    *BaseVestingAccount `protobuf:"bytes,1,opt,name=base_vesting_account,json=baseVestingAccount,proto3,embedded=base_vesting_account" json:"base_vesting_account,omitempty"`
    StartTime           int64    `protobuf:"varint,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty" yaml:"start_time"`
    VestingPeriods      []Period `protobuf:"bytes,3,rep,name=vesting_periods,json=vestingPeriods,proto3" json:"vesting_periods" yaml:"vesting_periods"`
}

PeriodicVestingAccount implements the VestingAccount interface. It periodically vests by unlocking coins during each specified period.

func NewPeriodicVestingAccount Uses

func NewPeriodicVestingAccount(baseAcc *authtypes.BaseAccount, originalVesting sdk.Coins, startTime int64, periods Periods) *PeriodicVestingAccount

NewPeriodicVestingAccount returns a new PeriodicVestingAccount

func NewPeriodicVestingAccountRaw Uses

func NewPeriodicVestingAccountRaw(bva *BaseVestingAccount, startTime int64, periods Periods) *PeriodicVestingAccount

NewPeriodicVestingAccountRaw creates a new PeriodicVestingAccount object from BaseVestingAccount

func (*PeriodicVestingAccount) Descriptor Uses

func (*PeriodicVestingAccount) Descriptor() ([]byte, []int)

func (PeriodicVestingAccount) GetStartTime Uses

func (pva PeriodicVestingAccount) GetStartTime() int64

GetStartTime returns the time when vesting starts for a periodic vesting account.

func (PeriodicVestingAccount) GetVestedCoins Uses

func (pva PeriodicVestingAccount) GetVestedCoins(blockTime time.Time) sdk.Coins

GetVestedCoins returns the total number of vested coins. If no coins are vested, nil is returned.

func (PeriodicVestingAccount) GetVestingCoins Uses

func (pva PeriodicVestingAccount) GetVestingCoins(blockTime time.Time) sdk.Coins

GetVestingCoins returns the total number of vesting coins. If no coins are vesting, nil is returned.

func (PeriodicVestingAccount) GetVestingPeriods Uses

func (pva PeriodicVestingAccount) GetVestingPeriods() Periods

GetVestingPeriods returns vesting periods associated with periodic vesting account.

func (PeriodicVestingAccount) LockedCoins Uses

func (pva PeriodicVestingAccount) LockedCoins(blockTime time.Time) sdk.Coins

LockedCoins returns the set of coins that are not spendable (i.e. locked).

func (*PeriodicVestingAccount) Marshal Uses

func (m *PeriodicVestingAccount) Marshal() (dAtA []byte, err error)

func (*PeriodicVestingAccount) MarshalTo Uses

func (m *PeriodicVestingAccount) MarshalTo(dAtA []byte) (int, error)

func (*PeriodicVestingAccount) MarshalToSizedBuffer Uses

func (m *PeriodicVestingAccount) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (PeriodicVestingAccount) MarshalYAML Uses

func (pva PeriodicVestingAccount) MarshalYAML() (interface{}, error)

MarshalYAML returns the YAML representation of a PeriodicVestingAccount.

func (*PeriodicVestingAccount) ProtoMessage Uses

func (*PeriodicVestingAccount) ProtoMessage()

func (*PeriodicVestingAccount) Reset Uses

func (m *PeriodicVestingAccount) Reset()

func (*PeriodicVestingAccount) Size Uses

func (m *PeriodicVestingAccount) Size() (n int)

func (PeriodicVestingAccount) String Uses

func (pva PeriodicVestingAccount) String() string

func (*PeriodicVestingAccount) TrackDelegation Uses

func (pva *PeriodicVestingAccount) TrackDelegation(blockTime time.Time, balance, amount sdk.Coins)

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 (*PeriodicVestingAccount) Unmarshal Uses

func (m *PeriodicVestingAccount) Unmarshal(dAtA []byte) error

func (PeriodicVestingAccount) Validate Uses

func (pva PeriodicVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*PeriodicVestingAccount) XXX_DiscardUnknown Uses

func (m *PeriodicVestingAccount) XXX_DiscardUnknown()

func (*PeriodicVestingAccount) XXX_Marshal Uses

func (m *PeriodicVestingAccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PeriodicVestingAccount) XXX_Merge Uses

func (m *PeriodicVestingAccount) XXX_Merge(src proto.Message)

func (*PeriodicVestingAccount) XXX_Size Uses

func (m *PeriodicVestingAccount) XXX_Size() int

func (*PeriodicVestingAccount) XXX_Unmarshal Uses

func (m *PeriodicVestingAccount) XXX_Unmarshal(b []byte) error

type Periods Uses

type Periods []Period

Periods stores all vesting periods passed as part of a PeriodicVestingAccount

func (Periods) String Uses

func (vp Periods) String() string

String Periods implements stringer interface

type UnimplementedMsgServer Uses

type UnimplementedMsgServer struct {
}

UnimplementedMsgServer can be embedded to have forward compatible implementations.

func (*UnimplementedMsgServer) CreateVestingAccount Uses

func (*UnimplementedMsgServer) CreateVestingAccount(ctx context.Context, req *MsgCreateVestingAccount) (*MsgCreateVestingAccountResponse, error)

Package types imports 25 packages (graph) and is imported by 18 packages. Updated 2021-01-27. Refresh now. Tools for package owners.