Skip to main content
Version: v10.0.0

Protobuf Documentation

Table of Contents

Top

vesting/v1beta1/vesting.proto

BaseVestingAccount

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

FieldTypeLabelDescription
base_accountcosmos.auth.v1beta1.BaseAccount
original_vestingcosmos.base.v1beta1.Coinrepeated
delegated_freecosmos.base.v1beta1.Coinrepeated
delegated_vestingcosmos.base.v1beta1.Coinrepeated
end_timeint64Vesting 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.

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccountbase_vesting_account implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation
start_timeint64start_time defines the time at which the vesting period begins
cliff_timeint64cliff_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.

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccount
start_timeint64Vesting 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.

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccount

Period

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

FieldTypeLabelDescription
lengthint64Period duration in seconds.
amountcosmos.base.v1beta1.Coinrepeated

PeriodicVestingAccount

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

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccount
start_timeint64
vesting_periodsPeriodrepeated

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

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccount

Top

vesting/v1beta1/tx.proto

MsgCreateCliffVestingAccount

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

FieldTypeLabelDescription
from_addressstring
to_addressstring
amountcosmos.base.v1beta1.Coinrepeated
end_timeint64
cliff_timeint64cliff 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

FieldTypeLabelDescription
from_addressstring
to_addressstring
start_timeint64start of vesting as unix time (in seconds).
vesting_periodsPeriodrepeated

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

FieldTypeLabelDescription
from_addressstring
to_addressstring
amountcosmos.base.v1beta1.Coinrepeated

MsgCreatePermanentLockedAccountResponse

MsgCreatePermanentLockedAccountResponse defines the Msg/CreatePermanentLockedAccount response type.

Since: cosmos-sdk 0.46

MsgCreateVestingAccount

MsgCreateVestingAccount defines a message that enables creating a vesting account.

FieldTypeLabelDescription
from_addressstring
to_addressstring
amountcosmos.base.v1beta1.Coinrepeated
end_timeint64end of vesting as unix time (in seconds).
delayedbool

MsgCreateVestingAccountResponse

MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type.

Msg

Msg defines the bank Msg service.

Method NameRequest TypeResponse TypeDescriptionHTTP VerbEndpoint
CreateVestingAccountMsgCreateVestingAccountMsgCreateVestingAccountResponseCreateVestingAccount defines a method that enables creating a vesting account.
CreatePermanentLockedAccountMsgCreatePermanentLockedAccountMsgCreatePermanentLockedAccountResponseCreatePermanentLockedAccount 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 TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)