pezkuwi-subxt/historic/src/error.rs

/// Any error emitted by this crate can convert into this.
// Dev Note: All errors here are transparent, because in many places
// the inner errors are returned and so need to provide enough context
// as-is, so there shouldn't be anything to add here.
#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    #[error(transparent)]
    OnlineClientError(#[from] OnlineClientError),
    #[error(transparent)]
    OfflineClientAtBlockError(#[from] OfflineClientAtBlockError),
    #[error(transparent)]
    OnlineClientAtBlockError(#[from] OnlineClientAtBlockError),
    #[error(transparent)]
    ExtrinsicsError(#[from] ExtrinsicsError),
    #[error(transparent)]
    ExtrinsicTransactionExtensionError(#[from] ExtrinsicTransactionExtensionError),
    #[error(transparent)]
    ExtrinsicCallError(#[from] ExtrinsicCallError),
    #[error(transparent)]
    StorageError(#[from] StorageError),
    #[error(transparent)]
    StorageEntryIsNotAMap(#[from] StorageEntryIsNotAMap),
    #[error(transparent)]
    StorageEntryIsNotAPlainValue(#[from] StorageEntryIsNotAPlainValue),
    #[error(transparent)]
    StorageKeyError(#[from] StorageKeyError),
    #[error(transparent)]
    StorageValueError(#[from] StorageValueError),
}

/// Errors constructing an online client.
#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum OnlineClientError {
    #[error("Cannot construct OnlineClient: The URL provided is invalid: {url}")]
    InvalidUrl {
        /// The URL that was invalid.
        url: String,
    },
    #[error("Cannot construct OnlineClient owing to an RPC client error: {0}")]
    RpcClientError(#[from] subxt_rpcs::Error),
}

/// Errors constructing an offline client at a specific block number.
#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum OfflineClientAtBlockError {
    #[error(
        "Cannot construct OfflineClientAtBlock: spec version not found for block number {block_number}"
    )]
    SpecVersionNotFound {
        /// The block number for which the spec version was not found.
        block_number: u64,
    },
    #[error(
        "Cannot construct OfflineClientAtBlock: metadata not found for spec version {spec_version}"
    )]
    MetadataNotFound {
        /// The spec version for which the metadata was not found.
        spec_version: u32,
    },
}

/// Errors constructing an online client at a specific block number.
#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum OnlineClientAtBlockError {
    #[error(
        "Cannot construct OnlineClientAtBlock: failed to get block hash from node for block {block_number}: {reason}"
    )]
    CannotGetBlockHash {
        /// Block number we failed to get the hash for.
        block_number: u64,
        /// The error we encountered.
        reason: subxt_rpcs::Error,
    },
    #[error("Cannot construct OnlineClientAtBlock: block number {block_number} not found")]
    BlockNotFound {
        /// The block number for which a block was not found.
        block_number: u64,
    },
    #[error(
        "Cannot construct OnlineClientAtBlock: failed to get spec version for block hash {block_hash}: {reason}"
    )]
    CannotGetSpecVersion {
        /// The block hash for which we failed to get the spec version.
        block_hash: String,
        /// The error we encountered.
        reason: String,
    },
    #[error(
        "Cannot construct OnlineClientAtBlock: failed to get metadata for block hash {block_hash}: {reason}"
    )]
    CannotGetMetadata {
        /// The block hash for which we failed to get the metadata.
        block_hash: String,
        /// The error we encountered.
        reason: String,
    },
    #[error(
        "Cannot inject types from metadata: failure to parse a type found in the metadata: {parse_error}"
    )]
    CannotInjectMetadataTypes {
        /// Error parsing a type found in the metadata.
        parse_error: scale_info_legacy::lookup_name::ParseError,
    },
}

/// Errors working with extrinsics.
#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum ExtrinsicsError {
    #[error("Could not fetch extrinsics: {reason}")]
    FetchError {
        /// The error that occurred while fetching the extrinsics.
        reason: subxt_rpcs::Error,
    },
    #[error("Could not decode extrinsic at index {index}: {reason}")]
    DecodeError {
        /// The extrinsic index that failed to decode.
        index: usize,
        /// The error that occurred during decoding.
        reason: frame_decode::extrinsics::ExtrinsicDecodeError,
    },
    #[error(
        "Could not decode extrinsic at index {index}: there were undecoded bytes at the end, which implies that we did not decode it properly"
    )]
    LeftoverBytes {
        /// The extrinsic index that had leftover bytes
        index: usize,
        /// The bytes that were left over after decoding the extrinsic.
        leftover_bytes: Vec<u8>,
    },
    #[error("Could not decode extrinsics: Unsupported metadata version ({version})")]
    UnsupportedMetadataVersion {
        /// The metadata version that is not supported.
        version: u32,
    },
}

