types

package
v0.46.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 24, 2022 License: Apache-2.0 Imports: 29 Imported by: 2,192

Documentation

Index

Constants

View Source 
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
)
View Source 
const TypeMsgCreatePeriodicVestingAccount = "msg_create_periodic_vesting_account"

TypeMsgCreatePeriodicVestingAccount defines the type value for a MsgCreateVestingAccount.

View Source 
const TypeMsgCreatePermanentLockedAccount = "msg_create_permanent_locked_account"

TypeMsgCreatePermanentLockedAccount defines the type value for a MsgCreatePermanentLockedAccount.

View Source 
const TypeMsgCreateVestingAccount = "msg_create_vesting_account"

TypeMsgCreateVestingAccount defines the type value for a MsgCreateVestingAccount.

Variables

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

Functions

func KeyTestPubAddr 

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

KeyTestPubAddr generates a test key pair

func NewTestCoins 

func NewTestCoins() sdk.Coins

NewTestCoins coins to more than cover the fee

func NewTestMsg 

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

NewTestMsg generates a test message

func RegisterInterfaces added in v0.40.0 

func RegisterInterfaces(registry types.InterfaceRegistry)

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

func RegisterLegacyAminoCodec added in v0.40.0 

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 added in v0.40.0 

func RegisterMsgServer(s grpc1.Server, srv MsgServer)

Types

type BankKeeper added in v0.40.0 

