feat(sdk): get node status

packages/dapi-grpc/build.rs

@@ -47,7 +47,7 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
     // Derive features for versioned messages
     //
     // "GetConsensusParamsRequest" is excluded as this message does not support proofs
-    const VERSIONED_REQUESTS: [&str; 29] = [
+    const VERSIONED_REQUESTS: [&str; 30] = [
         "GetDataContractHistoryRequest",
         "GetDataContractRequest",
         "GetDataContractsRequest",
@@ -77,9 +77,13 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetTotalCreditsInPlatformRequest",
         "GetEvonodesProposedEpochBlocksByIdsRequest",
         "GetEvonodesProposedEpochBlocksByRangeRequest",
+        "GetStatusRequest",
     ];
 
-    //  "GetConsensusParamsResponse" is excluded as this message does not support proofs
+    // The following responses are excluded as they don't support proofs:
+    // - "GetConsensusParamsResponse"
+    // - "GetStatusResponse"
+    //
     //  "GetEvonodesProposedEpochBlocksResponse" is used for 2 Requests
     const VERSIONED_RESPONSES: [&str; 29] = [
         "GetDataContractHistoryResponse",
@@ -213,6 +217,7 @@ impl MappingConfig {
     ///
     /// * `protobuf_file` - Path to the protobuf file to use as input.
     /// * `out_dir` - Output directory where subdirectories for generated files will be created.
+    ///
     /// Depending on the features, either `client`, `server` or `client_server` subdirectory
     /// will be created inside `out_dir`.
     fn new(protobuf_file: PathBuf, out_dir: PathBuf) -> Self {

packages/rs-dapi-client/src/address_list.rs

@@ -85,7 +85,7 @@ pub enum AddressListError {
 
 /// A structure to manage DAPI addresses to select from
 /// for [DapiRequest](crate::DapiRequest) execution.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct AddressList {
     addresses: HashSet<Address>,
     base_ban_period: Duration,
@@ -221,3 +221,12 @@ impl FromIterator<Uri> for AddressList {
         address_list
     }
 }
+
+impl IntoIterator for AddressList {
+    type Item = Address;
+    type IntoIter = std::collections::hash_set::IntoIter<Address>;
+
+    fn into_iter(self) -> Self::IntoIter {
+        self.addresses.into_iter()
+    }
+}

packages/rs-dapi-client/src/dapi_client.rs

@@ -112,6 +112,11 @@ impl DapiClient {
             dump_dir: None,
         }
     }
+
+    /// Return the [DapiClient] address list.
+    pub fn address_list(&self) -> &Arc<RwLock<AddressList>> {
+        &self.address_list
+    }
 }
 
 #[async_trait]

packages/rs-dapi-client/src/dump.rs

@@ -189,7 +189,6 @@ impl DapiClient {
         response: &MockResult<R>,
         dump_dir: Option<PathBuf>,
     ) where
-        R: Mockable,
         <R as TransportRequest>::Response: Mockable,
     {
         let path = match dump_dir {

packages/rs-dapi-client/src/lib.rs

@@ -14,6 +14,7 @@ pub mod transport;
 
 pub use address_list::Address;
 pub use address_list::AddressList;
+pub use connection_pool::ConnectionPool;
 pub use dapi_client::DapiRequestExecutor;
 pub use dapi_client::{DapiClient, DapiClientError};
 use dapi_grpc::mock::Mockable;

packages/rs-dapi-client/src/transport/grpc.rs

@@ -421,3 +421,12 @@ impl_transport_request_grpc!(
     },
     subscribe_to_transactions_with_proofs
 );
+
+// rpc getStatus(GetStatusRequest) returns (GetStatusResponse);
+impl_transport_request_grpc!(
+    platform_proto::GetStatusRequest,
+    platform_proto::GetStatusResponse,
+    PlatformGrpcClient,
+    RequestSettings::default(),
+    get_status
+);

packages/rs-drive-proof-verifier/src/proof.rs

@@ -2,13 +2,16 @@ use crate::from_request::TryFromRequest;
 use crate::provider::DataContractProvider;
 use crate::verify::verify_tenderdash_proof;
 use crate::{types, types::*, ContextProvider, Error};
+use dapi_grpc::platform::v0::get_evonodes_proposed_epoch_blocks_by_range_request::get_evonodes_proposed_epoch_blocks_by_range_request_v0::Start;
 use dapi_grpc::platform::v0::get_identities_contract_keys_request::GetIdentitiesContractKeysRequestV0;
 use dapi_grpc::platform::v0::get_path_elements_request::GetPathElementsRequestV0;
 use dapi_grpc::platform::v0::get_protocol_version_upgrade_vote_status_request::{
     self, GetProtocolVersionUpgradeVoteStatusRequestV0,
 };
 use dapi_grpc::platform::v0::security_level_map::KeyKindRequestType as GrpcKeyKind;
-use dapi_grpc::platform::v0::{get_contested_resource_identity_votes_request, get_data_contract_history_request, get_data_contract_request, get_data_contracts_request, get_epochs_info_request, get_evonodes_proposed_epoch_blocks_by_ids_request, get_evonodes_proposed_epoch_blocks_by_range_request, get_identities_balances_request, get_identities_contract_keys_request, get_identity_balance_and_revision_request, get_identity_balance_request, get_identity_by_public_key_hash_request, get_identity_contract_nonce_request, get_identity_keys_request, get_identity_nonce_request, get_identity_request, get_path_elements_request, get_prefunded_specialized_balance_request, GetContestedResourceVotersForIdentityRequest, GetContestedResourceVotersForIdentityResponse, GetPathElementsRequest, GetPathElementsResponse, GetProtocolVersionUpgradeStateRequest, GetProtocolVersionUpgradeStateResponse, GetProtocolVersionUpgradeVoteStatusRequest, GetProtocolVersionUpgradeVoteStatusResponse, Proof, ResponseMetadata};
+use dapi_grpc::platform::v0::{
+    get_contested_resource_identity_votes_request, get_data_contract_history_request, get_data_contract_request, get_data_contracts_request, get_epochs_info_request, get_evonodes_proposed_epoch_blocks_by_ids_request, get_evonodes_proposed_epoch_blocks_by_range_request, get_identities_balances_request, get_identities_contract_keys_request, get_identity_balance_and_revision_request, get_identity_balance_request, get_identity_by_public_key_hash_request, get_identity_contract_nonce_request, get_identity_keys_request, get_identity_nonce_request, get_identity_request, get_path_elements_request, get_prefunded_specialized_balance_request, GetContestedResourceVotersForIdentityRequest, GetContestedResourceVotersForIdentityResponse, GetPathElementsRequest, GetPathElementsResponse, GetProtocolVersionUpgradeStateRequest, GetProtocolVersionUpgradeStateResponse, GetProtocolVersionUpgradeVoteStatusRequest, GetProtocolVersionUpgradeVoteStatusResponse, Proof, ResponseMetadata
+};
 use dapi_grpc::platform::{
     v0::{self as platform, key_request_type, KeyRequestType as GrpcKeyType},
     VersionedGrpcResponse,
@@ -35,15 +38,14 @@ use drive::drive::identity::key::fetch::{
 use drive::drive::Drive;
 use drive::error::proof::ProofError;
 use drive::query::contested_resource_votes_given_by_identity_query::ContestedResourceVotesGivenByIdentityQuery;
+use drive::query::proposer_block_count_query::ProposerQueryType;
 use drive::query::vote_poll_contestant_votes_query::ContestedDocumentVotePollVotesDriveQuery;
 use drive::query::vote_poll_vote_state_query::ContestedDocumentVotePollDriveQuery;
 use drive::query::vote_polls_by_document_type_query::VotePollsByDocumentTypeQuery;
 use drive::query::{DriveDocumentQuery, VotePollsByEndDateDriveQuery};
 use std::array::TryFromSliceError;
 use std::collections::BTreeMap;
 use std::num::TryFromIntError;
-use dapi_grpc::platform::v0::get_evonodes_proposed_epoch_blocks_by_range_request::get_evonodes_proposed_epoch_blocks_by_range_request_v0::Start;
-use drive::query::proposer_block_count_query::ProposerQueryType;
 
 /// Parse and verify the received proof and retrieve the requested object, if any.
 ///
@@ -78,7 +80,7 @@ pub trait FromProof<Req> {
     ///
     /// * `Ok(Some(object, metadata))` when the requested object was found in the proof.
     /// * `Ok(None)` when the requested object was not found in the proof; this can be interpreted as proof of non-existence.
-    /// For collections, returns Ok(None) if none of the requested objects were found.
+    ///    For collections, returns Ok(None) if none of the requested objects were found.
     /// * `Err(Error)` when either the provided data is invalid or proof validation failed.
     fn maybe_from_proof<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
         request: I,
@@ -108,7 +110,7 @@ pub trait FromProof<Req> {
     ///
     /// * `Ok(Some((object, metadata)))` when the requested object was found in the proof.
     /// * `Ok(None)` when the requested object was not found in the proof; this can be interpreted as proof of non-existence.
-    /// For collections, returns Ok(None) if none of the requested objects were found.
+    ///    For collections, returns Ok(None) if none of the requested objects were found.
     /// * `Err(Error)` when either the provided data is invalid or proof validation failed.
     fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
         request: I,
@@ -1714,7 +1716,6 @@ impl FromProof<platform::GetTotalCreditsInPlatformRequest> for TotalCreditsInPla
         ))
     }
 }
-
 impl FromProof<platform::GetEvonodesProposedEpochBlocksByIdsRequest> for ProposerBlockCounts {
     type Request = platform::GetEvonodesProposedEpochBlocksByIdsRequest;
     type Response = platform::GetEvonodesProposedEpochBlocksResponse;

packages/rs-drive-proof-verifier/src/types.rs

@@ -5,6 +5,7 @@
 //! In this case, the [FromProof](crate::FromProof) trait is implemented for dedicated object type
 //! defined in this module.
 
+use dapi_grpc::platform::v0::GetStatusResponse;
 use dpp::data_contract::document_type::DocumentType;
 use dpp::fee::Credits;
 use dpp::platform_value::Value;
@@ -27,11 +28,12 @@ use dpp::{
 use drive::grovedb::Element;
 use std::collections::{BTreeMap, BTreeSet};
 
+use crate::Error;
 use dpp::block::block_info::BlockInfo;
 use dpp::core_types::validator_set::ValidatorSet;
-use dpp::dashcore::QuorumHash;
 use dpp::voting::vote_info_storage::contested_document_vote_poll_winner_info::ContestedDocumentVotePollWinnerInfo;
 use drive::grovedb::query_result_type::Path;
+
 #[cfg(feature = "mocks")]
 use {
     bincode::{Decode, Encode},
@@ -614,3 +616,53 @@ pub struct ProposerBlockCountByRange(pub u64);
 #[derive(Debug)]
 #[cfg_attr(feature = "mocks", derive(serde::Serialize, serde::Deserialize))]
 pub struct ProposerBlockCountById(pub u64);
+
+#[derive(Debug, Clone)]
+#[cfg_attr(
+    feature = "mocks",
+    derive(Encode, Decode, PlatformSerialize, PlatformDeserialize),
+    platform_serialize(unversioned)
+)]
+/// Status of a network node
+pub struct EvonodeStatus {
+    /// The Identifier of the Evonode
+    pub pro_tx_hash: [u8; ProTxHash::LEN],
+    /// The latest block height stored on the Evonode
+    pub latest_block_height: u64,
+}
+
+impl TryFrom<GetStatusResponse> for EvonodeStatus {
+    type Error = Error;
+    fn try_from(response: GetStatusResponse) -> Result<Self, Self::Error> {
+        use dapi_grpc::platform::v0::get_status_response::Version;
+        match response.version {
+            Some(Version::V0(v0)) => {
+                let node = v0.node.ok_or(Error::ProtocolError {
+                    error: "missing node information".to_string(),
+                })?;
+
+                let chain = v0.chain.ok_or(Error::ProtocolError {
+                    error: "missing chain information".to_string(),
+                })?;
+
+                let protx = node.pro_tx_hash.ok_or(Error::ProtocolError {
+                    error: "Missing pro_tx_hash".to_string(),
+                })?;
+                let protx_len = protx.len();
+
+                Ok(Self {
+                    pro_tx_hash: protx.clone().try_into().map_err(|_| Error::ProtocolError {
+                        error: format!(
+                            "Invalid pro_tx_hash size: {} != {}",
+                            protx_len,
+                            ProTxHash::LEN
+                        ),
+                    })?,
+
+                    latest_block_height: chain.latest_block_height,
+                })
+            }
+            None => Err(Error::EmptyVersion),
+        }
+    }
+}

packages/rs-drive-proof-verifier/src/unproved.rs

@@ -1,7 +1,8 @@
-use crate::types::CurrentQuorumsInfo;
+use crate::types::{CurrentQuorumsInfo, EvonodeStatus};
 use crate::Error;
 use dapi_grpc::platform::v0::ResponseMetadata;
 use dapi_grpc::platform::v0::{self as platform};
+use dapi_grpc::tonic::async_trait;
 use dpp::bls_signatures::PublicKey as BlsPublicKey;
 use dpp::core_types::validator::v0::ValidatorV0;
 use dpp::core_types::validator_set::v0::ValidatorSetV0;
@@ -273,3 +274,23 @@ impl FromUnproved<platform::GetCurrentQuorumsInfoRequest> for CurrentQuorumsInfo
         Ok((Some(info), metadata))
     }
 }
+
+#[async_trait]
+impl FromUnproved<platform::GetStatusRequest> for EvonodeStatus {
+    type Request = platform::GetStatusRequest;
+    type Response = platform::GetStatusResponse;
+
+    fn maybe_from_unproved_with_metadata<I: Into<Self::Request>, O: Into<Self::Response>>(
+        _request: I,
+        response: O,
+        _network: Network,
+        _platform_version: &PlatformVersion,
+    ) -> Result<(Option<Self>, ResponseMetadata), Error>
+    where
+        Self: Sized,
+    {
+        let status = Self::try_from(response.into())?;
+        // we use default response metadata, as this request does not return any metadata
+        Ok((Some(status), Default::default()))
+    }
+}

packages/rs-sdk/Cargo.toml

@@ -26,7 +26,7 @@ serde = { version = "1.0.197", default-features = false, features = [
 ], optional = true }
 serde_json = { version = "1.0", features = ["preserve_order"], optional = true }
 tracing = { version = "0.1.40" }
-hex = { version = "0.4.3"}
+hex = { version = "0.4.3" }
 dotenvy = { version = "0.15.7", optional = true }
 envy = { version = "0.4.2", optional = true }
 futures = { version = "0.3.30" }

packages/rs-sdk/README.md

@@ -97,9 +97,9 @@ Run the offline test using the following command:
 cargo test -p dash-platform-sdk
 ```
 
-## Implementing Fetch and FetchAny on new objects
+## Implementing Fetch and FetchMany on new objects
 
-How to implement `Fetch` and `FetchAny` trait on new object types (`Object`).
+How to implement `Fetch` and `FetchMany` trait on new object types (`Object`).
 
 It's basically copy-paste and tweaking of existing implementation for another object type.
 
@@ -114,7 +114,7 @@ Definitions:
 Checklist:
 
 1. [ ] Ensure protobuf messages are defined in `packages/dapi-grpc/protos/platform/v0/platform.proto` and generated
-   correctly in `packages/dapi-grpc/src/platform/proto/org.dash.platform.dapi.v0.rs`.
+   correctly in `packages/dapi-grpc/src/platform/client/org.dash.platform.dapi.v0.rs`.
 2. [ ] In `packages/dapi-grpc/build.rs`, add `Request` to `VERSIONED_REQUESTS` and response `Response` to `VERSIONED_RESPONSES`.
    This should add derive of `VersionedGrpcMessage` (and some more) in `org.dash.platform.dapi.v0.rs`.
 3. [ ] Link request and response type to dapi-client by adding appropriate invocation of `impl_transport_request_grpc!` macro
@@ -123,7 +123,7 @@ in `packages/rs-dapi-client/src/transport/grpc.rs`.
    used internally.
 
    If you intend to implement `FetchMany`, you should define type returned by `fetch_many()` using `RetrievedObjects`
-   that will store collection of  returned objects, indexd by some key.
+   that will store collection of  returned objects, indexed by some key.
 5. [ ] Implement `FromProof` trait for the `Object` (or type defined in `types.rs`) in `packages/rs-drive-proof-verifier/src/proof.rs`.
 6. [ ] Implement `Query` trait for the `Request` in `packages/rs-sdk/src/platform/query.rs`.
 7. [ ] Implement `Fetch` trait for the `Object` (or type defined in `types.rs`), with inner type Request = `Request`,

packages/rs-sdk/src/lib.rs

@@ -32,8 +32,8 @@
 //!
 //! 1. [`Identifier`](crate::platform::Identifier) - fetches an object by its identifier
 //! 2. [`DocumentQuery`](crate::platform::DocumentQuery) - fetches documents based on search conditions; see
-//! [query syntax documentation](https://docs.dash.org/projects/platform/en/stable/docs/reference/query-syntax.html)
-//! for more details.
+//!    [query syntax documentation](https://docs.dash.org/projects/platform/en/stable/docs/reference/query-syntax.html)
+//!    for more details.
 //! 3. [`DriveQuery`](crate::platform::DriveDocumentQuery) - can be used to build more complex queries
 //!
 //! ## Testability

packages/rs-sdk/src/mock.rs

@@ -32,7 +32,6 @@ pub mod sdk;
 // Otherwise  dapi_grpc_macros::Mockable fails.
 // TODO: move Mockable to some crate that can be shared between dapi-grpc, rs-dapi-client, and dash-sdk
 pub use dapi_grpc::mock::Mockable;
-
 // MockResponse is needed even if mocks feature is disabled - it just does nothing.
 #[cfg(not(feature = "mocks"))]
 pub use noop::MockResponse;

packages/rs-sdk/src/mock/requests.rs

@@ -15,9 +15,10 @@ use dpp::{
     voting::votes::{resource_vote::ResourceVote, Vote},
 };
 use drive_proof_verifier::types::{
-    Contenders, ContestedResources, ElementFetchRequestItem, IdentityBalanceAndRevision,
-    MasternodeProtocolVote, PrefundedSpecializedBalance, ProposerBlockCounts,
-    RetrievedIntegerValue, TotalCreditsInPlatform, VotePollsGroupedByTimestamp, Voters,
+    Contenders, ContestedResources, CurrentQuorumsInfo, ElementFetchRequestItem, EvonodeStatus,
+    IdentityBalanceAndRevision, MasternodeProtocolVote, PrefundedSpecializedBalance,
+    ProposerBlockCounts, RetrievedIntegerValue, TotalCreditsInPlatform,
+    VotePollsGroupedByTimestamp, Voters,
 };
 use std::collections::BTreeMap;
 
@@ -243,3 +244,5 @@ impl_mock_response!(VotePollsGroupedByTimestamp);
 impl_mock_response!(PrefundedSpecializedBalance);
 impl_mock_response!(TotalCreditsInPlatform);
 impl_mock_response!(ElementFetchRequestItem);
+impl_mock_response!(EvonodeStatus);
+impl_mock_response!(CurrentQuorumsInfo);

packages/rs-sdk/src/mock/sdk.rs

@@ -2,7 +2,10 @@
 //!
 //! See [MockDashPlatformSdk] for more details.
 use crate::{
-    platform::{types::identity::IdentityRequest, DocumentQuery, Fetch, FetchMany, Query},
+    platform::{
+        types::{evonode::EvoNode, identity::IdentityRequest},
+        DocumentQuery, Fetch, FetchMany, Query,
+    },
     Error, Sdk,
 };
 use arc_swap::ArcSwapOption;
@@ -201,9 +204,10 @@ impl MockDashPlatformSdk {
                     self.load_expectation::<proto::GetTotalCreditsInPlatformRequest>(filename)
                         .await?
                 }
+                "EvoNode" => self.load_expectation::<EvoNode>(filename).await?,
                 _ => {
                     return Err(Error::Config(format!(
-                        "unknown request type {} in {}",
+                        "unknown request type {} in {}, missing match arm in load_expectations?",
                         request_type,
                         filename.display()
                     )))

packages/rs-sdk/src/platform.rs

@@ -32,5 +32,6 @@ pub use {
     document_query::DocumentQuery,
     fetch::Fetch,
     fetch_many::FetchMany,
+    fetch_unproved::FetchUnproved,
     query::{LimitQuery, Query, QueryStartInfo, DEFAULT_EPOCH_QUERY_LIMIT},
 };