package confio.poe.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
tx.proto:15Msg defines the staking Msg service.
rpc CreateValidator (, )
tx.proto:17CreateValidator defines a method for creating a new validator.
message
tx.proto:31MsgCreateValidator defines a PoE message for creating a new validator. Based on the SDK staking.MsgCreateValidator
optional description = 1
Description meta data
string operator_address = 4
OperatorAddress is the bech32 address string
optional pubkey = 6
Pubkey public key
optional amount = 7
Amount defines the initial staking amount from a liquid balance
optional vesting_amount = 8
VestingAmount defines the initial staking amount from a vesting account balance
message
tx.proto:55MsgCreateValidatorResponse defines the MsgCreateValidator response type.
(message has no fields)
rpc Delegate (, )
tx.proto:22Delegate defines a method for performing a self delegation of coins by a node operator
message
tx.proto:77MsgDelegate defines a SDK message for performing a self delegation of coins by a node operator
string operator_address = 1
optional amount = 2
optional vesting_amount = 3
message
tx.proto:88MsgDelegateResponse defines the Msg/Delegate response type.
(message has no fields)
rpc Undelegate (, )
tx.proto:26Undelegate defines a method for performing an undelegation from a node operator
message
tx.proto:92MsgUndelegate defines a SDK message for performing an undelegation from a node operator
string operator_address = 1
optional amount = 2
message
tx.proto:102MsgUndelegateResponse defines the Msg/Undelegate response type.
optional completion_time = 1
rpc UpdateValidator (, )
tx.proto:19MsgCreateValidator defines a method for updating validator metadata
message
tx.proto:58MsgCreateValidator defines a PoE message for updating validator metadata
optional description = 1
New Description meta data
string operator_address = 2
OperatorAddress is the bech32 address string Also know as "signer" in other messages
message
tx.proto:73MsgUpdateValidatorResponse defines the MsgUpdateValidator response type.
(message has no fields)
service Query
query.proto:16Query defines the gRPC querier service.
rpc ContractAddress (, )
query.proto:18ContractAddress queries the address for one of the PoE contracts
message
query.proto:80QueryContractAddressRequest is the request type for the Query/ContractAddress RPC method.
PoEContractType contract_type = 1
ContractType is the type of contract
message
query.proto:90QueryContractAddressRequest is the response type for the Query/ContractAddress RPC method.
string address = 1
rpc HistoricalInfo (, )
query.proto:57HistoricalInfo queries the historical info for given height.
rpc UnbondingPeriod (, )
query.proto:37Validator queries validator info for given validator address.
message
query.proto:94QueryUnbondingPeriodRequest is request type for the Query/UnbondingPeriod RPC method
(message has no fields)
message
query.proto:98QueryUnbondingPeriodResponse is response type for the Query/UnbondingPeriod RPC method
optional time = 1
Time is the time that must pass
rpc Validator (, )
query.proto:31Validator queries validator info for given validator address.
rpc ValidatorDelegation (, )
query.proto:43ValidatorDelegation queries self delegated amount for given validator.
message
query.proto:106QueryValidatorDelegationRequest is request type for the Query/ValidatorDelegation RPC method
string validator_addr = 1
validator_addr defines the validator address to query for.
message
query.proto:113QueryValidatorDelegationResponse is response type for the Query/ValidatorDelegation RPC method
optional balance = 1
ValidatorEngagementReward queries rewards of a validator address.
message
query.proto:156QueryValidatorEngagementRewardRequest is the request type for the Query/ValidatorEngagementReward RPC method.
string validator_address = 1
validator_address defines the validator address to query for.
message
query.proto:163QueryValidatorEngagementRewardResponse is the response type for the Query/ValidatorEngagementReward RPC method.
optional reward = 1
ValidatorOutstandingRewards queries rewards of a validator address.
message
query.proto:139QueryValidatorOutstandingRewardRequest is the request type for the Query/ValidatorOutstandingReward RPC method.
string validator_address = 1
validator_address defines the validator address to query for.
message
query.proto:146QueryValidatorOutstandingRewardResponse is the response type for the Query/ValidatorOutstandingReward RPC method.
optional reward = 1
ValidatorUnbondingDelegations queries unbonding delegations of a validator.
message
query.proto:119QueryValidatorUnbondingDelegationsRequest is required type for the Query/ValidatorUnbondingDelegations RPC method
string validator_addr = 1
validator_addr defines the validator address to query for.
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:129QueryValidatorUnbondingDelegationsResponse is response type for the Query/ValidatorUnbondingDelegations RPC method.
repeated entries = 1
unbonding delegation entries
optional pagination = 2
pagination defines the pagination in the response.
rpc Validators (, )
query.proto:25Validators queries all validators that match the given status.
message
genesis.proto:256ArbiterPoolContractConfig initial setup config for the trusted circle
Used in:
string name = 1
Name of TRUSTED_CIRCLE
optional escrow_amount = 2
EscrowAmount The required escrow amount, in the default denom (utgd)
optional voting_rules = 3
VotingRules rules for the tally
string deny_list_contract_address = 4
DenyListContractAddress is an optional cw4 contract with list of addresses denied to be part of TrustedCircle
optional dispute_cost = 5
DisputeCost The required dispute amount, in the default denom (utgd)
optional waiting_period = 6
message
genesis.proto:209CommunityPoolContractConfig initial setup config for the contract
Used in:
optional voting_rules = 1
VotingRules rules for the tally
message
genesis.proto:188EngagementContractConfig initial setup config
Used in:
optional halflife = 1
message
genesis.proto:13GenesisState - initial state of module
optional params = 1
params defines all the parameter of the module
oneof setup_mode
SetupMode defines which scenario to apply on a genesis import. Either it is a fresh chain that needs PoE contracts bootstrapped or the module state has to be restored from a previous state dump.
seed_contracts = 2
SeedContracts stores and instantiates the Proof of Engagement contracts on the chain.
import_dump = 3
ImportDump restores the state from an exported state genesis
message
genesis.proto:31ImportDump has all module data for non seed mode.
Used in:
repeated contracts = 1
Contracts PoE contract addresses and types
message
genesis.proto:97Mixer contract setup. See https://github.com/confio/poe-contracts/tree/main/contracts/tg4-mixer
Used in:
optional sigmoid = 1
Sigmoid returns a sigmoid-like value of staked amount times engagement points. See the Proof-of-Engagement white-paper for details.
message
genesis.proto:98Used in:
uint64 max_points = 1
string p = 2
string s = 3
message
genesis.proto:194OversightCommitteeContractConfig initial setup config for the trusted circle
Used in:
string name = 1
Name of TRUSTED_CIRCLE
optional escrow_amount = 2
EscrowAmount The required escrow amount, in the default denom (utgd)
optional voting_rules = 3
VotingRules rules for the tally
string deny_list_contract_address = 4
DenyListContractAddress is an optional cw4 contract with list of addresses denied to be part of TrustedCircle
message
poe.proto:44Params defines the parameters for the PoE module.
Used in:
uint32 historical_entries = 1
HistoricalEntries is the number of historical entries to persist.
uint64 initial_val_engagement_points = 2
InitialValEngagementPoints defines the number of engagement for any new validator joining post genesis
repeated min_delegation_amounts = 3
MinDelegationAmount defines the minimum amount a post genesis validator needs to self delegate to receive any engagement points. One must be exceeded. No minimum condition set when empty.
message
genesis.proto:221PoEContract address and type information
Used in:
PoEContractType contract_type = 1
ContractType type.
string address = 2
Address is the bech32 address string
PoEContractType type of PoE contract
Used in: ,
UNDEFINED = 0
STAKING = 1
VALSET = 2
ENGAGEMENT = 3
MIXER = 4
DISTRIBUTION = 5
OVERSIGHT_COMMUNITY = 6
OVERSIGHT_COMMUNITY_PROPOSALS = 7
COMMUNITY_POOL = 8
VALIDATOR_VOTING = 9
ARBITER_POOL = 10
ARBITER_POOL_VOTING = 11
message
genesis.proto:41SeedContracts contains the contract configuration and group members to setup all PoE contracts on chain.
Used in:
repeated bytes gen_txs = 1
GenTxs defines the genesis transactions to create a validator.
string bootstrap_account_address = 2
BootstrapAccountAddress single address that is set as bootstrap-account for the PoE contracts in seed mode.
repeated engagement = 3
Engagement weighted members of the engagement group. Validators should be in here.
optional stake_contract_config = 4
optional valset_contract_config = 5
optional engagement_contract_config = 6
string bond_denom = 7
BondDenom defines the bondable coin denomination.
optional oversight_committee_contract_config = 8
optional community_pool_contract_config = 9
optional validator_voting_contract_config = 10
repeated string oversight_community_members = 11
repeated string arbiter_pool_members = 12
optional arbiter_pool_contract_config = 13
optional mixer_contract_config = 14
message
genesis.proto:115StakeContractConfig initial setup config
Used in:
uint64 min_bond = 1
uint64 tokens_per_point = 2
optional unbonding_period = 3
uint32 claim_autoreturn_limit = 4
message
genesis.proto:229TG4Member member of the Engagement group.
Used in:
string address = 1
Address is the bech32 address string
uint64 points = 2
message
genesis.proto:215ValidatorVotingContractConfig CommunityPoolContractConfig
Used in:
optional voting_rules = 1
VotingRules rules for the tally
message
genesis.proto:124ValsetContractConfig initial setup config
Used in:
uint64 min_points = 1
uint32 max_validators = 2
MaxValidators The maximum number of validators that can be included in the Tendermint validator set.
optional epoch_length = 3
EpochLength We update the Tendermint validator set only once per epoch. Epoch # is env.block.time/epoch_length (round down). The first block with a new epoch number will trigger a new validator calculation.
optional epoch_reward = 4
uint32 scaling = 5
Scaling is the factor to multiply cw4-group weights to produce the Tendermint validator power
string fee_percentage = 6
FeePercentage is the percentage of total accumulated fees that is subtracted from tokens minted as rewards. 50% by default. To disable this feature just set it to 0 (which effectively means that fees don't affect the per-epoch reward).
string community_pool_reward_ratio = 7
CommunityPoolRewardRation in percentage
string engagement_reward_ratio = 8
EngagementRewardRatio reward ration in percentage for all
string validator_reward_ratio = 9
ValidatorRewardRation in percentage for all
bool auto_unjail = 10
AutoUnjail if set to true, we will auto-unjail any validator after their jailtime is over.
string double_sign_slash_ratio = 11
DoubleSignSlashRatio Validators who are caught double signing are jailed forever and their bonded tokens are slashed based on this value.
bool verify_validators = 12
When a validator joins the valset, verify they sign the first block since joining or jail them for a period otherwise. The verification happens every time the validator becomes an active validator, including when they are unjailed or when they just gain enough power to participate.
optional offlineJailDuration = 13
OfflineJailDuration duration to jail a validator for in case they don't sign their first epoch boundary block. After the period, they have to pass verification again, ad infinitum.
message
genesis.proto:236VotingRules contains configuration for the tally.
Used in: , , ,
uint32 voting_period = 1
VotingPeriod Voting period in days
string quorum = 2
Quorum voting quorum percentage (1-100)
string threshold = 3
Threshold voting threshold percentage (50-100)
bool allow_end_early = 4
AllowEndEarly If true, and absolute threshold and quorum are met, we can end before voting period finished. (Recommended value: true, unless you have special needs)