nym_validator_client/nyxd/contract_traits/

mixnet_query_client.rs

// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

use crate::collect_paged;
use crate::nyxd::contract_traits::NymContractsProvider;
use crate::nyxd::error::NyxdError;
use crate::nyxd::CosmWasmClient;
use async_trait::async_trait;
use cosmrs::AccountId;
use nym_contracts_common::signing::Nonce;
use nym_mixnet_contract_common::gateway::{PreassignedGatewayIdsResponse, PreassignedId};
use nym_mixnet_contract_common::nym_node::{
    EpochAssignmentResponse, NodeDetailsByIdentityResponse, NodeDetailsResponse,
    NodeOwnershipResponse, NodeRewardingDetailsResponse, PagedNymNodeBondsResponse,
    PagedNymNodeDetailsResponse, PagedUnbondedNymNodesResponse, RewardedSetMetadata, Role,
    RolesMetadataResponse, StakeSaturationResponse, UnbondedNodeResponse, UnbondedNymNode,
};
use nym_mixnet_contract_common::reward_params::WorkFactor;
use nym_mixnet_contract_common::{
    delegation,
    delegation::{NodeDelegationResponse, OwnerProxySubKey},
    mixnode::{
        MixStakeSaturationResponse, MixnodeRewardingDetailsResponse, PagedMixnodesDetailsResponse,
        PagedUnbondedMixnodesResponse, UnbondedMixnodeResponse,
    },
    reward_params::{Performance, RewardingParams},
    rewarding::{EstimatedCurrentEpochRewardResponse, PendingRewardResponse},
    ContractBuildInformation, ContractState, ContractStateParams, CurrentIntervalResponse,
    CurrentNymNodeVersionResponse, Delegation, EpochEventId, EpochRewardedSet, EpochStatus,
    GatewayBond, GatewayBondResponse, GatewayOwnershipResponse, HistoricalNymNodeVersionEntry,
    IdentityKey, IdentityKeyRef, IntervalEventId, KeyRotationIdResponse, KeyRotationState,
    MixNodeBond, MixNodeDetails, MixOwnershipResponse, MixnodeDetailsByIdentityResponse,
    MixnodeDetailsResponse, NodeId, NumberOfPendingEventsResponse, NymNodeBond, NymNodeDetails,
    NymNodeVersionHistoryResponse, PagedAllDelegationsResponse, PagedDelegatorDelegationsResponse,
    PagedGatewayResponse, PagedMixnodeBondsResponse, PagedNodeDelegationsResponse,
    PendingEpochEvent, PendingEpochEventResponse, PendingEpochEventsResponse, PendingIntervalEvent,
    PendingIntervalEventResponse, PendingIntervalEventsResponse, QueryMsg as MixnetQueryMsg,
    RewardedSet, UnbondedMixnode,
};
use serde::Deserialize;

