evmos/incentives
Table of Contents
- evmos/incentives/v1/incentives.proto
-
evmos/incentives/v1/query.proto
- MQueryAllocationMeterRequest
- MQueryAllocationMeterResponse
- MQueryAllocationMetersRequest
- MQueryAllocationMetersResponse
- MQueryGasMeterRequest
- MQueryGasMeterResponse
- MQueryGasMetersRequest
- MQueryGasMetersResponse
- MQueryIncentiveRequest
- MQueryIncentiveResponse
- MQueryIncentivesRequest
- MQueryIncentivesResponse
- MQueryParamsRequest
- MQueryParamsResponse
- SQuery
- evmos/incentives/v1/genesis.proto
- Scalar Value Types
evmos/incentives/v1/incentives.proto
TopCancelIncentiveProposal
CancelIncentiveProposal is a gov Content type to cancel an incentive
Field | Type | Label | Description |
title | string | title of the proposal |
|
description | string | proposal description |
|
contract | string | contract address |
GasMeter
GasMeter tracks the cumulative gas spent per participant in one epoch
Field | Type | Label | Description |
contract | string | hex address of the incentivized contract |
|
participant | string | participant address that interacts with the incentive |
|
cumulative_gas | uint64 | cumulative gas spent during the epoch |
Incentive
Incentive defines an instance that organizes distribution conditions for a
given smart contract
Field | Type | Label | Description |
contract | string | contract address |
|
allocations | cosmos.base.v1beta1.DecCoin | repeated | denoms and percentage of rewards to be allocated |
epochs | uint32 | number of remaining epochs |
|
start_time | google.protobuf.Timestamp | distribution start time |
|
total_gas | uint64 | cumulative gas spent by all gasmeters of the incentive during the epoch |
RegisterIncentiveProposal
RegisterIncentiveProposal is a gov Content type to register an incentive
Field | Type | Label | Description |
title | string | title of the proposal |
|
description | string | proposal description |
|
contract | string | contract address |
|
allocations | cosmos.base.v1beta1.DecCoin | repeated | denoms and percentage of rewards to be allocated |
epochs | uint32 | number of remaining epochs |
evmos/incentives/v1/query.proto
TopQueryAllocationMeterRequest
QueryAllocationMeterRequest is the request type for the Query/AllocationMeter
RPC method.
Field | Type | Label | Description |
denom | string | denom is the coin denom to query an allocation meter for. |
QueryAllocationMeterResponse
QueryAllocationMeterResponse is the response type for the
Query/AllocationMeter RPC method.
Field | Type | Label | Description |
allocation_meter | cosmos.base.v1beta1.DecCoin |
|
QueryAllocationMetersRequest
QueryAllocationMetersRequest is the request type for the
Query/AllocationMeters RPC method.
Field | Type | Label | Description |
pagination | cosmos.base.query.v1beta1.PageRequest | pagination defines an optional pagination for the request. |
QueryAllocationMetersResponse
QueryAllocationMetersResponse is the response type for the
Query/AllocationMeters RPC method.
Field | Type | Label | Description |
allocation_meters | cosmos.base.v1beta1.DecCoin | repeated |
|
pagination | cosmos.base.query.v1beta1.PageResponse | pagination defines the pagination in the response. |
QueryGasMeterRequest
QueryGasMeterRequest is the request type for the Query/Incentive RPC method.
Field | Type | Label | Description |
contract | string | contract identifier is the hex contract address of a contract |
|
participant | string | participant identifier is the hex address of a user |
QueryGasMeterResponse
QueryGasMeterResponse is the response type for the Query/Incentive RPC
method.
Field | Type | Label | Description |
gas_meter | uint64 |
|
QueryGasMetersRequest
QueryGasMetersRequest is the request type for the Query/Incentives RPC
method.
Field | Type | Label | Description |
contract | string | contract is the hex contract address of a incentivized smart contract |
|
pagination | cosmos.base.query.v1beta1.PageRequest | pagination defines an optional pagination for the request. |
QueryGasMetersResponse
QueryGasMetersResponse is the response type for the Query/Incentives RPC
method.
Field | Type | Label | Description |
gas_meters | GasMeter | repeated |
|
pagination | cosmos.base.query.v1beta1.PageResponse | pagination defines the pagination in the response. |
QueryIncentiveRequest
QueryIncentiveRequest is the request type for the Query/Incentive RPC method.
Field | Type | Label | Description |
contract | string | contract identifier is the hex contract address of a contract |
QueryIncentiveResponse
QueryIncentiveResponse is the response type for the Query/Incentive RPC
method.
Field | Type | Label | Description |
incentive | Incentive |
|
QueryIncentivesRequest
QueryIncentivesRequest is the request type for the Query/Incentives RPC
method.
Field | Type | Label | Description |
pagination | cosmos.base.query.v1beta1.PageRequest | pagination defines an optional pagination for the request. |
QueryIncentivesResponse
QueryIncentivesResponse is the response type for the Query/Incentives RPC
method.
Field | Type | Label | Description |
incentives | Incentive | repeated |
|
pagination | cosmos.base.query.v1beta1.PageResponse | pagination defines the pagination in the response. |
QueryParamsRequest
QueryParamsRequest is the request type for the Query/Params RPC method.
QueryParamsResponse
QueryParamsResponse is the response type for the Query/Params RPC
method.
Field | Type | Label | Description |
params | Params |
|
Query
Query defines the gRPC querier service.
Method Name | Request Type | Response Type | Description |
Incentives | QueryIncentivesRequest | QueryIncentivesResponse | Incentives retrieves registered incentives |
Incentive | QueryIncentiveRequest | QueryIncentiveResponse | Incentive retrieves a registered incentive |
GasMeters | QueryGasMetersRequest | QueryGasMetersResponse | GasMeters retrieves active gas meters for a given contract |
GasMeter | QueryGasMeterRequest | QueryGasMeterResponse | GasMeter Retrieves a active gas meter |
AllocationMeters | QueryAllocationMetersRequest | QueryAllocationMetersResponse | AllocationMeters retrieves active allocation meters for a given denomination |
AllocationMeter | QueryAllocationMeterRequest | QueryAllocationMeterResponse | AllocationMeter Retrieves a active gas meter |
Params | QueryParamsRequest | QueryParamsResponse | Params retrieves the incentives module params |
Methods with HTTP bindings
Method Name | Method | Pattern | Body |
Incentives | GET | /evmos/incentives/v1/incentives | |
Incentive | GET | /evmos/incentives/v1/incentives/{contract} | |
GasMeters | GET | /evmos/incentives/v1/gas_meters/{contract} | |
GasMeter | GET | /evmos/incentives/v1/gas_meters/{contract}/{participant} | |
AllocationMeters | GET | /evmos/incentives/v1/allocation_meters | |
AllocationMeter | GET | /evmos/incentives/v1/allocation_meters/{denom} | |
Params | GET | /evmos/incentives/v1/params |
evmos/incentives/v1/genesis.proto
TopGenesisState
GenesisState defines the module's genesis state.
Field | Type | Label | Description |
params | Params | module parameters |
|
incentives | Incentive | repeated | active incentives |
gas_meters | GasMeter | repeated | active Gasmeters |
Params
Params defines the incentives module params
Field | Type | Label | Description |
enable_incentives | bool | parameter to enable incentives |
|
allocation_limit | string | maximum percentage an incentive can allocate per denomination |
|
incentives_epoch_identifier | string | identifier for the epochs module hooks |
|
reward_scaler | string | scaling factor for capping rewards |
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 |