near-api 0.8.6

Rust library to interact with NEAR Protocol via RPC API
Documentation
// New errors can be added to the codebase, so we want to handle them gracefully
#![allow(unreachable_patterns)]

use base64::{Engine, prelude::BASE64_STANDARD};
use near_api_types::NearToken;
use near_openapi_client::types::{
    RpcBlockError, RpcLightClientProofError, RpcQueryError, RpcReceiptError, RpcTransactionError,
    RpcValidatorError,
};
use reqwest::StatusCode;

use crate::{config::RetryResponse, errors::SendRequestError};

pub fn to_base64(input: &[u8]) -> String {
    BASE64_STANDARD.encode(input)
}

pub fn from_base64(encoded: &str) -> Result<Vec<u8>, base64::DecodeError> {
    BASE64_STANDARD.decode(encoded)
}

/// Converts [crate::Data]<[u128]>] to [crate::NearToken].
pub const fn near_data_to_near_token(data: near_api_types::Data<u128>) -> NearToken {
    NearToken::from_yoctonear(data.data)
}

pub fn to_retry_error<T, E: std::fmt::Debug + Send + Sync>(
    err: SendRequestError<E>,
    is_critical_t: impl Fn(&SendRequestError<E>) -> bool,
) -> RetryResponse<T, SendRequestError<E>> {
    if is_critical_t(&err) {
        RetryResponse::Critical(err)
    } else {
        RetryResponse::Retry(err)
    }
}

pub fn is_critical_blocks_error(err: &SendRequestError<RpcBlockError>) -> bool {
    is_critical_json_rpc_error(err, |err| match err {
        RpcBlockError::UnknownBlock { .. }
        | RpcBlockError::NotSyncedYet
        | RpcBlockError::InternalError { .. } => false,
        _ => false,
    })
}

pub fn is_critical_validator_error(err: &SendRequestError<RpcValidatorError>) -> bool {
    is_critical_json_rpc_error(err, |err| match err {
        RpcValidatorError::UnknownEpoch
        | RpcValidatorError::ValidatorInfoUnavailable
        | RpcValidatorError::InternalError { .. } => false,
        _ => false,
    })
}
pub fn is_critical_query_error(err: &SendRequestError<RpcQueryError>) -> bool {
    is_critical_json_rpc_error(err, |err| match err {
        RpcQueryError::NoSyncedBlocks
        | RpcQueryError::UnavailableShard { .. }
        | RpcQueryError::UnknownBlock { .. }
        | RpcQueryError::InternalError { .. } => false,

        RpcQueryError::GarbageCollectedBlock { .. }
        | RpcQueryError::InvalidAccount { .. }
        | RpcQueryError::UnknownAccount { .. }
        | RpcQueryError::NoContractCode { .. }
        | RpcQueryError::TooLargeContractState { .. }
        | RpcQueryError::UnknownAccessKey { .. }
        | RpcQueryError::ContractExecutionError { .. }
        | RpcQueryError::UnknownGasKey { .. } => true,

        // Might be critical, but also might not yet propagated across the network, so we will retry
        RpcQueryError::NoGlobalContractCode { .. } => false,
        _ => false,
    })
}

pub fn is_critical_transaction_error(err: &SendRequestError<RpcTransactionError>) -> bool {
    is_critical_json_rpc_error(err, |err| match err {
        RpcTransactionError::TimeoutError | RpcTransactionError::RequestRouted { .. } => false,
        RpcTransactionError::InvalidTransaction { .. }
        | RpcTransactionError::DoesNotTrackShard
        | RpcTransactionError::UnknownTransaction { .. }
        | RpcTransactionError::InternalError { .. } => true,
        _ => false,
    })
}

pub fn is_critical_transaction_status_error(err: &SendRequestError<RpcTransactionError>) -> bool {
    is_critical_json_rpc_error(err, |err| match err {
        RpcTransactionError::TimeoutError
        | RpcTransactionError::RequestRouted { .. }
        | RpcTransactionError::UnknownTransaction { .. }
        | RpcTransactionError::DoesNotTrackShard
        | RpcTransactionError::InternalError { .. } => false,

        RpcTransactionError::InvalidTransaction { .. } => true,

        _ => false,
    })
}

pub fn is_critical_receipt_error(err: &SendRequestError<RpcReceiptError>) -> bool {
    is_critical_json_rpc_error(err, |err| match err {
        RpcReceiptError::InternalError { .. } => false,
        RpcReceiptError::UnknownReceipt { .. } => true,
        _ => false,
    })
}

pub fn is_critical_light_client_proof_error(
    err: &SendRequestError<RpcLightClientProofError>,
) -> bool {
    is_critical_json_rpc_error(err, |err| match err {
        RpcLightClientProofError::UnknownBlock { .. }
        | RpcLightClientProofError::InternalError { .. }
        | RpcLightClientProofError::UnavailableShard { .. } => false,

        RpcLightClientProofError::InconsistentState { .. }
        | RpcLightClientProofError::NotConfirmed { .. }
        | RpcLightClientProofError::UnknownTransactionOrReceipt { .. } => true,

        _ => false,
    })
}

fn is_critical_json_rpc_error<RpcError: std::fmt::Debug + Send + Sync>(
    err: &SendRequestError<RpcError>,
    is_critical_t: impl Fn(&RpcError) -> bool,
) -> bool {
    match err {
        SendRequestError::ServerError(rpc_error) => is_critical_t(rpc_error),
        SendRequestError::WasmExecutionError(_) => true,
        SendRequestError::InternalError { .. } => false,
        SendRequestError::RequestValidationError(_) => true,
        SendRequestError::RequestCreationError(_) => true,
        SendRequestError::TransportError(error) => match error {
            near_openapi_client::Error::InvalidRequest(_)
            | near_openapi_client::Error::CommunicationError(_)
            | near_openapi_client::Error::InvalidUpgrade(_)
            | near_openapi_client::Error::ResponseBodyError(_)
            | near_openapi_client::Error::InvalidResponsePayload(_, _)
            | near_openapi_client::Error::UnexpectedResponse(_)
            | near_openapi_client::Error::Custom(_) => true,

            near_openapi_client::Error::ErrorResponse(response_value) => {
                // It's more readable to use a match statement than a macro
                #[allow(clippy::match_like_matches_macro)]
                match response_value.status() {
                    StatusCode::REQUEST_TIMEOUT
                    | StatusCode::TOO_MANY_REQUESTS
                    | StatusCode::INTERNAL_SERVER_ERROR
                    | StatusCode::BAD_GATEWAY
                    | StatusCode::SERVICE_UNAVAILABLE
                    | StatusCode::GATEWAY_TIMEOUT => false,
                    _ => true,
                }
            }
            _ => false,
        },
        _ => false,
    }
}