#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait MixnetQueryClient {
    async fn query_mixnet_contract<T>(&self, query: MixnetQueryMsg) -> Result<T, NyxdError>
    where
        for<'a> T: Deserialize<'a>;

    // state/sys-params-related

    async fn admin(&self) -> Result<cw_controllers::AdminResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::Admin {}).await
    }

    async fn get_mixnet_contract_version(&self) -> Result<ContractBuildInformation, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetContractVersion {})
            .await
    }

    async fn get_mixnet_contract_cw2_version(&self) -> Result<cw2::ContractVersion, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetCW2ContractVersion {})
            .await
    }

    async fn get_rewarding_validator_address(&self) -> Result<AccountId, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetRewardingValidatorAddress {})
            .await
    }

    async fn get_mixnet_contract_state_params(&self) -> Result<ContractStateParams, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetStateParams {})
            .await
    }

    async fn get_nym_node_version_history_paged(
        &self,
        start_after: Option<u32>,
        limit: Option<u32>,
    ) -> Result<NymNodeVersionHistoryResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNymNodeVersionHistory { limit, start_after })
            .await
    }

    async fn get_current_nym_node_version(
        &self,
    ) -> Result<CurrentNymNodeVersionResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetCurrentNymNodeVersion {})
            .await
    }

    async fn get_mixnet_contract_state(&self) -> Result<ContractState, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetState {})
            .await
    }

    async fn get_rewarding_parameters(&self) -> Result<RewardingParams, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetRewardingParams {})
            .await
    }

    async fn get_current_epoch_status(&self) -> Result<EpochStatus, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetEpochStatus {})
            .await
    }

    async fn get_current_interval_details(&self) -> Result<CurrentIntervalResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetCurrentIntervalDetails {})
            .await
    }

    // mixnode-related:

    async fn get_mixnode_bonds_paged(
        &self,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedMixnodeBondsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetMixNodeBonds { limit, start_after })
            .await
    }

    async fn get_mixnodes_detailed_paged(
        &self,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedMixnodesDetailsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetMixNodesDetailed { limit, start_after })
            .await
    }

    async fn get_unbonded_mixnodes_paged(
        &self,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedUnbondedMixnodesResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedMixNodes { limit, start_after })
            .await
    }

    async fn get_unbonded_mixnodes_by_owner_paged(
        &self,
        owner: &AccountId,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedUnbondedMixnodesResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedMixNodesByOwner {
            owner: owner.to_string(),
            limit,
            start_after,
        })
        .await
    }

    async fn get_unbonded_mixnodes_by_identity_paged(
        &self,
        identity_key: IdentityKeyRef<'_>,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedUnbondedMixnodesResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedMixNodesByIdentityKey {
            identity_key: identity_key.to_string(),
            limit,
            start_after,
        })
        .await
    }

    async fn get_owned_mixnode(
        &self,
        address: &AccountId,
    ) -> Result<MixOwnershipResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetOwnedMixnode {
            address: address.to_string(),
        })
        .await
    }

    async fn get_mixnode_details(
        &self,
        mix_id: NodeId,
    ) -> Result<MixnodeDetailsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetMixnodeDetails { mix_id })
            .await
    }

    async fn get_mixnode_details_by_identity(
        &self,
        mix_identity: IdentityKey,
    ) -> Result<MixnodeDetailsByIdentityResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetBondedMixnodeDetailsByIdentity {
            mix_identity,
        })
        .await
    }

    async fn get_mixnode_rewarding_details(
        &self,
        mix_id: NodeId,
    ) -> Result<MixnodeRewardingDetailsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetMixnodeRewardingDetails { mix_id })
            .await
    }

    async fn get_mixnode_stake_saturation(
        &self,
        mix_id: NodeId,
    ) -> Result<MixStakeSaturationResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetStakeSaturation { mix_id })
            .await
    }

    async fn get_unbonded_mixnode_information(
        &self,
        mix_id: NodeId,
    ) -> Result<UnbondedMixnodeResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedMixNodeInformation { mix_id })
            .await
    }

    // async fn get_layer_distribution(&self) -> Result<LayerDistribution, NyxdError> {
    //     self.query_mixnet_contract(MixnetQueryMsg::GetRoleDistribution {})
    //         .await
    // }

    // gateway-related:

    async fn get_gateways_paged(
        &self,
        start_after: Option<IdentityKey>,
        limit: Option<u32>,
    ) -> Result<PagedGatewayResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetGateways { start_after, limit })
            .await
    }

    /// Checks whether there is a bonded gateway associated with the provided identity key
    async fn get_gateway_bond(
        &self,
        identity: IdentityKey,
    ) -> Result<GatewayBondResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetGatewayBond { identity })
            .await
    }

    /// Checks whether there is a bonded gateway associated with the provided client's address
    async fn get_owned_gateway(
        &self,
        address: &AccountId,
    ) -> Result<GatewayOwnershipResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetOwnedGateway {
            address: address.to_string(),
        })
        .await
    }

    async fn get_preassigned_gateway_ids_paged(
        &self,
        start_after: Option<IdentityKey>,
        limit: Option<u32>,
    ) -> Result<PreassignedGatewayIdsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPreassignedGatewayIds { start_after, limit })
            .await
    }

    // nym-nodes related:
    async fn get_nymnode_bonds_paged(
        &self,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedNymNodeBondsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNymNodeBondsPaged { limit, start_after })
            .await
    }

    async fn get_nymnodes_detailed_paged(
        &self,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedNymNodeDetailsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNymNodesDetailedPaged { limit, start_after })
            .await
    }

    async fn get_unbonded_nymnodes_paged(
        &self,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedUnbondedNymNodesResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedNymNodesPaged { limit, start_after })
            .await
    }

    async fn get_unbonded_nymnodes_by_owner_paged(
        &self,
        owner: &AccountId,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedUnbondedNymNodesResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedNymNodesByOwnerPaged {
            owner: owner.to_string(),
            limit,
            start_after,
        })
        .await
    }

    async fn get_unbonded_nymnodes_by_identity_paged(
        &self,
        identity_key: IdentityKeyRef<'_>,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PagedUnbondedNymNodesResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedNymNodesByIdentityKeyPaged {
            identity_key: identity_key.to_string(),
            limit,
            start_after,
        })
        .await
    }

    async fn get_owned_nymnode(
        &self,
        address: &AccountId,
    ) -> Result<NodeOwnershipResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetOwnedNymNode {
            address: address.to_string(),
        })
        .await
    }

    async fn get_nymnode_details(&self, node_id: NodeId) -> Result<NodeDetailsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNymNodeDetails { node_id })
            .await
    }

    async fn get_nymnode_details_by_identity(
        &self,
        node_identity: IdentityKey,
    ) -> Result<NodeDetailsByIdentityResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNymNodeDetailsByIdentityKey { node_identity })
            .await
    }

    async fn get_nymnode_rewarding_details(
        &self,
        node_id: NodeId,
    ) -> Result<NodeRewardingDetailsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNodeRewardingDetails { node_id })
            .await
    }

    async fn get_node_stake_saturation(
        &self,
        node_id: NodeId,
    ) -> Result<StakeSaturationResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNodeStakeSaturation { node_id })
            .await
    }

    async fn get_unbonded_nymnode_information(
        &self,
        node_id: NodeId,
    ) -> Result<UnbondedNodeResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetUnbondedNymNode { node_id })
            .await
    }

    async fn get_role_assignment(&self, role: Role) -> Result<EpochAssignmentResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetRoleAssignment { role })
            .await
    }

    async fn get_rewarded_set_metadata(&self) -> Result<RolesMetadataResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetRewardedSetMetadata {})
            .await
    }

    // delegation-related:

    /// Gets list of all delegations towards particular mixnode on particular page.
    async fn get_mixnode_delegations_paged(
        &self,
        node_id: NodeId,
        start_after: Option<String>,
        limit: Option<u32>,
    ) -> Result<PagedNodeDelegationsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNodeDelegations {
            node_id,
            start_after,
            limit,
        })
        .await
    }

    /// Gets list of all the mixnodes to which a particular address delegated.
    async fn get_delegator_delegations_paged(
        &self,
        delegator: &AccountId,
        start_after: Option<(NodeId, OwnerProxySubKey)>,
        limit: Option<u32>,
    ) -> Result<PagedDelegatorDelegationsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetDelegatorDelegations {
            delegator: delegator.to_string(),
            start_after,
            limit,
        })
        .await
    }

    /// Checks value of delegation of given client towards particular mixnode.
    async fn get_delegation_details(
        &self,
        node_id: NodeId,
        delegator: &AccountId,
        proxy: Option<String>,
    ) -> Result<NodeDelegationResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetDelegationDetails {
            node_id,
            delegator: delegator.to_string(),
            proxy,
        })
        .await
    }

    /// Gets all the delegations on the entire network
    async fn get_all_network_delegations_paged(
        &self,
        start_after: Option<delegation::StorageKey>,
        limit: Option<u32>,
    ) -> Result<PagedAllDelegationsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetAllDelegations { start_after, limit })
            .await
    }

    // rewards related
    async fn get_pending_operator_reward(
        &self,
        operator: &AccountId,
    ) -> Result<PendingRewardResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPendingOperatorReward {
            address: operator.to_string(),
        })
        .await
    }

    async fn get_pending_mixnode_operator_reward(
        &self,
        node_id: NodeId,
    ) -> Result<PendingRewardResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPendingNodeOperatorReward { node_id })
            .await
    }

    async fn get_pending_delegator_reward(
        &self,
        delegator: &AccountId,
        node_id: NodeId,
        proxy: Option<String>,
    ) -> Result<PendingRewardResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPendingDelegatorReward {
            address: delegator.to_string(),
            node_id,
            proxy,
        })
        .await
    }

    // given the provided performance, estimate the reward at the end of the current epoch
    async fn get_estimated_current_epoch_operator_reward(
        &self,
        node_id: NodeId,
        estimated_performance: Performance,
        estimated_work: Option<WorkFactor>,
    ) -> Result<EstimatedCurrentEpochRewardResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetEstimatedCurrentEpochOperatorReward {
            node_id,
            estimated_performance,
            estimated_work,
        })
        .await
    }

    // given the provided performance, estimate the reward at the end of the current epoch
    async fn get_estimated_current_epoch_delegator_reward(
        &self,
        delegator: &AccountId,
        node_id: NodeId,
        estimated_performance: Performance,
        estimated_work: Option<WorkFactor>,
    ) -> Result<EstimatedCurrentEpochRewardResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetEstimatedCurrentEpochDelegatorReward {
            address: delegator.to_string(),
            node_id,
            estimated_performance,
            estimated_work,
        })
        .await
    }

    // interval-related

    async fn get_pending_epoch_events_paged(
        &self,
        start_after: Option<EpochEventId>,
        limit: Option<u32>,
    ) -> Result<PendingEpochEventsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPendingEpochEvents { start_after, limit })
            .await
    }

    async fn get_pending_interval_events_paged(
        &self,
        start_after: Option<IntervalEventId>,
        limit: Option<u32>,
    ) -> Result<PendingIntervalEventsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPendingIntervalEvents { start_after, limit })
            .await
    }

    async fn get_pending_epoch_event(
        &self,
        event_id: EpochEventId,
    ) -> Result<PendingEpochEventResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPendingEpochEvent { event_id })
            .await
    }

    async fn get_pending_interval_event(
        &self,
        event_id: IntervalEventId,
    ) -> Result<PendingIntervalEventResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetPendingIntervalEvent { event_id })
            .await
    }

    async fn get_number_of_pending_events(
        &self,
    ) -> Result<NumberOfPendingEventsResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetNumberOfPendingEvents {})
            .await
    }

    async fn get_signing_nonce(&self, address: &AccountId) -> Result<Nonce, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetSigningNonce {
            address: address.to_string(),
        })
        .await
    }

    async fn get_key_rotation_state(&self) -> Result<KeyRotationState, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetKeyRotationState {})
            .await
    }

    async fn get_key_rotation_id(&self) -> Result<KeyRotationIdResponse, NyxdError> {
        self.query_mixnet_contract(MixnetQueryMsg::GetKeyRotationId {})
            .await
    }
}

