nym/common/client-core/src/error.rs

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

use crate::client::mix_traffic::transceiver::ErasedGatewayError;
use nym_crypto::asymmetric::ed25519::Ed25519RecoveryError;
use nym_gateway_client::error::GatewayClientError;
use nym_task::RegistryAccessError;
use nym_topology::node::RoutingNodeError;
use nym_topology::{NodeId, NymTopologyError};
use nym_validator_client::ValidatorClientError;
use nym_validator_client::nym_api::error::NymAPIError;
use nym_validator_client::nyxd::error::NyxdError;
use rand::distributions::WeightedError;
use std::error::Error;
use std::path::PathBuf;

#[derive(thiserror::Error, Debug)]
pub enum ClientCoreError {
    #[error("could not perform the state migration: {0}")]
    UnsupportedMigration(String),

    #[error("I/O error: {0}")]
    IoError(#[from] std::io::Error),

    #[error("gateway client error ({gateway_id}): {source}")]
    GatewayClientError {
        gateway_id: String,
        source: Box<GatewayClientError>,
    },

    #[error("custom gateway client error: {source}")]
    ErasedGatewayClientError {
        #[from]
        source: ErasedGatewayError,
    },

    #[error("ed25519 error: {0}")]
    Ed25519RecoveryError(#[from] Ed25519RecoveryError),

    #[error("validator client error: {0}")]
    ValidatorClientError(#[from] ValidatorClientError),

    #[error("no gateway with id: {0}")]
    NoGatewayWithId(String),

    #[error("Invalid URL: {0}")]
    InvalidUrl(String),

    #[error("node doesn't advertise ip addresses : {0}")]
    MissingIpAddress(String),

    #[cfg(not(target_arch = "wasm32"))]
    #[error("resolution failed: {0}")]
    ResolutionFailed(#[from] nym_http_api_client::ResolveError),

    #[error("no gateways on network")]
    NoGatewaysOnNetwork,

    #[error(
        "there are no more new gateways on the network - it seems this client has already registered with all nodes it could have"
    )]
    NoNewGatewaysAvailable,

    #[error("list of nym apis is empty")]
    ListOfNymApisIsEmpty,

    #[error("failed to resolve a query to nym API: {source}")]
    NymApiQueryFailure { source: Box<NymAPIError> },

    #[error(
        "the current network topology seem to be insufficient to route any packets through:\n\t{0}"
    )]
    InsufficientNetworkTopology(#[from] NymTopologyError),

    #[error("experienced a failure with our reply surb persistent storage: {source}")]
    SurbStorageError {
        source: Box<dyn Error + Send + Sync>,
    },

    #[error("experienced a failure with our cryptographic keys persistent storage: {source}")]
    KeyStoreError {
        source: Box<dyn Error + Send + Sync>,
    },

    #[error("experienced a failure with our gateways details storage: {source}")]
    GatewaysDetailsStoreError {
        source: Box<dyn Error + Send + Sync>,
    },

    #[error("experienced a failure with our credentials storage: {source}")]
    CredentialStoreError {
        source: Box<dyn Error + Send + Sync>,
    },

    #[error("the provided ticket type is invalid")]
    UnknownTicketType,

    #[error("the gateway id is invalid - {0}")]
    UnableToCreatePublicKeyFromGatewayId(Ed25519RecoveryError),

    #[error("the node is malformed: {source}")]
    MalformedGateway {
        #[from]
        source: Box<RoutingNodeError>,
    },

    #[error("failed to establish connection to gateway: {source}")]
    GatewayConnectionFailure { source: Box<tungstenite::Error> },

    #[cfg(target_arch = "wasm32")]
    #[error("failed to establish gateway connection (wasm)")]
    GatewayJsConnectionFailure,

    #[error("gateway connection was abruptly closed")]
    GatewayConnectionAbruptlyClosed,

    #[error("timed out while trying to establish gateway connection")]
    GatewayConnectionTimeout,

    #[error("failed to forward mix messages to gateway")]
    GatewayFailedToForwardMessages,

    #[error("no ping measurements for the gateway ({identity}) performed")]
    NoGatewayMeasurements { identity: String },

    #[error("failed to register receiver for reconstructed mixnet messages")]
    FailedToRegisterReceiver,

    #[error("unexpected exit")]
    UnexpectedExit,

    #[error(
        "this operation would have resulted in the gateway {gateway_id:?} key being overwritten without permission"
    )]
    ForbiddenGatewayKeyOverwrite { gateway_id: String },

    #[error(
        "this operation would have resulted in clients keys being overwritten without permission"
    )]
    ForbiddenKeyOverwrite,

    #[error("the client doesn't have any gateway set as active")]
    NoActiveGatewaySet,

    #[error("gateway details for gateway {gateway_id:?} are unavailable")]
    UnavailableGatewayDetails {
        gateway_id: String,
        #[source]
        source: Box<dyn Error + Send + Sync>,
    },

    #[error("gateway shared key is unavailable whilst we have full node information")]
    UnavailableSharedKey,

    #[error("attempted to obtain fresh gateway details whilst already knowing about one")]
    UnexpectedGatewayDetails,

    #[error(
        "the provided gateway details (for gateway {gateway_id}) do not correspond to the shared keys"
    )]
    MismatchedGatewayDetails { gateway_id: String },

    #[error("unable to upgrade config file from `{current_version}`")]
    ConfigFileUpgradeFailure { current_version: String },

    #[error("unable to upgrade config file to `{new_version}`")]
    UnableToUpgradeConfigFile { new_version: String },

    #[error("failed to upgrade config file: {message}")]
    UpgradeFailure { message: String },

    #[error("the provided gateway details don't much the stored data")]
    MismatchedStoredGatewayDetails,

    #[error("custom selection of gateway was expected")]
    CustomGatewaySelectionExpected,

    #[error("custom selection of gateway was unexpected")]
    UnexpectedCustomGatewaySelection,

    #[error("the persisted gateway details were set for a custom setup")]
    UnexpectedPersistedCustomGatewayDetails,

    #[error("this client has performed gateway initialisation in another session")]
    NoInitClientPresent,

    #[error("there are no gateways supporting the wss protocol available")]
    NoWssGateways,

    #[error("the specified gateway '{gateway}' does not support the wss protocol")]
    UnsupportedWssProtocol { gateway: String },

    #[error("node {id} ({identity}) does not support mixnet entry mode")]
    UnsupportedEntry { id: NodeId, identity: String },

    #[error(
    "failed to load custom topology using path '{}'. detailed message: {source}", file_path.display()
    )]
    CustomTopologyLoadFailure {
        file_path: PathBuf,
        #[source]
        source: std::io::Error,
    },

    #[error(
    "failed to save config file for client-{typ} id {id} using path '{}'. detailed message: {source}", path.display()
    )]
    ConfigSaveFailure {
        typ: String,
        id: String,
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },

    #[error("the provided gateway identity {gateway_id} is malformed: {source}")]
    MalformedGatewayIdentity {
        gateway_id: String,

        #[source]
        source: Ed25519RecoveryError,
    },

    #[error(
        "the listening address of gateway {gateway_id} ({raw_listener}) is malformed: {source}"
    )]
    MalformedListener {
        gateway_id: String,

        raw_listener: String,

        #[source]
        source: url::ParseError,
    },

    #[error(
        "this client (id: '{client_id}') has already been initialised before. If you want to add additional gateway, use `add-gateway` command"
    )]
    AlreadyInitialised { client_id: String },

    #[error("this client has already registered with gateway {gateway_id}")]
    AlreadyRegistered { gateway_id: String },

    #[error(
        "fresh registration with gateway {gateway_id} somehow requires an additional key upgrade!"
    )]
    UnexpectedKeyUpgrade { gateway_id: String },

    #[error("failed to derive keys from master key")]
    HkdfDerivationError,

    #[error("missing url for constructing RPC client")]
    RpcClientMissingUrl,

    #[error("provided nym network details were malformed: {source}")]
    InvalidNetworkDetails { source: NyxdError },

    #[error("failed to construct RPC client: {source}")]
    RpcClientCreationFailure { source: NyxdError },

    #[error("failed to select valid gateway due to incomputable latency")]
    GatewaySelectionFailure { source: WeightedError },

    #[error("Could not access task registry, {0}")]
    RegistryAccess(#[from] RegistryAccessError),
}

impl From<tungstenite::Error> for ClientCoreError {
    fn from(err: tungstenite::Error) -> ClientCoreError {
        ClientCoreError::GatewayConnectionFailure {
            source: Box::new(err),
        }
    }
}

impl From<NymAPIError> for ClientCoreError {
    fn from(err: NymAPIError) -> ClientCoreError {
        ClientCoreError::NymApiQueryFailure {
            source: Box::new(err),
        }
    }
}

/// Set of messages that the client can send to listeners via the task manager
#[derive(Debug)]
pub enum ClientCoreStatusMessage {
    GatewayIsSlow,
    GatewayIsVerySlow,
}

impl std::fmt::Display for ClientCoreStatusMessage {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ClientCoreStatusMessage::GatewayIsSlow => write!(
                f,
                "The connected gateway is slow, or the connection to it is slow"
            ),
            ClientCoreStatusMessage::GatewayIsVerySlow => write!(
                f,
                "The connected gateway is very slow, or the connection to it is very slow"
            ),
        }
    }
}

impl nym_task::TaskStatusEvent for ClientCoreStatusMessage {
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}