type BankKeeper interface {
	IsSendEnabledCoins(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 

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 `` /* 150-byte string literal not displayed */
	DelegatedFree      github_com_cosmos_cosmos_sdk_types.Coins `` /* 144-byte string literal not displayed */
	DelegatedVesting   github_com_cosmos_cosmos_sdk_types.Coins `` /* 153-byte string literal not displayed */
	EndTime            int64                                    `protobuf:"varint,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
}

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

func NewBaseVestingAccount 

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 

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

func (BaseVestingAccount) GetDelegatedFree 

func (bva BaseVestingAccount) GetDelegatedFree() sdk.Coins

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

func (BaseVestingAccount) GetDelegatedVesting 

func (bva BaseVestingAccount) GetDelegatedVesting() sdk.Coins

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

func (BaseVestingAccount) GetEndTime 

func (bva BaseVestingAccount) GetEndTime() int64

GetEndTime returns a vesting account's end time

func (BaseVestingAccount) GetOriginalVesting 

func (bva BaseVestingAccount) GetOriginalVesting() sdk.Coins

GetOriginalVesting returns a vesting account's original vesting amount

func (BaseVestingAccount) LockedCoinsFromVesting 

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 

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

func (*BaseVestingAccount) MarshalTo 

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

func (*BaseVestingAccount) MarshalToSizedBuffer 

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

func (BaseVestingAccount) MarshalYAML 

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

MarshalYAML returns the YAML representation of a BaseVestingAccount.

func (*BaseVestingAccount) ProtoMessage 

func (*BaseVestingAccount) ProtoMessage()

func (*BaseVestingAccount) Reset 

func (m *BaseVestingAccount) Reset()

func (*BaseVestingAccount) Size 

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

func (BaseVestingAccount) String 

func (bva BaseVestingAccount) String() string

func (*BaseVestingAccount) TrackDelegation 

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 

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 

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

func (BaseVestingAccount) Validate 

func (bva BaseVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*BaseVestingAccount) XXX_DiscardUnknown 

func (m *BaseVestingAccount) XXX_DiscardUnknown()

func (*BaseVestingAccount) XXX_Marshal 

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

func (*BaseVestingAccount) XXX_Merge 

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

func (*BaseVestingAccount) XXX_Size 

func (m *BaseVestingAccount) XXX_Size() int

func (*BaseVestingAccount) XXX_Unmarshal 

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

type ContinuousVestingAccount 

type ContinuousVestingAccount struct {
	*BaseVestingAccount ``    /* 147-byte string literal not displayed */
	StartTime           int64 `protobuf:"varint,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
}

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

func NewContinuousVestingAccount 

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

NewContinuousVestingAccount returns a new ContinuousVestingAccount

func NewContinuousVestingAccountRaw 

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

NewContinuousVestingAccountRaw creates a new ContinuousVestingAccount object from BaseVestingAccount

func (*ContinuousVestingAccount) Descriptor 

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

func (ContinuousVestingAccount) GetStartTime 

func (cva ContinuousVestingAccount) GetStartTime() int64

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

func (ContinuousVestingAccount) GetVestedCoins 

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 

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 

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

LockedCoins returns the set of coins that are not spendable (i.e. locked), defined as the vesting coins that are not delegated.

func (*ContinuousVestingAccount) Marshal 

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

func (*ContinuousVestingAccount) MarshalTo 

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

func (*ContinuousVestingAccount) MarshalToSizedBuffer 

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

func (ContinuousVestingAccount) MarshalYAML 

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

MarshalYAML returns the YAML representation of a ContinuousVestingAccount.

func (*ContinuousVestingAccount) ProtoMessage 

func (*ContinuousVestingAccount) ProtoMessage()

func (*ContinuousVestingAccount) Reset 

func (m *ContinuousVestingAccount) Reset()

func (*ContinuousVestingAccount) Size 

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

func (ContinuousVestingAccount) String 

func (cva ContinuousVestingAccount) String() string

func (*ContinuousVestingAccount) TrackDelegation 

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 

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

func (ContinuousVestingAccount) Validate 

func (cva ContinuousVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*ContinuousVestingAccount) XXX_DiscardUnknown 

func (m *ContinuousVestingAccount) XXX_DiscardUnknown()

func (*ContinuousVestingAccount) XXX_Marshal 

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

func (*ContinuousVestingAccount) XXX_Merge 

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

func (*ContinuousVestingAccount) XXX_Size 

func (m *ContinuousVestingAccount) XXX_Size() int

func (*ContinuousVestingAccount) XXX_Unmarshal 

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

type DelayedVestingAccount 

type DelayedVestingAccount struct {
	*BaseVestingAccount `` /* 147-byte string literal not displayed */
}

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 

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

NewDelayedVestingAccount returns a DelayedVestingAccount

func NewDelayedVestingAccountRaw 

func NewDelayedVestingAccountRaw(bva *BaseVestingAccount) *DelayedVestingAccount

NewDelayedVestingAccountRaw creates a new DelayedVestingAccount object from BaseVestingAccount

func (*DelayedVestingAccount) Descriptor 

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

func (DelayedVestingAccount) GetStartTime 

func (dva DelayedVestingAccount) GetStartTime() int64

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

func (DelayedVestingAccount) GetVestedCoins 

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 

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 

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

LockedCoins returns the set of coins that are not spendable (i.e. locked), defined as the vesting coins that are not delegated.

func (*DelayedVestingAccount) Marshal 

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

func (*DelayedVestingAccount) MarshalTo 

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

func (*DelayedVestingAccount) MarshalToSizedBuffer 

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

func (*DelayedVestingAccount) ProtoMessage 

func (*DelayedVestingAccount) ProtoMessage()

func (*DelayedVestingAccount) Reset 

func (m *DelayedVestingAccount) Reset()

func (*DelayedVestingAccount) Size 

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

func (DelayedVestingAccount) String 

func (dva DelayedVestingAccount) String() string

func (*DelayedVestingAccount) TrackDelegation 

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 

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

func (DelayedVestingAccount) Validate 

func (dva DelayedVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*DelayedVestingAccount) XXX_DiscardUnknown 

func (m *DelayedVestingAccount) XXX_DiscardUnknown()

func (*DelayedVestingAccount) XXX_Marshal 

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

func (*DelayedVestingAccount) XXX_Merge 

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

func (*DelayedVestingAccount) XXX_Size 

func (m *DelayedVestingAccount) XXX_Size() int

func (*DelayedVestingAccount) XXX_Unmarshal 

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

type MsgClient added in v0.40.0 

type MsgClient interface {
	// CreateVestingAccount defines a method that enables creating a vesting
	// account.
	CreateVestingAccount(ctx context.Context, in *MsgCreateVestingAccount, opts ...grpc.CallOption) (*MsgCreateVestingAccountResponse, error)
	// CreatePermanentLockedAccount defines a method that enables creating a permanent
	// locked account.
	//
	// Since: cosmos-sdk 0.46
	CreatePermanentLockedAccount(ctx context.Context, in *MsgCreatePermanentLockedAccount, opts ...grpc.CallOption) (*MsgCreatePermanentLockedAccountResponse, error)
	// CreatePeriodicVestingAccount defines a method that enables creating a
	// periodic vesting account.
	//
	// Since: cosmos-sdk 0.46
	CreatePeriodicVestingAccount(ctx context.Context, in *MsgCreatePeriodicVestingAccount, opts ...grpc.CallOption) (*MsgCreatePeriodicVestingAccountResponse, 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 added in v0.40.0 

func NewMsgClient(cc grpc1.ClientConn) MsgClient

type MsgCreatePeriodicVestingAccount added in v0.46.0 

type MsgCreatePeriodicVestingAccount struct {
	FromAddress    string   `protobuf:"bytes,1,opt,name=from_address,json=fromAddress,proto3" json:"from_address,omitempty"`
	ToAddress      string   `protobuf:"bytes,2,opt,name=to_address,json=toAddress,proto3" json:"to_address,omitempty"`
	StartTime      int64    `protobuf:"varint,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	VestingPeriods []Period `protobuf:"bytes,4,rep,name=vesting_periods,json=vestingPeriods,proto3" json:"vesting_periods"`
}

MsgCreateVestingAccount defines a message that enables creating a vesting account.

Since: cosmos-sdk 0.46

func NewMsgCreatePeriodicVestingAccount added in v0.46.0 

func NewMsgCreatePeriodicVestingAccount(fromAddr, toAddr sdk.AccAddress, startTime int64, periods []Period) *MsgCreatePeriodicVestingAccount

NewMsgCreatePeriodicVestingAccount returns a reference to a new MsgCreatePeriodicVestingAccount.

func (*MsgCreatePeriodicVestingAccount) Descriptor added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccount) GetFromAddress added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) GetFromAddress() string

func (MsgCreatePeriodicVestingAccount) GetSignBytes added in v0.46.0 

func (msg MsgCreatePeriodicVestingAccount) GetSignBytes() []byte

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

func (MsgCreatePeriodicVestingAccount) GetSigners added in v0.46.0 

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

GetSigners returns the expected signers for a MsgCreatePeriodicVestingAccount.

func (*MsgCreatePeriodicVestingAccount) GetStartTime added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) GetStartTime() int64

func (*MsgCreatePeriodicVestingAccount) GetToAddress added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) GetToAddress() string

func (*MsgCreatePeriodicVestingAccount) GetVestingPeriods added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) GetVestingPeriods() []Period

func (*MsgCreatePeriodicVestingAccount) Marshal added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccount) MarshalTo added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccount) MarshalToSizedBuffer added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccount) ProtoMessage added in v0.46.0 

func (*MsgCreatePeriodicVestingAccount) ProtoMessage()

func (*MsgCreatePeriodicVestingAccount) Reset added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) Reset()

func (MsgCreatePeriodicVestingAccount) Route added in v0.46.0 

func (msg MsgCreatePeriodicVestingAccount) Route() string

Route returns the message route for a MsgCreatePeriodicVestingAccount.

func (*MsgCreatePeriodicVestingAccount) Size added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccount) String added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) String() string

func (MsgCreatePeriodicVestingAccount) Type added in v0.46.0 

func (msg MsgCreatePeriodicVestingAccount) Type() string

Type returns the message type for a MsgCreatePeriodicVestingAccount.

func (*MsgCreatePeriodicVestingAccount) Unmarshal added in v0.46.0 

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

func (MsgCreatePeriodicVestingAccount) ValidateBasic added in v0.46.0 

func (msg MsgCreatePeriodicVestingAccount) ValidateBasic() error

ValidateBasic Implements Msg.

func (*MsgCreatePeriodicVestingAccount) XXX_DiscardUnknown added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) XXX_DiscardUnknown()

func (*MsgCreatePeriodicVestingAccount) XXX_Marshal added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccount) XXX_Merge added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccount) XXX_Size added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccount) XXX_Size() int

func (*MsgCreatePeriodicVestingAccount) XXX_Unmarshal added in v0.46.0 

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

type MsgCreatePeriodicVestingAccountResponse added in v0.46.0 

type MsgCreatePeriodicVestingAccountResponse struct {
}

MsgCreateVestingAccountResponse defines the Msg/CreatePeriodicVestingAccount response type.

Since: cosmos-sdk 0.46

func (*MsgCreatePeriodicVestingAccountResponse) Descriptor added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) Marshal added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) MarshalTo added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) MarshalToSizedBuffer added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) ProtoMessage added in v0.46.0 

func (*MsgCreatePeriodicVestingAccountResponse) ProtoMessage()

func (*MsgCreatePeriodicVestingAccountResponse) Reset added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccountResponse) Reset()

func (*MsgCreatePeriodicVestingAccountResponse) Size added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) String added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccountResponse) String() string

func (*MsgCreatePeriodicVestingAccountResponse) Unmarshal added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) XXX_DiscardUnknown added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccountResponse) XXX_DiscardUnknown()

func (*MsgCreatePeriodicVestingAccountResponse) XXX_Marshal added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) XXX_Merge added in v0.46.0 

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

func (*MsgCreatePeriodicVestingAccountResponse) XXX_Size added in v0.46.0 

func (m *MsgCreatePeriodicVestingAccountResponse) XXX_Size() int

func (*MsgCreatePeriodicVestingAccountResponse) XXX_Unmarshal added in v0.46.0 

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

type MsgCreatePermanentLockedAccount added in v0.46.0 

type MsgCreatePermanentLockedAccount 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"`
}

MsgCreatePermanentLockedAccount defines a message that enables creating a permanent locked account.

Since: cosmos-sdk 0.46

func NewMsgCreatePermanentLockedAccount added in v0.46.0 

func NewMsgCreatePermanentLockedAccount(fromAddr, toAddr sdk.AccAddress, amount sdk.Coins) *MsgCreatePermanentLockedAccount

NewMsgCreatePermanentLockedAccount returns a reference to a new MsgCreatePermanentLockedAccount.

func (*MsgCreatePermanentLockedAccount) Descriptor added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) Equal added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) GetAmount added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) GetFromAddress added in v0.46.0 