// extension trait to the query client to deal with the paged queries
// (it didn't feel appropriate to combine it with the existing trait
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait PagedMixnetQueryClient: MixnetQueryClient {
    async fn get_all_nymnode_bonds(&self) -> Result<Vec<NymNodeBond>, NyxdError> {
        collect_paged!(self, get_nymnode_bonds_paged, nodes)
    }

    async fn get_all_nymnodes_detailed(&self) -> Result<Vec<NymNodeDetails>, NyxdError> {
        collect_paged!(self, get_nymnodes_detailed_paged, nodes)
    }

    async fn get_all_unbonded_nymnodes(&self) -> Result<Vec<UnbondedNymNode>, NyxdError> {
        collect_paged!(self, get_unbonded_nymnodes_paged, nodes)
    }

    async fn get_all_unbonded_nymnodes_by_owner(
        &self,
        owner: &AccountId,
    ) -> Result<Vec<UnbondedNymNode>, NyxdError> {
        collect_paged!(self, get_unbonded_nymnodes_by_owner_paged, nodes, owner)
    }

    async fn get_all_unbonded_nymnodes_by_identity(
        &self,
        identity_key: IdentityKeyRef<'_>,
    ) -> Result<Vec<UnbondedNymNode>, NyxdError> {
        collect_paged!(
            self,
            get_unbonded_nymnodes_by_identity_paged,
            nodes,
            identity_key
        )
    }

    async fn get_all_mixnode_bonds(&self) -> Result<Vec<MixNodeBond>, NyxdError> {
        collect_paged!(self, get_mixnode_bonds_paged, nodes)
    }

    async fn get_all_mixnodes_detailed(&self) -> Result<Vec<MixNodeDetails>, NyxdError> {
        collect_paged!(self, get_mixnodes_detailed_paged, nodes)
    }

    async fn get_all_unbonded_mixnodes(&self) -> Result<Vec<(NodeId, UnbondedMixnode)>, NyxdError> {
        collect_paged!(self, get_unbonded_mixnodes_paged, nodes)
    }

    async fn get_all_unbonded_mixnodes_by_owner(
        &self,
        owner: &AccountId,
    ) -> Result<Vec<(NodeId, UnbondedMixnode)>, NyxdError> {
        collect_paged!(self, get_unbonded_mixnodes_by_owner_paged, nodes, owner)
    }

    async fn get_all_unbonded_mixnodes_by_identity(
        &self,
        identity_key: IdentityKeyRef<'_>,
    ) -> Result<Vec<(NodeId, UnbondedMixnode)>, NyxdError> {
        collect_paged!(
            self,
            get_unbonded_mixnodes_by_identity_paged,
            nodes,
            identity_key
        )
    }

    async fn get_all_gateways(&self) -> Result<Vec<GatewayBond>, NyxdError> {
        collect_paged!(self, get_gateways_paged, nodes)
    }

    async fn get_all_preassigned_gateway_ids(&self) -> Result<Vec<PreassignedId>, NyxdError> {
        collect_paged!(self, get_preassigned_gateway_ids_paged, ids)
    }

    async fn get_all_single_mixnode_delegations(
        &self,
        mix_id: NodeId,
    ) -> Result<Vec<Delegation>, NyxdError> {
        collect_paged!(self, get_mixnode_delegations_paged, delegations, mix_id)
    }

    async fn get_all_delegator_delegations(
        &self,
        delegation_owner: &AccountId,
    ) -> Result<Vec<Delegation>, NyxdError> {
        collect_paged!(
            self,
            get_delegator_delegations_paged,
            delegations,
            delegation_owner
        )
    }

    async fn get_all_network_delegations(&self) -> Result<Vec<Delegation>, NyxdError> {
        collect_paged!(self, get_all_network_delegations_paged, delegations)
    }

    async fn get_all_pending_epoch_events(&self) -> Result<Vec<PendingEpochEvent>, NyxdError> {
        collect_paged!(self, get_pending_epoch_events_paged, events)
    }

    async fn get_all_pending_interval_events(
        &self,
    ) -> Result<Vec<PendingIntervalEvent>, NyxdError> {
        collect_paged!(self, get_pending_interval_events_paged, events)
    }

    async fn get_full_nym_node_version_history(
        &self,
    ) -> Result<Vec<HistoricalNymNodeVersionEntry>, NyxdError> {
        collect_paged!(self, get_nym_node_version_history_paged, history)
    }
}

