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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use crate::prelude::*;
use crate::{Addr, Coin, Decimal};
use super::query_response::QueryResponseType;
#[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")]
#[non_exhaustive]
pub struct BondedDenomResponse {
pub denom: String,
}
impl QueryResponseType for BondedDenomResponse {}
impl_response_constructor!(BondedDenomResponse, denom: String);
/// DelegationsResponse is data format returned from StakingRequest::AllDelegations query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub struct AllDelegationsResponse {
pub delegations: Vec<Delegation>,
}
impl QueryResponseType for AllDelegationsResponse {}
impl_response_constructor!(AllDelegationsResponse, 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)]
#[non_exhaustive]
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_response_constructor!(Delegation, delegator: Addr, validator: String, 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")]
#[non_exhaustive]
pub struct DelegationResponse {
pub delegation: Option<FullDelegation>,
}
impl QueryResponseType for DelegationResponse {}
impl_response_constructor!(DelegationResponse, 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)]
#[non_exhaustive]
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>,
}
impl_response_constructor!(
FullDelegation,
delegator: Addr,
validator: String,
amount: Coin,
can_redelegate: Coin,
accumulated_rewards: Vec<Coin>
);
impl FullDelegation {
/// Creates a new delegation.
///
/// If fields get added to the [`FullDelegation`] struct in the future, this constructor will
/// provide default values for them, but these default values may not be sensible.
pub fn create(
delegator: Addr,
validator: String,
amount: Coin,
can_redelegate: Coin,
accumulated_rewards: Vec<Coin>,
) -> Self {
Self {
delegator,
validator,
amount,
can_redelegate,
accumulated_rewards,
}
}
}
/// The data format returned from StakingRequest::AllValidators query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[non_exhaustive]
pub struct AllValidatorsResponse {
pub validators: Vec<Validator>,
}
impl QueryResponseType for AllValidatorsResponse {}
impl_response_constructor!(AllValidatorsResponse, validators: Vec<Validator>);
/// The data format returned from StakingRequest::Validator query
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[non_exhaustive]
pub struct ValidatorResponse {
pub validator: Option<Validator>,
}
impl QueryResponseType for ValidatorResponse {}
impl_response_constructor!(ValidatorResponse, validator: Option<Validator>);
/// Instances are created in the querier.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[non_exhaustive]
pub struct Validator {
/// The operator address of the validator (e.g. cosmosvaloper1...).
/// See https://github.com/cosmos/cosmos-sdk/blob/v0.47.4/proto/cosmos/staking/v1beta1/staking.proto#L95-L96
/// for more information.
///
/// This uses `String` instead of `Addr` since the bech32 address prefix is different from
/// the ones that regular user accounts use.
pub address: String,
pub commission: Decimal,
pub max_commission: Decimal,
/// The maximum daily increase of the commission
pub max_change_rate: Decimal,
}
impl_response_constructor!(
Validator,
address: String,
commission: Decimal,
max_commission: Decimal,
max_change_rate: Decimal
);
impl Validator {
/// Creates a new validator.
///
/// If fields get added to the [`Validator`] struct in the future, this constructor will
/// provide default values for them, but these default values may not be sensible.
pub fn create(
address: String,
commission: Decimal,
max_commission: Decimal,
max_change_rate: Decimal,
) -> Self {
Self {
address,
commission,
max_commission,
max_change_rate,
}
}
}