func (m *MsgCreatePermanentLockedAccount) GetFromAddress() string

func (MsgCreatePermanentLockedAccount) GetSignBytes added in v0.46.0 

func (msg MsgCreatePermanentLockedAccount) GetSignBytes() []byte

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

func (MsgCreatePermanentLockedAccount) GetSigners added in v0.46.0 

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

GetSigners returns the expected signers for a MsgCreatePermanentLockedAccount.

func (*MsgCreatePermanentLockedAccount) GetToAddress added in v0.46.0 

func (m *MsgCreatePermanentLockedAccount) GetToAddress() string

func (*MsgCreatePermanentLockedAccount) Marshal added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) MarshalTo added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) MarshalToSizedBuffer added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) ProtoMessage added in v0.46.0 

func (*MsgCreatePermanentLockedAccount) ProtoMessage()

func (*MsgCreatePermanentLockedAccount) Reset added in v0.46.0 

func (m *MsgCreatePermanentLockedAccount) Reset()

func (MsgCreatePermanentLockedAccount) Route added in v0.46.0 

func (msg MsgCreatePermanentLockedAccount) Route() string

Route returns the message route for a MsgCreatePermanentLockedAccount.

func (*MsgCreatePermanentLockedAccount) Size added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) String added in v0.46.0 