#[async_trait]
impl<T> PagedMixnetQueryClient for T where T: MixnetQueryClient {}

// extension help to provide extra functionalities based on existing queries:
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait MixnetQueryClientExt: MixnetQueryClient {
    async fn get_rewarded_set(&self) -> Result<EpochRewardedSet, NyxdError> {
        let error_response = |message| Err(NyxdError::extension_query_failure("mixnet", message));

        // bypass for catch 22 for fresh contracts. we can't refresh cache because there's no rewarded set,
        // but we can't set the rewarded set because we didn't refresh the cache
        let metadata = self.get_rewarded_set_metadata().await?;

        let is_default = metadata.metadata == RewardedSetMetadata::default();
        if !metadata.metadata.fully_assigned && !is_default {
            return error_response("the rewarded set hasn't been fully assigned for this epoch");
        }
        let expected_epoch_id = metadata.metadata.epoch_id;

        if is_default {
            return Ok(Default::default());
        }

        // if we have to query those things more frequently, we could do it concurrently,
        // but as it stands now, it happens so infrequently it might as well be sequential
        let entry = self.get_role_assignment(Role::EntryGateway).await?;
        if entry.epoch_id != expected_epoch_id {
            return error_response("the nodes assigned for 'entry' returned unexpected epoch_id");
        }

        let exit = self.get_role_assignment(Role::ExitGateway).await?;
        if exit.epoch_id != expected_epoch_id {
            return error_response("the nodes assigned for 'exit' returned unexpected epoch_id");
        }

        let layer1 = self.get_role_assignment(Role::Layer1).await?;
        if layer1.epoch_id != expected_epoch_id {
            return error_response("the nodes assigned for 'layer1' returned unexpected epoch_id");
        }

        let layer2 = self.get_role_assignment(Role::Layer2).await?;
        if layer2.epoch_id != expected_epoch_id {
            return error_response("the nodes assigned for 'layer2' returned unexpected epoch_id");
        }

        let layer3 = self.get_role_assignment(Role::Layer3).await?;
        if layer3.epoch_id != expected_epoch_id {
            return error_response("the nodes assigned for 'layer3' returned unexpected epoch_id");
        }

        let standby = self.get_role_assignment(Role::Standby).await?;
        if standby.epoch_id != expected_epoch_id {
            return error_response("the nodes assigned for 'standby' returned unexpected epoch_id");
        }

        Ok(EpochRewardedSet {
            epoch_id: expected_epoch_id,
            assignment: RewardedSet {
                entry_gateways: entry.nodes,
                exit_gateways: exit.nodes,
                layer1: layer1.nodes,
                layer2: layer2.nodes,
                layer3: layer3.nodes,
                standby: standby.nodes,
            },
        })
    }
}

