From cf2590089647be78597b73826ff49794d07aabcc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C4=99drzej=20Stuczy=C5=84ski?=
 <jedrzej.stuczynski@gmail.com>
Date: Tue, 5 Dec 2023 17:00:07 +0000
Subject: [PATCH] added support for validator-related queries in staking module

---
 cosmrs/src/staking.rs                         |  22 +++-
 cosmrs/src/staking/commision_rates.rs         |  35 ++++++
 cosmrs/src/staking/commission.rs              |  49 +++++++++
 cosmrs/src/staking/description.rs             |  44 ++++++++
 cosmrs/src/staking/historical_info.rs         |  40 +++++++
 .../staking/query_historical_info_request.rs  |  29 +++++
 .../staking/query_historical_info_response.rs |  34 ++++++
 cosmrs/src/staking/query_validator_request.rs |  28 +++++
 .../src/staking/query_validator_response.rs   |  29 +++++
 .../src/staking/query_validators_request.rs   |  34 ++++++
 .../src/staking/query_validators_response.rs  |  43 ++++++++
 cosmrs/src/staking/validator.rs               | 102 ++++++++++++++++++
 12 files changed, 487 insertions(+), 2 deletions(-)
 create mode 100644 cosmrs/src/staking/commision_rates.rs
 create mode 100644 cosmrs/src/staking/commission.rs
 create mode 100644 cosmrs/src/staking/description.rs
 create mode 100644 cosmrs/src/staking/historical_info.rs
 create mode 100644 cosmrs/src/staking/query_historical_info_request.rs
 create mode 100644 cosmrs/src/staking/query_historical_info_response.rs
 create mode 100644 cosmrs/src/staking/query_validator_request.rs
 create mode 100644 cosmrs/src/staking/query_validator_response.rs
 create mode 100644 cosmrs/src/staking/query_validators_request.rs
 create mode 100644 cosmrs/src/staking/query_validators_response.rs
 create mode 100644 cosmrs/src/staking/validator.rs

diff --git a/cosmrs/src/staking.rs b/cosmrs/src/staking.rs
index 00f91a3b..80ae5dd0 100644
--- a/cosmrs/src/staking.rs
+++ b/cosmrs/src/staking.rs
@@ -2,11 +2,29 @@
 //!
 //! <https://docs.cosmos.network/v0.46/modules/staking/>
 
+mod commision_rates;
+mod commission;
+mod description;
+mod historical_info;
 mod msg_begin_redelegate;
 mod msg_delegate;
 mod msg_undelegate;
+mod query_historical_info_request;
+mod query_historical_info_response;
+mod query_validator_request;
+mod query_validator_response;
+mod query_validators_request;
+mod query_validators_response;
+mod validator;
 
 pub use self::{
-    msg_begin_redelegate::MsgBeginRedelegate, msg_delegate::MsgDelegate,
-    msg_undelegate::MsgUndelegate,
+    commision_rates::CommissionRates, commission::Commission, description::Description,
+    historical_info::HistoricalInfo, msg_begin_redelegate::MsgBeginRedelegate,
+    msg_delegate::MsgDelegate, msg_undelegate::MsgUndelegate,
+    query_historical_info_request::QueryHistoricalInfoRequest,
+    query_historical_info_response::QueryHistoricalInfoResponse,
+    query_validator_request::QueryValidatorRequest,
+    query_validator_response::QueryValidatorResponse,
+    query_validators_request::QueryValidatorsRequest,
+    query_validators_response::QueryValidatorsResponse, validator::Validator,
 };