func (m *MsgCreatePermanentLockedAccount) String() string

func (MsgCreatePermanentLockedAccount) Type added in v0.46.0 

func (msg MsgCreatePermanentLockedAccount) Type() string

Type returns the message type for a MsgCreatePermanentLockedAccount.

func (*MsgCreatePermanentLockedAccount) Unmarshal added in v0.46.0 

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

func (MsgCreatePermanentLockedAccount) ValidateBasic added in v0.46.0 

func (msg MsgCreatePermanentLockedAccount) ValidateBasic() error

ValidateBasic Implements Msg.

func (*MsgCreatePermanentLockedAccount) XXX_DiscardUnknown added in v0.46.0 

func (m *MsgCreatePermanentLockedAccount) XXX_DiscardUnknown()

func (*MsgCreatePermanentLockedAccount) XXX_Marshal added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) XXX_Merge added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccount) XXX_Size added in v0.46.0 

func (m *MsgCreatePermanentLockedAccount) XXX_Size() int

func (*MsgCreatePermanentLockedAccount) XXX_Unmarshal added in v0.46.0 

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

type MsgCreatePermanentLockedAccountResponse added in v0.46.0 

type MsgCreatePermanentLockedAccountResponse struct {
}

MsgCreatePermanentLockedAccountResponse defines the Msg/CreatePermanentLockedAccount response type.