#[async_trait]
impl<T> MixnetQueryClientExt for T where T: MixnetQueryClient {}

#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
impl<C> MixnetQueryClient for C
where
    C: CosmWasmClient + NymContractsProvider + Send + Sync,
{
    async fn query_mixnet_contract<T>(&self, query: MixnetQueryMsg) -> Result<T, NyxdError>
    where
        for<'a> T: Deserialize<'a>,
    {
        let mixnet_contract_address = &self
            .mixnet_contract_address()
            .ok_or_else(|| NyxdError::unavailable_contract_address("mixnet contract"))?;
        self.query_contract_smart(mixnet_contract_address, &query)
            .await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::nyxd::contract_traits::tests::IgnoreValue;
    use nym_mixnet_contract_common::QueryMsg;

    // it's enough that this compiles and clippy is happy about it
    #[allow(dead_code)]
    fn all_query_variants_are_covered<C: MixnetQueryClient + Send + Sync>(
        client: C,
        msg: MixnetQueryMsg,
    ) -> u32 {
        match msg {
            MixnetQueryMsg::Admin {} => client.admin().ignore(),
            MixnetQueryMsg::GetContractVersion {} => client.get_mixnet_contract_version().ignore(),
            MixnetQueryMsg::GetCW2ContractVersion {} => {
                client.get_mixnet_contract_cw2_version().ignore()
            }
            MixnetQueryMsg::GetRewardingValidatorAddress {} => {
                client.get_rewarding_validator_address().ignore()
            }
            MixnetQueryMsg::GetStateParams {} => client.get_mixnet_contract_state_params().ignore(),
            MixnetQueryMsg::GetState {} => client.get_mixnet_contract_state().ignore(),
            MixnetQueryMsg::GetRewardingParams {} => client.get_rewarding_parameters().ignore(),
            MixnetQueryMsg::GetEpochStatus {} => client.get_current_epoch_status().ignore(),
            MixnetQueryMsg::GetCurrentIntervalDetails {} => {
                client.get_current_interval_details().ignore()
            }
            MixnetQueryMsg::GetMixNodeBonds { limit, start_after } => {
                client.get_mixnode_bonds_paged(start_after, limit).ignore()
            }
            MixnetQueryMsg::GetMixNodesDetailed { limit, start_after } => client
                .get_mixnodes_detailed_paged(start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetUnbondedMixNodes { limit, start_after } => client
                .get_unbonded_mixnodes_paged(start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetUnbondedMixNodesByOwner {
                owner,
                limit,
                start_after,
            } => client
                .get_unbonded_mixnodes_by_owner_paged(&owner.parse().unwrap(), start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetUnbondedMixNodesByIdentityKey {
                identity_key,
                limit,
                start_after,
            } => client
                .get_unbonded_mixnodes_by_identity_paged(&identity_key, start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetOwnedMixnode { address } => {
                client.get_owned_mixnode(&address.parse().unwrap()).ignore()
            }
            MixnetQueryMsg::GetMixnodeDetails { mix_id } => {
                client.get_mixnode_details(mix_id).ignore()
            }
            MixnetQueryMsg::GetMixnodeRewardingDetails { mix_id } => {
                client.get_mixnode_rewarding_details(mix_id).ignore()
            }
            MixnetQueryMsg::GetStakeSaturation { mix_id } => {
                client.get_mixnode_stake_saturation(mix_id).ignore()
            }
            MixnetQueryMsg::GetUnbondedMixNodeInformation { mix_id } => {
                client.get_unbonded_mixnode_information(mix_id).ignore()
            }
            MixnetQueryMsg::GetBondedMixnodeDetailsByIdentity { mix_identity } => client
                .get_mixnode_details_by_identity(mix_identity)
                .ignore(),
            MixnetQueryMsg::GetGateways { start_after, limit } => {
                client.get_gateways_paged(start_after, limit).ignore()
            }
            MixnetQueryMsg::GetGatewayBond { identity } => {
                client.get_gateway_bond(identity).ignore()
            }
            MixnetQueryMsg::GetOwnedGateway { address } => {
                client.get_owned_gateway(&address.parse().unwrap()).ignore()
            }
            MixnetQueryMsg::GetNodeDelegations {
                node_id: mix_id,
                start_after,
                limit,
            } => client
                .get_mixnode_delegations_paged(mix_id, start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetDelegatorDelegations {
                delegator,
                start_after,
                limit,
            } => client
                .get_delegator_delegations_paged(&delegator.parse().unwrap(), start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetDelegationDetails {
                node_id: mix_id,
                delegator,
                proxy,
            } => client
                .get_delegation_details(mix_id, &delegator.parse().unwrap(), proxy)
                .ignore(),
            MixnetQueryMsg::GetAllDelegations { start_after, limit } => client
                .get_all_network_delegations_paged(start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetPendingOperatorReward { address } => client
                .get_pending_operator_reward(&address.parse().unwrap())
                .ignore(),
            MixnetQueryMsg::GetPendingNodeOperatorReward { node_id: mix_id } => {
                client.get_pending_mixnode_operator_reward(mix_id).ignore()
            }
            MixnetQueryMsg::GetPendingDelegatorReward {
                address,
                node_id: mix_id,
                proxy,
            } => client
                .get_pending_delegator_reward(&address.parse().unwrap(), mix_id, proxy)
                .ignore(),
            MixnetQueryMsg::GetEstimatedCurrentEpochOperatorReward {
                node_id,
                estimated_performance,
                estimated_work,
            } => client
                .get_estimated_current_epoch_operator_reward(
                    node_id,
                    estimated_performance,
                    estimated_work,
                )
                .ignore(),
            MixnetQueryMsg::GetEstimatedCurrentEpochDelegatorReward {
                address,
                node_id,
                estimated_performance,
                estimated_work,
            } => client
                .get_estimated_current_epoch_delegator_reward(
                    &address.parse().unwrap(),
                    node_id,
                    estimated_performance,
                    estimated_work,
                )
                .ignore(),
            MixnetQueryMsg::GetPendingEpochEvents { limit, start_after } => client
                .get_pending_epoch_events_paged(start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetPendingIntervalEvents { limit, start_after } => client
                .get_pending_interval_events_paged(start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetPendingEpochEvent { event_id } => {
                client.get_pending_epoch_event(event_id).ignore()
            }
            MixnetQueryMsg::GetPendingIntervalEvent { event_id } => {
                client.get_pending_interval_event(event_id).ignore()
            }
            MixnetQueryMsg::GetNumberOfPendingEvents {} => {
                client.get_number_of_pending_events().ignore()
            }
            MixnetQueryMsg::GetSigningNonce { address } => {
                client.get_signing_nonce(&address.parse().unwrap()).ignore()
            }
            MixnetQueryMsg::GetPreassignedGatewayIds { start_after, limit } => client
                .get_preassigned_gateway_ids_paged(start_after, limit)
                .ignore(),
            MixnetQueryMsg::GetNymNodeBondsPaged { limit, start_after } => {
                client.get_nymnode_bonds_paged(limit, start_after).ignore()
            }
            MixnetQueryMsg::GetNymNodesDetailedPaged { limit, start_after } => client
                .get_nymnodes_detailed_paged(limit, start_after)
                .ignore(),
            MixnetQueryMsg::GetUnbondedNymNode { node_id } => {
                client.get_unbonded_nymnode_information(node_id).ignore()
            }
            MixnetQueryMsg::GetUnbondedNymNodesPaged { limit, start_after } => client
                .get_unbonded_nymnodes_paged(limit, start_after)
                .ignore(),
            MixnetQueryMsg::GetUnbondedNymNodesByOwnerPaged {
                owner,
                limit,
                start_after,
            } => client
                .get_unbonded_nymnodes_by_owner_paged(&owner.parse().unwrap(), limit, start_after)
                .ignore(),
            MixnetQueryMsg::GetUnbondedNymNodesByIdentityKeyPaged {
                identity_key,
                limit,
                start_after,
            } => client
                .get_unbonded_nymnodes_by_identity_paged(&identity_key, limit, start_after)
                .ignore(),
            MixnetQueryMsg::GetOwnedNymNode { address } => {
                client.get_owned_nymnode(&address.parse().unwrap()).ignore()
            }
            MixnetQueryMsg::GetNymNodeDetails { node_id } => {
                client.get_nymnode_details(node_id).ignore()
            }
            MixnetQueryMsg::GetNymNodeDetailsByIdentityKey { node_identity } => client
                .get_nymnode_details_by_identity(node_identity)
                .ignore(),
            MixnetQueryMsg::GetNodeRewardingDetails { node_id } => {
                client.get_nymnode_rewarding_details(node_id).ignore()
            }
            MixnetQueryMsg::GetNodeStakeSaturation { node_id } => {
                client.get_node_stake_saturation(node_id).ignore()
            }
            MixnetQueryMsg::GetRoleAssignment { role } => client.get_role_assignment(role).ignore(),
            MixnetQueryMsg::GetRewardedSetMetadata {} => {
                client.get_rewarded_set_metadata().ignore()
            }
            QueryMsg::GetCurrentNymNodeVersion {} => client.get_current_nym_node_version().ignore(),
            QueryMsg::GetNymNodeVersionHistory { limit, start_after } => client
                .get_nym_node_version_history_paged(start_after, limit)
                .ignore(),
            QueryMsg::GetKeyRotationState {} => client.get_key_rotation_state().ignore(),
            QueryMsg::GetKeyRotationId {} => client.get_key_rotation_id().ignore(),
        }
    }
}