Merge pull request #2501 from CosmWasm/co/separate-validator-types

Split Validator type for better extensibility in the future

Author: chipshort

CHANGELOG.md

@@ -94,6 +94,9 @@ and this project adheres to
 - cosmwasm-vm: Enable partial reference-type support, enabling contracts
   compiled with Rust 1.82 or newer to be stored. ([#2473])
 - cosmwasm-std: Removed IBC fees ([#2479])
+- cosmwasm-std: Split up `Validator` type into `Validator` and
+  `ValidatorMetadata` to allow adding more fields to `ValidatorResponse` in the
+  future. ([#2501])
 
 ## Fixed
 
@@ -141,6 +144,7 @@ and this project adheres to
 [#2479]: https://github.com/CosmWasm/cosmwasm/pull/2479
 [#2480]: https://github.com/CosmWasm/cosmwasm/pull/2480
 [#2484]: https://github.com/CosmWasm/cosmwasm/pull/2484
+[#2501]: https://github.com/CosmWasm/cosmwasm/pull/2501
 
 ## [2.2.0] - 2024-12-17
 

packages/go-gen/tests/cosmwasm_std__AllValidatorsResponse.go

@@ -1,9 +1,9 @@
 // AllValidatorsResponse is the expected response to AllValidatorsQuery
 type AllValidatorsResponse struct {
-	Validators Array[Validator] `json:"validators"`
+	Validators Array[ValidatorMetadata] `json:"validators"`
 }
 
-type Validator struct {
+type ValidatorMetadata struct {
 	Address string `json:"address"`
 	// decimal string, eg "0.02"
 	Commission string `json:"commission"`

packages/std/src/query/staking.rs

@@ -152,12 +152,12 @@ impl FullDelegation {
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 #[non_exhaustive]
 pub struct AllValidatorsResponse {
-    pub validators: Vec<Validator>,
+    pub validators: Vec<ValidatorMetadata>,
 }
 
 impl QueryResponseType for AllValidatorsResponse {}
 
-impl_hidden_constructor!(AllValidatorsResponse, validators: Vec<Validator>);
+impl_hidden_constructor!(AllValidatorsResponse, validators: Vec<ValidatorMetadata>);
 
 /// The data format returned from StakingRequest::Validator query
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
@@ -173,7 +173,7 @@ impl_hidden_constructor!(ValidatorResponse, validator: Option<Validator>);
 /// Instances are created in the querier.
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 #[non_exhaustive]
-pub struct Validator {
+pub struct ValidatorMetadata {
     /// 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.
@@ -188,13 +188,30 @@ pub struct Validator {
 }
 
 impl_hidden_constructor!(
-    Validator,
+    ValidatorMetadata,
     address: String,
     commission: Decimal,
     max_commission: Decimal,
     max_change_rate: Decimal
 );
 
+/// 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 Validator {
     /// Creates a new validator.
     ///
@@ -214,3 +231,24 @@ impl Validator {
         }
     }
 }
+
+impl_hidden_constructor!(
+    Validator,
+    address: String,
+    commission: Decimal,
+    max_commission: Decimal,
+    max_change_rate: Decimal
+);
+
+// Validator should contain all data that ValidatorMetadata has + maybe some additional data
+// that is expensive to query, so we can convert ValidatorMetadata to Validator easily.
+impl From<Validator> for ValidatorMetadata {
+    fn from(validator: Validator) -> Self {
+        ValidatorMetadata {
+            address: validator.address,
+            commission: validator.commission,
+            max_commission: validator.max_commission,
+            max_change_rate: validator.max_change_rate,
+        }
+    }
+}

packages/std/src/testing/mock.rs

@@ -1204,7 +1204,7 @@ impl StakingQuerier {
             }
             StakingQuery::AllValidators {} => {
                 let res = AllValidatorsResponse {
-                    validators: self.validators.clone(),
+                    validators: self.validators.iter().cloned().map(Into::into).collect(),
                 };
                 to_json_binary(&res).into()
             }
@@ -2508,7 +2508,7 @@ mod tests {
             .unwrap()
             .unwrap();
         let vals: AllValidatorsResponse = from_json(raw).unwrap();
-        assert_eq!(vals.validators, vec![val1, val2]);
+        assert_eq!(vals.validators, vec![val1.into(), val2.into()]);
     }
 
     #[cfg(feature = "staking")]

packages/std/src/traits.rs

@@ -14,7 +14,8 @@ use crate::query::SupplyResponse;
 #[cfg(feature = "staking")]
 use crate::query::{
     AllDelegationsResponse, AllValidatorsResponse, BondedDenomResponse, Delegation,
-    DelegationResponse, FullDelegation, StakingQuery, Validator, ValidatorResponse,
+    DelegationResponse, FullDelegation, StakingQuery, Validator, ValidatorMetadata,
+    ValidatorResponse,
 };
 #[cfg(feature = "cosmwasm_1_3")]
 use crate::query::{
@@ -593,7 +594,7 @@ impl<'a, C: CustomQuery> QuerierWrapper<'a, C> {
     }
 
     #[cfg(feature = "staking")]
-    pub fn query_all_validators(&self) -> StdResult<Vec<Validator>> {
+    pub fn query_all_validators(&self) -> StdResult<Vec<ValidatorMetadata>> {
         let request = StakingQuery::AllValidators {}.into();
         let res: AllValidatorsResponse = self.query(&request)?;
         Ok(res.validators)