#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum ExtrinsicTransactionExtensionError {
    #[error("Could not decode extrinsic transaction extensions: {reason}")]
    AllDecodeError {
        /// The error that occurred while decoding the transaction extensions.
        reason: scale_decode::Error,
    },
    #[error(
        "Could not decode extrinsic transaction extensions: there were undecoded bytes at the end, which implies that we did not decode it properly"
    )]
    AllLeftoverBytes {
        /// The bytes that were left over after decoding the transaction extensions.
        leftover_bytes: Vec<u8>,
    },
    #[error("Could not decode extrinsic transaction extension {name}: {reason}")]
    DecodeError {
        /// The name of the transaction extension that failed to decode.
        name: String,
        /// The error that occurred during decoding.
        reason: scale_decode::Error,
    },
    #[error(
        "Could not decode extrinsic transaction extension {name}: there were undecoded bytes at the end, which implies that we did not decode it properly"
    )]
    LeftoverBytes {
        /// The name of the transaction extension that had leftover bytes.
        name: String,
        /// The bytes that were left over after decoding the transaction extension.
        leftover_bytes: Vec<u8>,
    },
}

#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum ExtrinsicCallError {
    #[error("Could not decode the fields in extrinsic call: {reason}")]
    FieldsDecodeError {
        /// The error that occurred while decoding the fields of the extrinsic call.
        reason: scale_decode::Error,
    },
    #[error(
        "Could not decode the fields in extrinsic call: there were undecoded bytes at the end, which implies that we did not decode it properly"
    )]
    FieldsLeftoverBytes {
        /// The bytes that were left over after decoding the extrinsic call.
        leftover_bytes: Vec<u8>,
    },
    #[error("Could not decode field {name} in extrinsic call: {reason}")]
    FieldDecodeError {
        /// The name of the field that failed to decode.
        name: String,
        /// The error that occurred during decoding.
        reason: scale_decode::Error,
    },
    #[error(
        "Could not decode field {name} in extrinsic call: there were undecoded bytes at the end, which implies that we did not decode it properly"
    )]
    FieldLeftoverBytes {
        /// The name of the field that had leftover bytes.
        name: String,
        /// The bytes that were left over after decoding the extrinsic call.
        leftover_bytes: Vec<u8>,
    },
}

#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[error("Storage entry is not a map: pallet {pallet_name}, storage {storage_name}")]
pub struct StorageEntryIsNotAMap {
    /// The pallet containing the storage entry that was not found.
    pub pallet_name: String,
    /// The storage entry that was not found.
    pub storage_name: String,
}

#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[error("Storage entry is not a plain value: pallet {pallet_name}, storage {storage_name}")]
pub struct StorageEntryIsNotAPlainValue {
    /// The pallet containing the storage entry that was not found.
    pub pallet_name: String,
    /// The storage entry that was not found.
    pub storage_name: String,
}

#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum StorageError {
    #[error("RPC error interacting with storage APIs: {reason}")]
    RpcError {
        /// The error that occurred while fetching the storage entry.
        reason: subxt_rpcs::Error,
    },
    #[error("Could not fetch next entry from storage subscription: {reason}")]
    StorageEventError {
        /// The error that occurred while fetching the next storage entry.
        reason: String,
    },
    #[error("Could not construct storage key: {reason}")]
    KeyEncodeError {
        /// The error that occurred while constructing the storage key.
        reason: frame_decode::storage::StorageKeyEncodeError,
    },
    #[error(
        "Too many keys provided: expected {num_keys_expected} keys, but got {num_keys_provided}"
    )]
    WrongNumberOfKeysProvided {
        /// The number of keys that were provided.
        num_keys_provided: usize,
        /// The number of keys expected.
        num_keys_expected: usize,
    },
    #[error(
        "Could not extract storage information from metadata: Unsupported metadata version ({version})"
    )]
    UnsupportedMetadataVersion {
        /// The metadata version that is not supported.
        version: u32,
    },
    #[error("Could not extract storage information from metadata: {reason}")]
    ExtractStorageInfoError {
        /// The error that occurred while extracting storage information from the metadata.
        reason: frame_decode::storage::StorageInfoError<'static>,
    },
}

#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum StorageKeyError {
    #[error("Could not decode the storage key: {reason}")]
    DecodeError {
        /// The error that occurred while decoding the storage key information.
        reason: frame_decode::storage::StorageKeyDecodeError<String>,
    },
    #[error(
        "Could not decode the storage key: there were undecoded bytes at the end, which implies that we did not decode it properly"
    )]
    LeftoverBytes {
        /// The bytes that were left over after decoding the storage key.
        leftover_bytes: Vec<u8>,
    },
    #[error("Could not decode the part of the storage key at index {index}: {reason}")]
    DecodePartError {
        index: usize,
        reason: scale_decode::Error,
    },
}

#[allow(missing_docs)]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum StorageValueError {
    #[error("Could not decode storage value: {reason}")]
    DecodeError {
        /// The error that occurred while decoding the storage value.
        reason: scale_decode::Error,
    },
    #[error(
        "Could not decode storage value: there were undecoded bytes at the end, which implies that we did not decode it properly"
    )]
    LeftoverBytes {
        /// The bytes that were left over after decoding the storage value.
        leftover_bytes: Vec<u8>,
    },
}