diff --git a/cosmrs/src/staking/commision_rates.rs b/cosmrs/src/staking/commision_rates.rs
new file mode 100644
index 00000000..ec8a3ce6
--- /dev/null
+++ b/cosmrs/src/staking/commision_rates.rs
@@ -0,0 +1,35 @@
+use crate::proto;
+
+/// CommissionRates defines the initial commission rates to be used for creating
+/// a validator.
+#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
+pub struct CommissionRates {
+    /// rate is the commission rate charged to delegators, as a fraction.
+    pub rate: String,
+
+    /// max_rate defines the maximum commission rate which validator can ever charge, as a fraction.
+    pub max_rate: String,
+
+    /// max_change_rate defines the maximum daily increase of the validator commission, as a fraction.
+    pub max_change_rate: String,
+}
+
+impl From<proto::cosmos::staking::v1beta1::CommissionRates> for CommissionRates {
+    fn from(proto: cosmos_sdk_proto::cosmos::staking::v1beta1::CommissionRates) -> Self {
+        CommissionRates {
+            rate: proto.rate,
+            max_rate: proto.max_rate,
+            max_change_rate: proto.max_change_rate,
+        }
+    }
+}
+
+impl From<CommissionRates> for proto::cosmos::staking::v1beta1::CommissionRates {
+    fn from(commission_rates: CommissionRates) -> Self {
+        proto::cosmos::staking::v1beta1::CommissionRates {
+            rate: commission_rates.rate,
+            max_rate: commission_rates.max_rate,
+            max_change_rate: commission_rates.max_change_rate,
+        }
+    }
+}
diff --git a/cosmrs/src/staking/commission.rs b/cosmrs/src/staking/commission.rs
new file mode 100644
index 00000000..67471f2c
--- /dev/null
+++ b/cosmrs/src/staking/commission.rs
@@ -0,0 +1,49 @@
+use crate::staking::CommissionRates;
+use crate::{proto, ErrorReport, Result};
+use cosmos_sdk_proto::Timestamp;
+use tendermint::Time;
+
+/// Commission defines commission parameters for a given validator.
+#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
+pub struct Commission {
+    /// commission_rates defines the initial commission rates to be used for creating a validator.
+    pub commission_rates: Option<CommissionRates>,
+
+    /// update_time is the last time the commission rate was changed.
+    pub update_time: Option<Time>,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::Commission> for Commission {
+    type Error = ErrorReport;
+
+    fn try_from(proto: cosmos_sdk_proto::cosmos::staking::v1beta1::Commission) -> Result<Self> {
+        Ok(Commission {
+            commission_rates: proto.commission_rates.map(Into::into),
+            update_time: proto
+                .update_time
+                .map(|jailed_until| {
+                    cosmos_sdk_proto::tendermint::google::protobuf::Timestamp {
+                        seconds: jailed_until.seconds,
+                        nanos: jailed_until.nanos,
+                    }
+                    .try_into()
+                })
+                .transpose()?,
+        })
+    }
+}
+
+impl From<Commission> for proto::cosmos::staking::v1beta1::Commission {
+    fn from(commission: Commission) -> Self {
+        proto::cosmos::staking::v1beta1::Commission {
+            commission_rates: commission.commission_rates.map(Into::into),
+            update_time: commission
+                .update_time
+                .map(cosmos_sdk_proto::tendermint::google::protobuf::Timestamp::from)
+                .map(|t| Timestamp {
+                    seconds: t.seconds,
+                    nanos: t.nanos,
+                }),
+        }
+    }
+}
diff --git a/cosmrs/src/staking/description.rs b/cosmrs/src/staking/description.rs
new file mode 100644
index 00000000..e1dbf948
--- /dev/null
+++ b/cosmrs/src/staking/description.rs
@@ -0,0 +1,44 @@
+use crate::proto;
+
+/// Description defines a validator description.
+#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
+pub struct Description {
+    /// moniker defines a human-readable name for the validator.
+    pub moniker: String,
+
+    /// identity defines an optional identity signature (ex. UPort or Keybase).
+    pub identity: String,
+
+    /// website defines an optional website link.
+    pub website: String,
+
+    /// security_contact defines an optional email for security contact.
+    pub security_contact: String,
+
+    /// details define other optional details.
+    pub details: String,
+}
+
+impl From<proto::cosmos::staking::v1beta1::Description> for Description {
+    fn from(proto: cosmos_sdk_proto::cosmos::staking::v1beta1::Description) -> Self {
+        Description {
+            moniker: proto.moniker,
+            identity: proto.identity,
+            website: proto.website,
+            security_contact: proto.security_contact,
+            details: proto.details,
+        }
+    }
+}
+
+impl From<Description> for proto::cosmos::staking::v1beta1::Description {
+    fn from(description: Description) -> Self {
+        proto::cosmos::staking::v1beta1::Description {
+            moniker: description.moniker,
+            identity: description.identity,
+            website: description.website,
+            security_contact: description.security_contact,
+            details: description.details,
+        }
+    }
+}
diff --git a/cosmrs/src/staking/historical_info.rs b/cosmrs/src/staking/historical_info.rs
new file mode 100644
index 00000000..be3865a9
--- /dev/null
+++ b/cosmrs/src/staking/historical_info.rs
@@ -0,0 +1,40 @@
+use crate::staking::Validator;
+use crate::{proto, ErrorReport, Result};
+use tendermint::block::Header;
+
+/// HistoricalInfo contains header and validator information for a given block.
+/// It is stored as part of staking module's state, which persists the `n` most
+/// recent HistoricalInfo
+/// (`n` is set by the staking module's `historical_entries` parameter).
+#[derive(Clone, Debug, PartialEq)]
+pub struct HistoricalInfo {
+    /// Header of the block
+    pub header: Option<Header>,
+
+    /// The validator set at the block
+    pub valset: Vec<Validator>,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::HistoricalInfo> for HistoricalInfo {
+    type Error = ErrorReport;
+
+    fn try_from(proto: cosmos_sdk_proto::cosmos::staking::v1beta1::HistoricalInfo) -> Result<Self> {
+        Ok(HistoricalInfo {
+            header: proto.header.map(TryInto::try_into).transpose()?,
+            valset: proto
+                .valset
+                .into_iter()
+                .map(TryInto::try_into)
+                .collect::<Result<_>>()?,
+        })
+    }
+}
+
+impl From<HistoricalInfo> for proto::cosmos::staking::v1beta1::HistoricalInfo {
+    fn from(historical_info: HistoricalInfo) -> Self {
+        proto::cosmos::staking::v1beta1::HistoricalInfo {
+            header: historical_info.header.map(Into::into),
+            valset: historical_info.valset.into_iter().map(Into::into).collect(),
+        }
+    }
+}
diff --git a/cosmrs/src/staking/query_historical_info_request.rs b/cosmrs/src/staking/query_historical_info_request.rs
new file mode 100644
index 00000000..6225c4ee
--- /dev/null
+++ b/cosmrs/src/staking/query_historical_info_request.rs
@@ -0,0 +1,29 @@
+use crate::proto;
+
+/// QueryHistoricalInfoRequest is request type for the Query/HistoricalInfo RPC
+/// method.
+#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
+pub struct QueryHistoricalInfoRequest {
+    /// height defines at which height to query the historical info.
+    pub height: i64,
+}
+
+impl From<proto::cosmos::staking::v1beta1::QueryHistoricalInfoRequest>
+    for QueryHistoricalInfoRequest
+{
+    fn from(proto: cosmos_sdk_proto::cosmos::staking::v1beta1::QueryHistoricalInfoRequest) -> Self {
+        QueryHistoricalInfoRequest {
+            height: proto.height,
+        }
+    }
+}
+
+impl From<QueryHistoricalInfoRequest>
+    for proto::cosmos::staking::v1beta1::QueryHistoricalInfoRequest
+{
+    fn from(query_historical_info_request: QueryHistoricalInfoRequest) -> Self {
+        proto::cosmos::staking::v1beta1::QueryHistoricalInfoRequest {
+            height: query_historical_info_request.height,
+        }
+    }
+}
diff --git a/cosmrs/src/staking/query_historical_info_response.rs b/cosmrs/src/staking/query_historical_info_response.rs
new file mode 100644
index 00000000..9988cbcd
--- /dev/null
+++ b/cosmrs/src/staking/query_historical_info_response.rs
@@ -0,0 +1,34 @@
+use crate::staking::HistoricalInfo;
+use crate::{proto, ErrorReport, Result};
+
+/// QueryHistoricalInfoResponse is response type for the Query/HistoricalInfo RPC
+/// method.
+#[derive(Clone, Debug, PartialEq)]
+pub struct QueryHistoricalInfoResponse {
+    /// hist defines the historical info at the given height.
+    pub hist: Option<HistoricalInfo>,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::QueryHistoricalInfoResponse>
+    for QueryHistoricalInfoResponse
+{
+    type Error = ErrorReport;
+
+    fn try_from(
+        proto: cosmos_sdk_proto::cosmos::staking::v1beta1::QueryHistoricalInfoResponse,
+    ) -> Result<Self> {
+        Ok(QueryHistoricalInfoResponse {
+            hist: proto.hist.map(TryInto::try_into).transpose()?,
+        })
+    }
+}
+
+impl From<QueryHistoricalInfoResponse>
+    for proto::cosmos::staking::v1beta1::QueryHistoricalInfoResponse
+{
+    fn from(query_historical_info_response: QueryHistoricalInfoResponse) -> Self {
+        proto::cosmos::staking::v1beta1::QueryHistoricalInfoResponse {
+            hist: query_historical_info_response.hist.map(Into::into),
+        }
+    }
+}
diff --git a/cosmrs/src/staking/query_validator_request.rs b/cosmrs/src/staking/query_validator_request.rs
new file mode 100644
index 00000000..1b2823b8
--- /dev/null
+++ b/cosmrs/src/staking/query_validator_request.rs
@@ -0,0 +1,28 @@
+use crate::{proto, AccountId, ErrorReport, Result};
+
+/// QueryValidatorRequest is response type for the Query/Validator RPC method
+#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
+pub struct QueryValidatorRequest {
+    /// validator_addr defines the validator address to query for.
+    pub validator_addr: AccountId,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::QueryValidatorRequest> for QueryValidatorRequest {
+    type Error = ErrorReport;
+
+    fn try_from(
+        proto: cosmos_sdk_proto::cosmos::staking::v1beta1::QueryValidatorRequest,
+    ) -> Result<Self> {
+        Ok(QueryValidatorRequest {
+            validator_addr: proto.validator_addr.parse()?,
+        })
+    }
+}
+
+impl From<QueryValidatorRequest> for proto::cosmos::staking::v1beta1::QueryValidatorRequest {
+    fn from(query_validator_request: QueryValidatorRequest) -> Self {
+        proto::cosmos::staking::v1beta1::QueryValidatorRequest {
+            validator_addr: query_validator_request.validator_addr.to_string(),
+        }
+    }
+}
diff --git a/cosmrs/src/staking/query_validator_response.rs b/cosmrs/src/staking/query_validator_response.rs
new file mode 100644
index 00000000..033321ba
--- /dev/null
+++ b/cosmrs/src/staking/query_validator_response.rs
@@ -0,0 +1,29 @@
+use crate::staking::Validator;
+use crate::{proto, ErrorReport, Result};
+
+/// QueryValidatorResponse is response type for the Query/Validator RPC method
+#[derive(Clone, Debug, PartialEq)]
+pub struct QueryValidatorResponse {
+    /// validator defines the validator info.
+    pub validator: Option<Validator>,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::QueryValidatorResponse> for QueryValidatorResponse {
+    type Error = ErrorReport;
+
+    fn try_from(
+        proto: cosmos_sdk_proto::cosmos::staking::v1beta1::QueryValidatorResponse,
+    ) -> Result<Self> {
+        Ok(QueryValidatorResponse {
+            validator: proto.validator.map(TryInto::try_into).transpose()?,
+        })
+    }
+}
+
+impl From<QueryValidatorResponse> for proto::cosmos::staking::v1beta1::QueryValidatorResponse {
+    fn from(query_validator_response: QueryValidatorResponse) -> Self {
+        proto::cosmos::staking::v1beta1::QueryValidatorResponse {
+            validator: query_validator_response.validator.map(Into::into),
+        }
+    }
+}
diff --git a/cosmrs/src/staking/query_validators_request.rs b/cosmrs/src/staking/query_validators_request.rs
new file mode 100644
index 00000000..4a35f39d
--- /dev/null
+++ b/cosmrs/src/staking/query_validators_request.rs
@@ -0,0 +1,34 @@
+use crate::base::query::PageRequest;
+use crate::{proto, ErrorReport, Result};
+
+/// QueryValidatorsRequest is request type for Query/Validators RPC method.
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct QueryValidatorsRequest {
+    /// status enables to query for validators matching a given status.
+    pub status: String,
+
+    /// pagination defines an optional pagination for the request.
+    pub pagination: Option<PageRequest>,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::QueryValidatorsRequest> for QueryValidatorsRequest {
+    type Error = ErrorReport;
+
+    fn try_from(
+        proto: cosmos_sdk_proto::cosmos::staking::v1beta1::QueryValidatorsRequest,
+    ) -> Result<Self> {
+        Ok(QueryValidatorsRequest {
+            status: proto.status,
+            pagination: proto.pagination.map(Into::into),
+        })
+    }
+}
+
+impl From<QueryValidatorsRequest> for proto::cosmos::staking::v1beta1::QueryValidatorsRequest {
+    fn from(query_validators_request: QueryValidatorsRequest) -> Self {
+        proto::cosmos::staking::v1beta1::QueryValidatorsRequest {
+            status: query_validators_request.status,
+            pagination: query_validators_request.pagination.map(Into::into),
+        }
+    }
+}
diff --git a/cosmrs/src/staking/query_validators_response.rs b/cosmrs/src/staking/query_validators_response.rs
new file mode 100644
index 00000000..f972b9f1
--- /dev/null
+++ b/cosmrs/src/staking/query_validators_response.rs
@@ -0,0 +1,43 @@
+use crate::base::query::PageResponse;
+use crate::staking::Validator;
+use crate::{proto, ErrorReport, Result};
+
+/// QueryValidatorsResponse is response type for the Query/Validators RPC method
+#[derive(Clone, Debug, PartialEq)]
+pub struct QueryValidatorsResponse {
+    /// validators contains all the queried validators.
+    pub validators: Vec<Validator>,
+
+    /// pagination defines the pagination in the response.
+    pub pagination: Option<PageResponse>,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::QueryValidatorsResponse> for QueryValidatorsResponse {
+    type Error = ErrorReport;
+
+    fn try_from(
+        proto: cosmos_sdk_proto::cosmos::staking::v1beta1::QueryValidatorsResponse,
+    ) -> Result<Self> {
+        Ok(QueryValidatorsResponse {
+            validators: proto
+                .validators
+                .into_iter()
+                .map(TryInto::try_into)
+                .collect::<Result<_>>()?,
+            pagination: proto.pagination.map(Into::into),
+        })
+    }
+}
+
+impl From<QueryValidatorsResponse> for proto::cosmos::staking::v1beta1::QueryValidatorsResponse {
+    fn from(query_validators_response: QueryValidatorsResponse) -> Self {
+        proto::cosmos::staking::v1beta1::QueryValidatorsResponse {
+            validators: query_validators_response
+                .validators
+                .into_iter()
+                .map(Into::into)
+                .collect(),
+            pagination: query_validators_response.pagination.map(Into::into),
+        }
+    }
+}
diff --git a/cosmrs/src/staking/validator.rs b/cosmrs/src/staking/validator.rs
new file mode 100644
index 00000000..80abb7eb
--- /dev/null
+++ b/cosmrs/src/staking/validator.rs
@@ -0,0 +1,102 @@
+use crate::staking::{Commission, Description};
+use crate::{proto, Any, ErrorReport, Result};
+use cosmos_sdk_proto::Timestamp;
+use tendermint::Time;
+
+/// Validator defines a validator, together with the total amount of the
+/// Validator's bond shares and their exchange rate to coins. Slashing results in
+/// a decrease in the exchange rate, allowing correct calculation of future
+/// undelegations without iterating over delegators. When coins are delegated to
+/// this validator, the validator is credited with a delegation whose number of
+/// bond shares is based on the amount of coins delegated divided by the current
+/// exchange rate. Voting power can be calculated as total bonded shares
+/// multiplied by exchange rate.
+#[derive(Clone, Debug, PartialEq)]
+pub struct Validator {
+    /// operator_address defines the address of the validator's operator; bech encoded in JSON.
+    pub operator_address: String,
+
+    /// consensus_pubkey is the consensus public key of the validator, as a Protobuf Any.
+    pub consensus_pubkey: Option<Any>,
+
+    /// jailed defined whether the validator has been jailed from bonded status or not.
+    pub jailed: bool,
+
+    /// status is the validator status (bonded/unbonding/unbonded).
+    pub status: i32,
+
+    /// tokens define the delegated tokens (incl. self-delegation).
+    pub tokens: String,
+
+    /// delegator_shares defines total shares issued to a validator's delegators.
+    pub delegator_shares: String,
+
+    /// description defines the description terms for the validator.
+    pub description: Option<Description>,
+
+    /// unbonding_height defines, if unbonding, the height at which this validator has begun unbonding.
+    pub unbonding_height: i64,
+
+    /// unbonding_time defines, if unbonding, the min time for the validator to complete unbonding.
+    pub unbonding_time: Option<Time>,
+
+    /// commission defines the commission parameters.
+    pub commission: Option<Commission>,
+    /// min_self_delegation is the validator's self declared minimum self delegation.
+    ///
+    /// Since: cosmos-sdk 0.46
+    pub min_self_delegation: String,
+}
+
+impl TryFrom<proto::cosmos::staking::v1beta1::Validator> for Validator {
+    type Error = ErrorReport;
+
+    fn try_from(proto: cosmos_sdk_proto::cosmos::staking::v1beta1::Validator) -> Result<Self> {
+        Ok(Validator {
+            operator_address: proto.operator_address,
+            consensus_pubkey: proto.consensus_pubkey,
+            jailed: proto.jailed,
+            status: proto.status,
+            tokens: proto.tokens,
+            delegator_shares: proto.delegator_shares,
+            description: proto.description.map(Into::into),
+            unbonding_height: proto.unbonding_height,
+            unbonding_time: proto
+                .unbonding_time
+                .map(|jailed_until| {
+                    cosmos_sdk_proto::tendermint::google::protobuf::Timestamp {
+                        seconds: jailed_until.seconds,
+                        nanos: jailed_until.nanos,
+                    }
+                    .try_into()
+                })
+                .transpose()?,
+            commission: proto.commission.map(TryInto::try_into).transpose()?,
+            min_self_delegation: proto.min_self_delegation,
+        })
+    }
+}
+
+impl From<Validator> for proto::cosmos::staking::v1beta1::Validator {
+    fn from(validator: Validator) -> Self {
+        proto::cosmos::staking::v1beta1::Validator {
+            operator_address: validator.operator_address,
+            consensus_pubkey: validator.consensus_pubkey,
+            jailed: validator.jailed,
+            status: validator.status,
+            tokens: validator.tokens,
+            delegator_shares: validator.delegator_shares,
+            description: validator.description.map(Into::into),
+            unbonding_height: validator.unbonding_height,
+            unbonding_time: validator
+                .unbonding_time
+                .map(cosmos_sdk_proto::tendermint::google::protobuf::Timestamp::from)
+                .map(|t| Timestamp {
+                    seconds: t.seconds,
+                    nanos: t.nanos,
+                }),
+            commission: validator.commission.map(Into::into),
+            min_self_delegation: validator.min_self_delegation,
+        }
+    }
+}