evm_rpc_client 0.4.0

use crate::{request::Request, IcError};
use evm_rpc_types::{MultiRpcResult, ProviderError, RpcError, RpcResult};

/// Defines how and when requests made by [`EvmRpcClient`] should be retried.
///
/// A retry policy decides whether a failed request should be retried, and if so,
/// it can modify the request or the result before the next attempt.
/// This allows for flexible strategies such as adding more cycles,
/// or adjusting parameters based on previous failures.
///
/// [`EvmRpcClient`]: crate::EvmRpcClient
pub trait RetryPolicy<Config, Params, CandidOutput, Output> {
    /// Called after a request fails to decide whether it should be retried.
    ///
    /// If the policy decides to retry, it returns the (potentially mutated) request
    /// that will be sent again.
    /// Returning [`None`] means no further retries should be attempted.
    ///
    /// This method _may_ mutate:
    /// - the **request**, for example to add cycles, change parameters, or adjust
    ///   the expected response size.
    /// - the **result**, for example to record retry information or attach metadata.
    /// - the **policy itself**, if it is stateful, e.g., keeping count of the number of attempts.
    ///
    /// Because the policy may be stateful, it should generally be cloned before the first call to
    /// [`RetryPolicy::retry`] if it will be reused.
    fn retry(
        &mut self,
        request: &mut Request<Config, Params, CandidOutput, Output>,
        result: &mut Result<Output, IcError>,
    ) -> Option<Request<Config, Params, CandidOutput, Output>>;

    /// Optionally clones a request before sending it.
    ///
    /// The result of this method will be passed to [`RetryPolicy::retry`] in case of failure.
    /// If it returns [`None`], no retries will be performed.
    fn clone_request(
        &mut self,
        request: &Request<Config, Params, CandidOutput, Output>,
    ) -> Option<Request<Config, Params, CandidOutput, Output>>;
}

/// Never perform any retries.
#[derive(Debug, Clone)]
pub struct NoRetry;

impl<Config, Params, CandidOutput, Output> RetryPolicy<Config, Params, CandidOutput, Output>
    for NoRetry
{
    fn retry(
        &mut self,
        _request: &mut Request<Config, Params, CandidOutput, Output>,
        _result: &mut Result<Output, IcError>,
    ) -> Option<Request<Config, Params, CandidOutput, Output>> {
        None
    }

    fn clone_request(
        &mut self,
        _request: &Request<Config, Params, CandidOutput, Output>,
    ) -> Option<Request<Config, Params, CandidOutput, Output>> {
        None
    }
}

/// Retry strategy where the request is re-tried with double the cycles when it fails due to a
/// [ProviderError::TooFewCycles] error.
#[derive(Debug, Clone)]
pub struct DoubleCycles {
    /// The remaining number of retries.
    num_retries: u32,
}

impl DoubleCycles {
    /// Create a [`DoubleCycles`] policy with the given maximum number of retries.
    pub fn with_max_num_retries(max_num_retries: u32) -> Self {
        DoubleCycles {
            num_retries: max_num_retries,
        }
    }
}

impl<Config, Params, CandidOutput, Output>
    RetryPolicy<Config, Params, CandidOutput, MultiRpcResult<Output>> for DoubleCycles
where
    Request<Config, Params, CandidOutput, MultiRpcResult<Output>>: Clone,
{
    fn retry(
        &mut self,
        request: &mut Request<Config, Params, CandidOutput, MultiRpcResult<Output>>,
        result: &mut Result<MultiRpcResult<Output>, IcError>,
    ) -> Option<Request<Config, Params, CandidOutput, MultiRpcResult<Output>>> {
        fn is_too_few_cycles_result<T>(result: &MultiRpcResult<T>) -> bool {
            fn is_too_few_cycles_error<T>(result: &RpcResult<T>) -> bool {
                matches!(
                    result,
                    Err(RpcError::ProviderError(ProviderError::TooFewCycles { .. }))
                )
            }

            match result {
                MultiRpcResult::Consistent(result) => is_too_few_cycles_error(result),
                MultiRpcResult::Inconsistent(results) => results
                    .iter()
                    .any(|(_, result)| is_too_few_cycles_error(result)),
            }
        }

        match result {
            Ok(result) if is_too_few_cycles_result(result) => {
                if self.num_retries > 0 {
                    self.num_retries = self.num_retries.saturating_sub(1);
                    request.cycles = request.cycles.saturating_mul(2);
                    Some(request.clone())
                } else {
                    None
                }
            }
            _ => None,
        }
    }

    fn clone_request(
        &mut self,
        request: &Request<Config, Params, CandidOutput, MultiRpcResult<Output>>,
    ) -> Option<Request<Config, Params, CandidOutput, MultiRpcResult<Output>>> {
        Some(request.clone())
    }
}