Since: cosmos-sdk 0.46

func (*MsgCreatePermanentLockedAccountResponse) Descriptor added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) Marshal added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) MarshalTo added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) MarshalToSizedBuffer added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) ProtoMessage added in v0.46.0 

func (*MsgCreatePermanentLockedAccountResponse) ProtoMessage()

func (*MsgCreatePermanentLockedAccountResponse) Reset added in v0.46.0 

func (m *MsgCreatePermanentLockedAccountResponse) Reset()

func (*MsgCreatePermanentLockedAccountResponse) Size added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) String added in v0.46.0 

func (m *MsgCreatePermanentLockedAccountResponse) String() string

func (*MsgCreatePermanentLockedAccountResponse) Unmarshal added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) XXX_DiscardUnknown added in v0.46.0 

func (m *MsgCreatePermanentLockedAccountResponse) XXX_DiscardUnknown()

func (*MsgCreatePermanentLockedAccountResponse) XXX_Marshal added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) XXX_Merge added in v0.46.0 

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

func (*MsgCreatePermanentLockedAccountResponse) XXX_Size added in v0.46.0 

func (m *MsgCreatePermanentLockedAccountResponse) XXX_Size() int

func (*MsgCreatePermanentLockedAccountResponse) XXX_Unmarshal added in v0.46.0 

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

type MsgCreateVestingAccount added in v0.40.0 

type MsgCreateVestingAccount struct {
	FromAddress string                                   `protobuf:"bytes,1,opt,name=from_address,json=fromAddress,proto3" json:"from_address,omitempty"`
	ToAddress   string                                   `protobuf:"bytes,2,opt,name=to_address,json=toAddress,proto3" json:"to_address,omitempty"`
	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"`
	Delayed     bool                                     `protobuf:"varint,5,opt,name=delayed,proto3" json:"delayed,omitempty"`
}

MsgCreateVestingAccount defines a message that enables creating a vesting account.

func NewMsgCreateVestingAccount added in v0.40.0 

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 added in v0.40.0 

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

func (*MsgCreateVestingAccount) Equal added in v0.40.0 

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

func (*MsgCreateVestingAccount) GetAmount added in v0.40.0 

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

func (*MsgCreateVestingAccount) GetDelayed added in v0.40.0 

func (m *MsgCreateVestingAccount) GetDelayed() bool

func (*MsgCreateVestingAccount) GetEndTime added in v0.40.0 

func (m *MsgCreateVestingAccount) GetEndTime() int64

func (*MsgCreateVestingAccount) GetFromAddress added in v0.40.0 

func (m *MsgCreateVestingAccount) GetFromAddress() string

func (MsgCreateVestingAccount) GetSignBytes added in v0.40.0 

func (msg MsgCreateVestingAccount) GetSignBytes() []byte

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

func (MsgCreateVestingAccount) GetSigners added in v0.40.0 

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

GetSigners returns the expected signers for a MsgCreateVestingAccount.

func (*MsgCreateVestingAccount) GetToAddress added in v0.40.0 

func (m *MsgCreateVestingAccount) GetToAddress() string

func (*MsgCreateVestingAccount) Marshal added in v0.40.0 

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

func (*MsgCreateVestingAccount) MarshalTo added in v0.40.0 

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

func (*MsgCreateVestingAccount) MarshalToSizedBuffer added in v0.40.0 

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

