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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
use schemars::JsonSchema; use serde::{Deserialize, Serialize}; use crate::addresses::Addr; use crate::binary::Binary; use crate::coins::Coin; #[cfg(feature = "stargate")] use crate::ibc::IbcQuery; use crate::math::Decimal; use crate::results::Empty; #[non_exhaustive] #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum QueryRequest<C: CustomQuery> { Bank(BankQuery), Custom(C), Staking(StakingQuery), /// A Stargate query encoded the same way as abci_query, with path and protobuf encoded Data. /// The format is defined in [ADR-21](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/adr-021-protobuf-query-encoding.md) /// The response is also protobuf encoded. The caller is responsible for compiling the proper protobuf definitions #[cfg(feature = "stargate")] Stargate { /// this is the fully qualified service path used for routing, /// eg. custom/cosmos_sdk.x.bank.v1.Query/QueryBalance path: String, /// this is the expected protobuf message type (not any), binary encoded data: Binary, }, #[cfg(feature = "stargate")] Ibc(IbcQuery), Wasm(WasmQuery), } #[non_exhaustive] #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum BankQuery { /// This calls into the native bank module for one denomination /// Return value is BalanceResponse Balance { address: String, denom: String }, /// This calls into the native bank module for all denominations. /// Note that this may be much more expensive than Balance and should be avoided if possible. /// Return value is AllBalanceResponse. AllBalances { address: String }, } /// A trait that is required to avoid conflicts with other query types like BankQuery and WasmQuery /// in generic implementations. /// You need to implement it in your custom query type. /// /// # Examples /// /// ``` /// # use cosmwasm_std::CustomQuery; /// # use schemars::JsonSchema; /// # use serde::{Deserialize, Serialize}; /// #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] /// #[serde(rename_all = "snake_case")] /// pub enum MyCustomQuery { /// Ping {}, /// Capitalized { text: String }, /// } /// /// impl CustomQuery for MyCustomQuery {} /// ``` pub trait CustomQuery: Serialize {} impl CustomQuery for Empty {} #[non_exhaustive] #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum WasmQuery { /// this queries the public API of another contract at a known address (with known ABI) /// return value is whatever the contract returns (caller should know) Smart { contract_addr: String, /// msg is the json-encoded QueryMsg struct msg: Binary, }, /// this queries the raw kv-store of the contract. /// returns the raw, unparsed data stored at that key, which may be an empty vector if not present Raw { contract_addr: String, /// Key is the raw key used in the contracts Storage key: Binary, }, } impl<C: CustomQuery> From<BankQuery> for QueryRequest<C> { fn from(msg: BankQuery) -> Self { QueryRequest::Bank(msg) } } impl<C: CustomQuery> From<C> for QueryRequest<C> { fn from(msg: C) -> Self { QueryRequest::Custom(msg) } } #[cfg(feature = "staking")] impl<C: CustomQuery> From<StakingQuery> for QueryRequest<C> { fn from(msg: StakingQuery) -> Self { QueryRequest::Staking(msg) } } impl<C: CustomQuery> From<WasmQuery> for QueryRequest<C> { fn from(msg: WasmQuery) -> Self { QueryRequest::Wasm(msg) } } #[cfg(feature = "stargate")] impl<C: CustomQuery> From<IbcQuery> for QueryRequest<C> { fn from(msg: IbcQuery) -> Self { QueryRequest::Ibc(msg) } } #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] #[serde(rename_all = "snake_case")] pub struct BalanceResponse { /// Always returns a Coin with the requested denom. /// This may be of 0 amount if no such funds. pub amount: Coin, } #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] #[serde(rename_all = "snake_case")] pub struct AllBalanceResponse { /// Returns all non-zero coins held by this account. pub amount: Vec<Coin>, } #[cfg(feature = "stargate")] #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] pub struct StargateResponse { /// This is the protobuf response, binary encoded. /// The caller is responsible for knowing how to parse. pub response: Binary, } #[non_exhaustive] #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, 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 registered Validators on the system Validators {}, } /// BondedDenomResponse is data format returned from StakingRequest::BondedDenom query #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, 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, 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, JsonSchema)] pub struct Delegation { pub delegator: Addr, pub validator: Addr, /// 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, 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, JsonSchema)] pub struct FullDelegation { pub delegator: Addr, pub validator: Addr, /// 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>, } /// ValidatorsResponse is data format returned from StakingRequest::Validators query #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] pub struct ValidatorsResponse { pub validators: Vec<Validator>, } /// Instances are created in the querier. #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)] pub struct Validator { pub address: Addr, pub commission: Decimal, pub max_commission: Decimal, /// TODO: what units are these (in terms of time)? pub max_change_rate: Decimal, }