evmos/vesting
Table of Contents
evmos/vesting/v1/query.proto
TopQueryBalancesRequest
QueryBalancesRequest is the request type for the Query/Balances RPC method.
Field | Type | Label | Description |
address | string | address of the clawback vesting account |
QueryBalancesResponse
QueryBalancesResponse is the response type for the Query/Balances RPC
method.
Field | Type | Label | Description |
locked | cosmos.base.v1beta1.Coin | repeated | current amount of locked tokens |
unvested | cosmos.base.v1beta1.Coin | repeated | current amount of unvested tokens |
vested | cosmos.base.v1beta1.Coin | repeated | current amount of vested tokens |
Query
Query defines the gRPC querier service.
Method Name | Request Type | Response Type | Description |
Balances | QueryBalancesRequest | QueryBalancesResponse | Retrieves the unvested, vested and locked tokens for a vesting account |
Methods with HTTP bindings
Method Name | Method | Pattern | Body |
Balances | GET | /evmos/vesting/v1/balances/{address} |
evmos/vesting/v1/vesting.proto
TopClawbackVestingAccount
ClawbackVestingAccount implements the VestingAccount interface. It provides
an account that can hold contributions subject to "lockup" (like a
PeriodicVestingAccount), or vesting which is subject to clawback
of unvested tokens, or a combination (tokens vest, but are still locked).
Field | Type | Label | Description |
base_vesting_account | cosmos.vesting.v1beta1.BaseVestingAccount | base_vesting_account implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation |
|
funder_address | string | funder_address specifies the account which can perform clawback |
|
start_time | google.protobuf.Timestamp | start_time defines the time at which the vesting period begins |
|
lockup_periods | cosmos.vesting.v1beta1.Period | repeated | lockup_periods defines the unlocking schedule relative to the start_time |
vesting_periods | cosmos.vesting.v1beta1.Period | repeated | vesting_periods defines the vesting schedule relative to the start_time |
evmos/vesting/v1/tx.proto
TopMsgClawback
MsgClawback defines a message that removes unvested tokens from a
ClawbackVestingAccount.
Field | Type | Label | Description |
funder_address | string | funder_address is the address which funded the account |
|
account_address | string | account_address is the address of the ClawbackVestingAccount to claw back from. |
|
dest_address | string | dest_address specifies where the clawed-back tokens should be transferred to. If empty, the tokens will be transferred back to the original funder of the account. |
MsgClawbackResponse
MsgClawbackResponse defines the MsgClawback response type.
MsgCreateClawbackVestingAccount
MsgCreateClawbackVestingAccount defines a message that enables creating a
ClawbackVestingAccount.
Field | Type | Label | Description |
from_address | string | from_address specifies the account to provide the funds and sign the clawback request |
|
to_address | string | to_address specifies the account to receive the funds |
|
start_time | google.protobuf.Timestamp | start_time defines the time at which the vesting period begins |
|
lockup_periods | cosmos.vesting.v1beta1.Period | repeated | lockup_periods defines the unlocking schedule relative to the start_time |
vesting_periods | cosmos.vesting.v1beta1.Period | repeated | vesting_periods defines thevesting schedule relative to the start_time |
merge | bool | merge specifies a the creation mechanism for existing ClawbackVestingAccounts. If true, merge this new grant into an existing ClawbackVestingAccount, or create it if it does not exist. If false, creates a new account. New grants to an existing account must be from the same from_address. |
MsgCreateClawbackVestingAccountResponse
MsgCreateClawbackVestingAccountResponse defines the
MsgCreateClawbackVestingAccount response type.
Msg
Msg defines the vesting Msg service.
Method Name | Request Type | Response Type | Description |
CreateClawbackVestingAccount | MsgCreateClawbackVestingAccount | MsgCreateClawbackVestingAccountResponse | CreateClawbackVestingAccount creats a vesting account that is subject to clawback and the configuration of vesting and lockup schedules. |
Clawback | MsgClawback | MsgClawbackResponse | Clawback removes the unvested tokens from a ClawbackVestingAccount. |
Methods with HTTP bindings
Method Name | Method | Pattern | Body |
CreateClawbackVestingAccount | GET | /evmos/vesting/v1/tx/create_clawback_vesting_account | |
Clawback | GET | /evmos/vesting/v1/tx/clawback |
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 |