func (*MsgCreateVestingAccount) ProtoMessage added in v0.40.0 

func (*MsgCreateVestingAccount) ProtoMessage()

func (*MsgCreateVestingAccount) Reset added in v0.40.0 

func (m *MsgCreateVestingAccount) Reset()

func (MsgCreateVestingAccount) Route added in v0.40.0 

func (msg MsgCreateVestingAccount) Route() string

Route returns the message route for a MsgCreateVestingAccount.

func (*MsgCreateVestingAccount) Size added in v0.40.0 

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

func (*MsgCreateVestingAccount) String added in v0.40.0 

func (m *MsgCreateVestingAccount) String() string

func (MsgCreateVestingAccount) Type added in v0.40.0 

func (msg MsgCreateVestingAccount) Type() string

Type returns the message type for a MsgCreateVestingAccount.

func (*MsgCreateVestingAccount) Unmarshal added in v0.40.0 

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

func (MsgCreateVestingAccount) ValidateBasic added in v0.40.0 

func (msg MsgCreateVestingAccount) ValidateBasic() error

ValidateBasic Implements Msg.

func (*MsgCreateVestingAccount) XXX_DiscardUnknown added in v0.40.0 

func (m *MsgCreateVestingAccount) XXX_DiscardUnknown()

func (*MsgCreateVestingAccount) XXX_Marshal added in v0.40.0 

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

func (*MsgCreateVestingAccount) XXX_Merge added in v0.40.0 

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

func (*MsgCreateVestingAccount) XXX_Size added in v0.40.0 

func (m *MsgCreateVestingAccount) XXX_Size() int

func (*MsgCreateVestingAccount) XXX_Unmarshal added in v0.40.0 

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

type MsgCreateVestingAccountResponse added in v0.40.0 

type MsgCreateVestingAccountResponse struct {
}

MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type.

func (*MsgCreateVestingAccountResponse) Descriptor added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) Marshal added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) MarshalTo added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) MarshalToSizedBuffer added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) ProtoMessage added in v0.40.0 

func (*MsgCreateVestingAccountResponse) ProtoMessage()

func (*MsgCreateVestingAccountResponse) Reset added in v0.40.0 

func (m *MsgCreateVestingAccountResponse) Reset()

func (*MsgCreateVestingAccountResponse) Size added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) String added in v0.40.0 

func (m *MsgCreateVestingAccountResponse) String() string

func (*MsgCreateVestingAccountResponse) Unmarshal added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) XXX_DiscardUnknown added in v0.40.0 

func (m *MsgCreateVestingAccountResponse) XXX_DiscardUnknown()

func (*MsgCreateVestingAccountResponse) XXX_Marshal added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) XXX_Merge added in v0.40.0 

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

func (*MsgCreateVestingAccountResponse) XXX_Size added in v0.40.0 

func (m *MsgCreateVestingAccountResponse) XXX_Size() int

func (*MsgCreateVestingAccountResponse) XXX_Unmarshal added in v0.40.0 

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

type MsgServer added in v0.40.0 

type MsgServer interface {
	// CreateVestingAccount defines a method that enables creating a vesting
	// account.
	CreateVestingAccount(context.Context, *MsgCreateVestingAccount) (*MsgCreateVestingAccountResponse, error)
	// CreatePermanentLockedAccount defines a method that enables creating a permanent
	// locked account.
	//
	// Since: cosmos-sdk 0.46
	CreatePermanentLockedAccount(context.Context, *MsgCreatePermanentLockedAccount) (*MsgCreatePermanentLockedAccountResponse, error)
	// CreatePeriodicVestingAccount defines a method that enables creating a
	// periodic vesting account.
	//
	// Since: cosmos-sdk 0.46
	CreatePeriodicVestingAccount(context.Context, *MsgCreatePeriodicVestingAccount) (*MsgCreatePeriodicVestingAccountResponse, error)
}

MsgServer is the server API for Msg service.

type Period 

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 

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

func (Period) Duration added in v0.45.4 

func (p Period) Duration() time.Duration

Duration is converts the period Length from seconds to a time.Duration

func (*Period) GetAmount 

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

