1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
#![cfg(feature = "staking")]
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use crate::{Addr, Coin, Decimal};
#[non_exhaustive]
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum StakingQuery {
/// Returns the denomination that can be bonded (if there are multiple native tokens on the chain)
BondedDenom {},
/// AllDelegations will return all delegations by the delegator
AllDelegations { delegator: String },
/// Delegation will return more detailed info on a particular
/// delegation, defined by delegator/validator pair
Delegation {
delegator: String,
validator: String,
},
/// Returns all validators in the currently active validator set.
///
/// The query response type is `AllValidatorsResponse`.
AllValidators {},
/// Returns the validator at the given address. Returns None if the validator is
/// not part of the currently active validator set.
///
/// The query response type is `ValidatorResponse`.
Validator {
/// The validator's address (e.g. (e.g. cosmosvaloper1...))
address: String,
},
}
/// BondedDenomResponse is data format returned from StakingRequest::BondedDenom query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct BondedDenomResponse {
pub denom: String,
}
/// DelegationsResponse is data format returned from StakingRequest::AllDelegations query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct AllDelegationsResponse {
pub delegations: Vec<Delegation>,
}
/// Delegation is basic (cheap to query) data about a delegation.
///
/// Instances are created in the querier.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
pub struct Delegation {
pub delegator: Addr,
/// A validator address (e.g. cosmosvaloper1...)
pub validator: String,
/// How much we have locked in the delegation
pub amount: Coin,
}
impl From<FullDelegation> for Delegation {
fn from(full: FullDelegation) -> Self {
Delegation {
delegator: full.delegator,
validator: full.validator,
amount: full.amount,
}
}
}
/// DelegationResponse is data format returned from StakingRequest::Delegation query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct DelegationResponse {
pub delegation: Option<FullDelegation>,
}
/// FullDelegation is all the info on the delegation, some (like accumulated_reward and can_redelegate)
/// is expensive to query.
///
/// Instances are created in the querier.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
pub struct FullDelegation {
pub delegator: Addr,
/// A validator address (e.g. cosmosvaloper1...)
pub validator: String,
/// How much we have locked in the delegation
pub amount: Coin,
/// can_redelegate captures how much can be immediately redelegated.
/// 0 is no redelegation and can_redelegate == amount is redelegate all
/// but there are many places between the two
pub can_redelegate: Coin,
/// How much we can currently withdraw
pub accumulated_rewards: Vec<Coin>,
}
/// The data format returned from StakingRequest::AllValidators query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
pub struct AllValidatorsResponse {
pub validators: Vec<Validator>,
}
/// The data format returned from StakingRequest::Validator query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
pub struct ValidatorResponse {
pub validator: Option<Validator>,
}
/// Instances are created in the querier.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
pub struct Validator {
/// A validator address (e.g. cosmosvaloper1...)
pub address: String,
pub commission: Decimal,
pub max_commission: Decimal,
/// TODO: what units are these (in terms of time)?
pub max_change_rate: Decimal,
}