Protobuf Documentation

Table of Contents

• vesting/v1beta1/vesting.proto
  • BaseVestingAccount
  • CliffVestingAccount
  • ContinuousVestingAccount
  • DelayedVestingAccount
  • Period
  • PeriodicVestingAccount
  • PermanentLockedAccount
• vesting/v1beta1/tx.proto

  • MsgCreateCliffVestingAccount

  • MsgCreateCliffVestingAccountResponse

  • MsgCreatePeriodicVestingAccount

  • MsgCreatePeriodicVestingAccountResponse

  • MsgCreatePermanentLockedAccount

  • MsgCreatePermanentLockedAccountResponse

  • MsgCreateVestingAccount

  • MsgCreateVestingAccountResponse

  • Msg

• Scalar Value Types

Top

vesting/v1beta1/vesting.proto

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).

CliffVestingAccount

CliffVestingAccount implements the VestingAccount interface. It continuously vests by unlocking coins after a cliff period linearly with respect to time.

Field	Type	Label	Description
base_vesting_account	BaseVestingAccount		base_vesting_account implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation
start_time	int64		start_time defines the time at which the vesting period begins
cliff_time	int64		cliff_time defines the time at which the first portion of the vesting is unlocked

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

Top

vesting/v1beta1/tx.proto

MsgCreateCliffVestingAccount

MsgCreateCliffVestingAccount defines a message that enables creating a cliff vesting account.

Field	Type	Label	Description
from_address	string
to_address	string
amount	cosmos.base.v1beta1.Coin	repeated
end_time	int64
cliff_time	int64		cliff time as unix time (in seconds) is the time at which the first portion of the vesting is unlocked.

MsgCreateCliffVestingAccountResponse

MsgCreateCliffVestingAccountResponse defines the Msg/CreateVestingAccount response type.

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	HTTP Verb	Endpoint
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 | | | CreateCliffVestingAccount | MsgCreateCliffVestingAccount | MsgCreateCliffVestingAccountResponse | CreateCliffVestingAccount defines a method that enables creating a cliff vesting account. | |

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	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.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)