func (*Period) GetLength 

func (m *Period) GetLength() int64

func (*Period) Marshal 

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

func (*Period) MarshalTo 

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

func (*Period) MarshalToSizedBuffer 

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

func (*Period) ProtoMessage 

func (*Period) ProtoMessage()

func (*Period) Reset 

func (m *Period) Reset()

func (*Period) Size 

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

func (Period) String 

func (p Period) String() string

String implements the fmt.Stringer interface

func (*Period) Unmarshal 

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

func (*Period) XXX_DiscardUnknown 

func (m *Period) XXX_DiscardUnknown()

func (*Period) XXX_Marshal 

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

func (*Period) XXX_Merge 

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

func (*Period) XXX_Size 

func (m *Period) XXX_Size() int

func (*Period) XXX_Unmarshal 

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

type PeriodicVestingAccount 

type PeriodicVestingAccount struct {
	*BaseVestingAccount ``       /* 147-byte string literal not displayed */
	StartTime           int64    `protobuf:"varint,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	VestingPeriods      []Period `protobuf:"bytes,3,rep,name=vesting_periods,json=vestingPeriods,proto3" json:"vesting_periods"`
}

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

func NewPeriodicVestingAccount 

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

NewPeriodicVestingAccount returns a new PeriodicVestingAccount

func NewPeriodicVestingAccountRaw 

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

NewPeriodicVestingAccountRaw creates a new PeriodicVestingAccount object from BaseVestingAccount

func (*PeriodicVestingAccount) Descriptor 

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

func (PeriodicVestingAccount) GetStartTime 

func (pva PeriodicVestingAccount) GetStartTime() int64

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

func (PeriodicVestingAccount) GetVestedCoins 

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 

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 

func (pva PeriodicVestingAccount) GetVestingPeriods() Periods

GetVestingPeriods returns vesting periods associated with periodic vesting account.

func (PeriodicVestingAccount) LockedCoins 

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

LockedCoins returns the set of coins that are not spendable (i.e. locked), defined as the vesting coins that are not delegated.

func (*PeriodicVestingAccount) Marshal 

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

func (*PeriodicVestingAccount) MarshalTo 

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

func (*PeriodicVestingAccount) MarshalToSizedBuffer 

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

func (PeriodicVestingAccount) MarshalYAML 

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

MarshalYAML returns the YAML representation of a PeriodicVestingAccount.

func (*PeriodicVestingAccount) ProtoMessage 

func (*PeriodicVestingAccount) ProtoMessage()

func (*PeriodicVestingAccount) Reset 

func (m *PeriodicVestingAccount) Reset()

func (*PeriodicVestingAccount) Size 

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

func (PeriodicVestingAccount) String 

func (pva PeriodicVestingAccount) String() string

func (*PeriodicVestingAccount) TrackDelegation 

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 

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

func (PeriodicVestingAccount) Validate 

func (pva PeriodicVestingAccount) Validate() error

Validate checks for errors on the account fields

func (*PeriodicVestingAccount) XXX_DiscardUnknown 

func (m *PeriodicVestingAccount) XXX_DiscardUnknown()

func (*PeriodicVestingAccount) XXX_Marshal 

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

func (*PeriodicVestingAccount) XXX_Merge 

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

func (*PeriodicVestingAccount) XXX_Size 

func (m *PeriodicVestingAccount) XXX_Size() int

func (*PeriodicVestingAccount) XXX_Unmarshal 

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

type Periods 

type Periods []Period

Periods stores all vesting periods passed as part of a PeriodicVestingAccount

func (Periods) String 

func (p Periods) String() string

String implements the fmt.Stringer interface

func (Periods) TotalAmount added in v0.45.4 

func (p Periods) TotalAmount() sdk.Coins

TotalDuration returns the sum of coins for the period

func (Periods) TotalDuration added in v0.45.4 

func (p Periods) TotalDuration() time.Duration

TotalDuration returns the total duration of the period

func (Periods) TotalLength added in v0.45.4 

func (p Periods) TotalLength() int64

TotalLength return the total length in seconds for a period

type PermanentLockedAccount added in v0.43.0 

type PermanentLockedAccount struct {
	*BaseVestingAccount `` /* 147-byte string literal not displayed */
}

PermanentLockedAccount implements the VestingAccount interface. It does not ever release coins, locking them indefinitely. Coins in this account can still be used for delegating and for governance votes even while locked.

Since: cosmos-sdk 0.43

func NewPermanentLockedAccount added in v0.43.0 

func NewPermanentLockedAccount(baseAcc *authtypes.BaseAccount, coins sdk.Coins) *PermanentLockedAccount

NewPermanentLockedAccount returns a PermanentLockedAccount

func (*PermanentLockedAccount) Descriptor added in v0.43.0 

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

func (PermanentLockedAccount) GetEndTime added in v0.43.0 

func (plva PermanentLockedAccount) GetEndTime() int64

GetEndTime returns a vesting account's end time, we return 0 to denote that a permanently locked vesting account has no end time.

func (PermanentLockedAccount) GetStartTime added in v0.43.0 

func (plva PermanentLockedAccount) GetStartTime() int64

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

func (PermanentLockedAccount) GetVestedCoins added in v0.43.0 

func (plva PermanentLockedAccount) GetVestedCoins(_ time.Time) sdk.Coins

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

func (PermanentLockedAccount) GetVestingCoins added in v0.43.0 

func (plva PermanentLockedAccount) GetVestingCoins(_ time.Time) sdk.Coins

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

func (PermanentLockedAccount) LockedCoins added in v0.43.0 

func (plva PermanentLockedAccount) LockedCoins(_ time.Time) sdk.Coins

LockedCoins returns the set of coins that are not spendable (i.e. locked), defined as the vesting coins that are not delegated.

func (*PermanentLockedAccount) Marshal added in v0.43.0 

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

func (*PermanentLockedAccount) MarshalTo added in v0.43.0 

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

func (*PermanentLockedAccount) MarshalToSizedBuffer added in v0.43.0 

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

func (*PermanentLockedAccount) ProtoMessage added in v0.43.0 

func (*PermanentLockedAccount) ProtoMessage()

func (*PermanentLockedAccount) Reset added in v0.43.0 

func (m *PermanentLockedAccount) Reset()

func (*PermanentLockedAccount) Size added in v0.43.0 

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

func (PermanentLockedAccount) String added in v0.43.0 

func (plva PermanentLockedAccount) String() string

func (*PermanentLockedAccount) TrackDelegation added in v0.43.0 

func (plva *PermanentLockedAccount) 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 (*PermanentLockedAccount) Unmarshal added in v0.43.0 

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

func (PermanentLockedAccount) Validate added in v0.43.0 

func (plva PermanentLockedAccount) Validate() error

Validate checks for errors on the account fields

func (*PermanentLockedAccount) XXX_DiscardUnknown added in v0.43.0 

func (m *PermanentLockedAccount) XXX_DiscardUnknown()

func (*PermanentLockedAccount) XXX_Marshal added in v0.43.0 

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

func (*PermanentLockedAccount) XXX_Merge added in v0.43.0 

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

func (*PermanentLockedAccount) XXX_Size added in v0.43.0 

func (m *PermanentLockedAccount) XXX_Size() int

func (*PermanentLockedAccount) XXX_Unmarshal added in v0.43.0 

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

type UnimplementedMsgServer added in v0.40.0 

type UnimplementedMsgServer struct {
}

UnimplementedMsgServer can be embedded to have forward compatible implementations.

func (*UnimplementedMsgServer) CreatePeriodicVestingAccount added in v0.46.0 

func (*UnimplementedMsgServer) CreatePeriodicVestingAccount(ctx context.Context, req *MsgCreatePeriodicVestingAccount) (*MsgCreatePeriodicVestingAccountResponse, error)

func (*UnimplementedMsgServer) CreatePermanentLockedAccount added in v0.46.0 

func (*UnimplementedMsgServer) CreatePermanentLockedAccount(ctx context.Context, req *MsgCreatePermanentLockedAccount) (*MsgCreatePermanentLockedAccountResponse, error)

func (*UnimplementedMsgServer) CreateVestingAccount added in v0.40.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.