Merge pull request #345 from input-output-hk/lowhung/introduce-query-error-into-state-modules

feat: Integrate `QueryError` into state query responses and refactor REST to match on new NotFound enum

Author: lowhung

common/src/address.rs

@@ -148,10 +148,12 @@ pub struct ShelleyAddressPointer {
     serde::Deserialize,
     minicbor::Encode,
     minicbor::Decode,
+    Default,
 )]
 pub enum ShelleyAddressDelegationPart {
     /// No delegation (enterprise addresses)
     #[n(0)]
+    #[default]
     None,
 
     /// Delegation to stake key
@@ -167,12 +169,6 @@ pub enum ShelleyAddressDelegationPart {
     Pointer(#[n(0)] ShelleyAddressPointer),
 }
 
-impl Default for ShelleyAddressDelegationPart {
-    fn default() -> Self {
-        Self::None
-    }
-}
-
 /// A Shelley-era address
 #[derive(
     Debug,
@@ -619,20 +615,15 @@ impl Default for StakeAddress {
 }
 
 /// A Cardano address
-#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize, Default)]
 pub enum Address {
+    #[default]
     None,
     Byron(ByronAddress),
     Shelley(ShelleyAddress),
     Stake(StakeAddress),
 }
 
-impl Default for Address {
-    fn default() -> Self {
-        Self::None
-    }
-}
-
 impl Address {
     /// Get the stake pointer if there is one
     pub fn get_pointer(&self) -> Option<ShelleyAddressPointer> {

common/src/queries/accounts.rs

@@ -1,5 +1,6 @@
 use std::collections::HashMap;
 
+use crate::queries::errors::QueryError;
 use crate::{
     DRepChoice, PoolId, PoolLiveStakeInfo, RewardType, ShelleyAddress, StakeAddress, TxIdentifier,
 };
@@ -80,9 +81,7 @@ pub enum AccountsStateQueryResponse {
     // DReps-related responses
     DrepDelegators(DrepDelegators),
     AccountsDrepDelegationsMap(HashMap<StakeAddress, Option<DRepChoice>>),
-
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]

common/src/queries/addresses.rs

@@ -1,3 +1,4 @@
+use crate::queries::errors::QueryError;
 use crate::{Address, AddressTotals, TxIdentifier, UTxOIdentifier};
 
 pub const DEFAULT_ADDRESS_QUERY_TOPIC: (&str, &str) =
@@ -15,6 +16,5 @@ pub enum AddressStateQueryResponse {
     AddressTotals(AddressTotals),
     AddressUTxOs(Vec<UTxOIdentifier>),
     AddressTransactions(Vec<TxIdentifier>),
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }

common/src/queries/assets.rs

@@ -1,3 +1,4 @@
+use crate::queries::errors::QueryError;
 use crate::{
     AssetAddressEntry, AssetInfoRecord, AssetMintRecord, AssetName, PolicyAsset, PolicyId,
     TxIdentifier,
@@ -36,6 +37,5 @@ pub enum AssetsStateQueryResponse {
     AssetAddresses(AssetAddresses),
     AssetTransactions(AssetTransactions),
     PolicyIdAssets(PolicyAssets),
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }

common/src/queries/blocks.rs

@@ -1,3 +1,4 @@
+use crate::queries::errors::QueryError;
 use crate::{
     queries::misc::Order,
     serialization::{Bech32Conversion, Bech32WithHrp},
@@ -90,8 +91,7 @@ pub enum BlocksStateQueryResponse {
     BlockInvolvedAddresses(BlockInvolvedAddresses),
     BlockHashes(BlockHashes),
     TransactionHashes(TransactionHashes),
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]

common/src/queries/epochs.rs

@@ -1,3 +1,4 @@
+use crate::queries::errors::QueryError;
 use crate::{messages::EpochActivityMessage, protocol_params::ProtocolParams, PoolId};
 
 pub const DEFAULT_EPOCHS_QUERY_TOPIC: (&str, &str) =
@@ -23,9 +24,7 @@ pub enum EpochsStateQueryResponse {
     EpochStakeDistribution(EpochStakeDistribution),
     EpochStakeDistributionByPool(EpochStakeDistributionByPool),
     LatestEpochBlocksMintedByPool(u64),
-
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]

common/src/queries/governance.rs

@@ -1,5 +1,6 @@
 use std::collections::HashMap;
 
+use crate::queries::errors::QueryError;
 use crate::{
     Anchor, DRepCredential, GovActionId, Lovelace, ProposalProcedure, StakeAddress, TxHash,
     TxIdentifier, Vote, Voter, VotingProcedure,
@@ -41,8 +42,7 @@ pub enum GovernanceStateQueryResponse {
     ProposalWithdrawals(ProposalWithdrawals),
     ProposalVotes(ProposalVotes),
     ProposalMetadata(ProposalMetadata),
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
@@ -124,14 +124,3 @@ pub struct ProposalVotes {
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub struct ProposalMetadata {}
-
-pub fn handle_governance_query_result<T>(
-    result: anyhow::Result<Option<T>>,
-    mapper: impl FnOnce(T) -> GovernanceStateQueryResponse,
-) -> GovernanceStateQueryResponse {
-    match result {
-        Ok(Some(val)) => mapper(val),
-        Ok(None) => GovernanceStateQueryResponse::NotFound,
-        Err(e) => GovernanceStateQueryResponse::Error(e.to_string()),
-    }
-}

common/src/queries/mempool.rs

@@ -1,3 +1,5 @@
+use crate::queries::errors::QueryError;
+
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub enum MempoolStateQuery {
     GetMempoolList,
@@ -10,8 +12,7 @@ pub enum MempoolStateQueryResponse {
     MempoolList(MempoolList),
     MempoolTransaction(MempoolTransaction),
     MempoolTransactionByAddress(MempoolTransactionByAddress),
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]

common/src/queries/metadata.rs

@@ -1,3 +1,5 @@
+use crate::queries::errors::QueryError;
+
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub enum MetadataStateQuery {
     GetMetadataLabels,
@@ -10,8 +12,7 @@ pub enum MetadataStateQueryResponse {
     MetadataLabels(MetadataLabels),
     TransactionMetadataJSON(TransactionMetadataJSON),
     TransactionMetadataCBOR(TransactionMetadataCBOR),
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]

common/src/queries/network.rs

@@ -1,3 +1,5 @@
+use crate::queries::errors::QueryError;
+
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub enum NetworkStateQuery {
     GetNetworkInformation,
@@ -8,8 +10,7 @@ pub enum NetworkStateQuery {
 pub enum NetworkStateQueryResponse {
     NetworkInformation(NetworkInformation),
     EraSummary(EraSummary),
-    NotFound,
-    Error(String),
+    Error(QueryError),
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]