cosmos/vesting

Table of Contents

• cosmos/vesting/module/v1/module.proto
  • MModule
• cosmos/vesting/v1beta1/tx.proto
  • MMsgCreatePeriodicVestingAccount
  • MMsgCreatePeriodicVestingAccountResponse
  • MMsgCreatePermanentLockedAccount
  • MMsgCreatePermanentLockedAccountResponse
  • MMsgCreateVestingAccount
  • MMsgCreateVestingAccountResponse
  • SMsg
• cosmos/vesting/v1beta1/vesting.proto
  • MBaseVestingAccount
  • MContinuousVestingAccount
  • MDelayedVestingAccount
  • MPeriod
  • MPeriodicVestingAccount
  • MPermanentLockedAccount
• Scalar Value Types

cosmos/vesting/module/v1/module.proto

Top

Module

Module is the config object of the vesting module.

cosmos/vesting/v1beta1/tx.proto

Top

MsgCreatePeriodicVestingAccount

MsgCreateVestingAccount defines a message that enables creating a vesting

account.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
from_address	string
to_address	string
start_time	int64		start of vesting as unix time (in seconds).
vesting_periods	Period	repeated

MsgCreatePeriodicVestingAccountResponse

MsgCreateVestingAccountResponse defines the Msg/CreatePeriodicVestingAccount

response type.

Since: cosmos-sdk 0.46

MsgCreatePermanentLockedAccount

MsgCreatePermanentLockedAccount defines a message that enables creating a permanent

locked account.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
from_address	string
to_address	string
amount	cosmos.base.v1beta1.Coin	repeated

MsgCreatePermanentLockedAccountResponse

MsgCreatePermanentLockedAccountResponse defines the Msg/CreatePermanentLockedAccount response type.

Since: cosmos-sdk 0.46

MsgCreateVestingAccount

MsgCreateVestingAccount defines a message that enables creating a vesting

account.

Field	Type	Label	Description
from_address	string
to_address	string
amount	cosmos.base.v1beta1.Coin	repeated
end_time	int64		end of vesting as unix time (in seconds).
delayed	bool

MsgCreateVestingAccountResponse

MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type.

Msg

Msg defines the bank Msg service.

Method Name	Request Type	Response Type	Description
CreateVestingAccount	MsgCreateVestingAccount	MsgCreateVestingAccountResponse	CreateVestingAccount defines a method that enables creating a vesting account.
CreatePermanentLockedAccount	MsgCreatePermanentLockedAccount	MsgCreatePermanentLockedAccountResponse	CreatePermanentLockedAccount defines a method that enables creating a permanent locked account. Since: cosmos-sdk 0.46
CreatePeriodicVestingAccount	MsgCreatePeriodicVestingAccount	MsgCreatePeriodicVestingAccountResponse	CreatePeriodicVestingAccount defines a method that enables creating a periodic vesting account. Since: cosmos-sdk 0.46

cosmos/vesting/v1beta1/vesting.proto

Top

BaseVestingAccount

BaseVestingAccount implements the VestingAccount interface. It contains all

the necessary fields needed for any vesting account implementation.

Field	Type	Label	Description
base_account	cosmos.auth.v1beta1.BaseAccount
original_vesting	cosmos.base.v1beta1.Coin	repeated
delegated_free	cosmos.base.v1beta1.Coin	repeated
delegated_vesting	cosmos.base.v1beta1.Coin	repeated
end_time	int64		Vesting end time, as unix timestamp (in seconds).

ContinuousVestingAccount

ContinuousVestingAccount implements the VestingAccount interface. It

continuously vests by unlocking coins linearly with respect to time.

Field	Type	Label	Description
base_vesting_account	BaseVestingAccount
start_time	int64		Vesting start time, as unix timestamp (in seconds).

DelayedVestingAccount

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.

Field	Type	Label	Description
base_vesting_account	BaseVestingAccount

Period

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

Field	Type	Label	Description
length	int64		Period duration in seconds.
amount	cosmos.base.v1beta1.Coin	repeated

PeriodicVestingAccount

PeriodicVestingAccount implements the VestingAccount interface. It

periodically vests by unlocking coins during each specified period.

Field	Type	Label	Description
base_vesting_account	BaseVestingAccount
start_time	int64
vesting_periods	Period	repeated

PermanentLockedAccount

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

Field	Type	Label	Description
base_vesting_account	BaseVestingAccount

Scalar Value Types

.proto Type	Notes	Python Type
double		float
float		float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int/long
uint32	Uses variable-length encoding.	int/long
uint64	Uses variable-length encoding.	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	int/long
sfixed32	Always four bytes.	int
sfixed64	Always eight bytes.	int/long
bool		boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	str/unicode
bytes	May contain any arbitrary sequence of bytes.	str