evmos/revenue
Table of Contents
evmos/revenue/v1/revenue.proto
TopRevenue
Revenue defines an instance that organizes fee distribution conditions for
the owner of a given smart contract
Field | Type | Label | Description |
contract_address | string | hex address of registered contract |
|
deployer_address | string | bech32 address of contract deployer |
|
withdrawer_address | string | bech32 address of account receiving the transaction fees it defaults to deployer_address |
evmos/revenue/v1/query.proto
TopQueryDeployerRevenuesRequest
QueryDeployerRevenuesRequest is the request type for the
Query/DeployerRevenues RPC method.
Field | Type | Label | Description |
deployer_address | string | deployer bech32 address |
|
pagination | cosmos.base.query.v1beta1.PageRequest | pagination defines an optional pagination for the request. |
QueryDeployerRevenuesResponse
QueryDeployerRevenuesResponse is the response type for the
Query/DeployerRevenues RPC method.
Field | Type | Label | Description |
contract_addresses | string | 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 |
|
QueryRevenueRequest
QueryRevenueRequest is the request type for the Query/Revenue RPC method.
Field | Type | Label | Description |
contract_address | string | contract identifier is the hex contract address of a contract |
QueryRevenueResponse
QueryRevenueResponse is the response type for the Query/Revenue RPC method.
Field | Type | Label | Description |
revenue | Revenue |
|
QueryRevenuesRequest
QueryRevenuesRequest is the request type for the Query/Revenues RPC method.
Field | Type | Label | Description |
pagination | cosmos.base.query.v1beta1.PageRequest | pagination defines an optional pagination for the request. |
QueryRevenuesResponse
QueryRevenuesResponse is the response type for the Query/Revenues RPC method.
Field | Type | Label | Description |
revenues | Revenue | repeated |
|
pagination | cosmos.base.query.v1beta1.PageResponse | pagination defines the pagination in the response. |
QueryWithdrawerRevenuesRequest
QueryWithdrawerRevenuesRequest is the request type for the
Query/WithdrawerRevenues RPC method.
Field | Type | Label | Description |
withdrawer_address | string | withdrawer bech32 address |
|
pagination | cosmos.base.query.v1beta1.PageRequest | pagination defines an optional pagination for the request. |
QueryWithdrawerRevenuesResponse
QueryWithdrawerRevenuesResponse is the response type for the
Query/WithdrawerRevenues RPC method.
Field | Type | Label | Description |
contract_addresses | string | repeated |
|
pagination | cosmos.base.query.v1beta1.PageResponse | pagination defines the pagination in the response. |
Query
Query defines the gRPC querier service.
Method Name | Request Type | Response Type | Description |
Revenues | QueryRevenuesRequest | QueryRevenuesResponse | Revenues retrieves all registered revenues |
Revenue | QueryRevenueRequest | QueryRevenueResponse | Revenue retrieves a registered revenue for a given contract address |
Params | QueryParamsRequest | QueryParamsResponse | Params retrieves the revenue module params |
DeployerRevenues | QueryDeployerRevenuesRequest | QueryDeployerRevenuesResponse | DeployerRevenues retrieves all revenues that a given deployer has registered |
WithdrawerRevenues | QueryWithdrawerRevenuesRequest | QueryWithdrawerRevenuesResponse | WithdrawerRevenues retrieves all revenues with a given withdrawer address |
Methods with HTTP bindings
Method Name | Method | Pattern | Body |
Revenues | GET | /evmos/revenue/v1/revenues | |
Revenue | GET | /evmos/revenue/v1/revenues/{contract_address} | |
Params | GET | /evmos/revenue/v1/params | |
DeployerRevenues | GET | /evmos/revenue/v1/revenues/{deployer_address} | |
WithdrawerRevenues | GET | /evmos/revenue/v1/revenues/{withdrawer_address} |
evmos/revenue/v1/genesis.proto
TopGenesisState
GenesisState defines the module's genesis state.
Field | Type | Label | Description |
params | Params | module parameters |
|
revenues | Revenue | repeated | active registered contracts for fee distribution |
Params
Params defines the revenue module params
Field | Type | Label | Description |
enable_revenue | bool | enable_revenue defines a parameter to enable the revenue module |
|
developer_shares | string | developer_shares defines the proportion of the transaction fees to be distributed to the registered contract owner |
|
addr_derivation_cost_create | uint64 | addr_derivation_cost_create defines the cost of address derivation for verifying the contract deployer at fee registration |
evmos/revenue/v1/tx.proto
TopMsgCancelRevenue
MsgCancelRevenue defines a message that cancels a registered Revenue
Field | Type | Label | Description |
contract_address | string | contract hex address |
|
deployer_address | string | deployer bech32 address |
MsgCancelRevenueResponse
MsgCancelRevenueResponse defines the MsgCancelRevenue response type
MsgRegisterRevenue
MsgRegisterRevenue defines a message that registers a Revenue
Field | Type | Label | Description |
contract_address | string | contract hex address |
|
deployer_address | string | bech32 address of message sender, must be the same as the origin EOA sending the transaction which deploys the contract |
|
withdrawer_address | string | bech32 address of account receiving the transaction fees |
|
nonces | uint64 | repeated | array of nonces from the address path, where the last nonce is the nonce that determines the contract's address - it can be an EOA nonce or a factory contract nonce |
MsgRegisterRevenueResponse
MsgRegisterRevenueResponse defines the MsgRegisterRevenue response type
MsgUpdateRevenue
MsgUpdateRevenue defines a message that updates the withdrawer address for a
registered Revenue
Field | Type | Label | Description |
contract_address | string | contract hex address |
|
deployer_address | string | deployer bech32 address |
|
withdrawer_address | string | new withdrawer bech32 address for receiving the transaction fees |
MsgUpdateRevenueResponse
MsgUpdateRevenueResponse defines the MsgUpdateRevenue response type
Msg
Msg defines the fees Msg service.
Method Name | Request Type | Response Type | Description |
RegisterRevenue | MsgRegisterRevenue | MsgRegisterRevenueResponse | RegisterRevenue registers a new contract for receiving transaction fees |
UpdateRevenue | MsgUpdateRevenue | MsgUpdateRevenueResponse | UpdateRevenue updates the withdrawer address of a revenue |
CancelRevenue | MsgCancelRevenue | MsgCancelRevenueResponse | CancelRevenue cancels a contract's fee registration and further receival of transaction fees |
Methods with HTTP bindings
Method Name | Method | Pattern | Body |
RegisterRevenue | POST | /evmos/revenue/v1/tx/register_revenue | |
UpdateRevenue | POST | /evmos/revenue/v1/tx/update_revenue | |
CancelRevenue | POST | /evmos/revenue/v1/tx/cancel_revenue |
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 |