Struct ErrorPayload

pub struct ErrorPayload<ErrData = Box<RawValue>> {
    pub code: i64,
    pub message: Cow<'static, str>,
    pub data: Option<ErrData>,
}

A JSON-RPC 2.0 error object.

This response indicates that the server received and handled the request, but that there was an error in the processing of it. The error should be included in the message field of the response payload.

Fields

code: i64

The error code.

message: Cow<'static, str>

The error message (if any).

data: Option<ErrData>

The error data (if any).

Implementations

impl<E> ErrorPayload<E>

pub const fn parse_error() -> Self

Create a new error payload for a parse error.

pub const fn invalid_request() -> Self

Create a new error payload for an invalid request.

pub const fn method_not_found() -> Self

Create a new error payload for a method not found error.

pub const fn invalid_params() -> Self

Create a new error payload for an invalid params error.

pub const fn internal_error() -> Self

Create a new error payload for an internal error.

pub const fn internal_error_message(message: Cow<'static, str>) -> Self

Create a new error payload for an internal error with a custom message.

pub const fn internal_error_with_obj(data: E) -> Self

where E: RpcObject,

Create a new error payload for an internal error with a custom message and additional data.

pub const fn internal_error_with_message_and_obj( message: Cow<'static, str>, data: E, ) -> Self

where E: RpcObject,

Create a new error payload for an internal error with a custom message

pub fn is_retry_err(&self) -> bool

Analyzes the ErrorPayload and decides if the request should be retried based on the error code or the message.

impl<E> ErrorPayload<E>

where E: RpcObject,

pub fn serialize_payload(&self) -> Result<ErrorPayload>

Serialize the inner data into a RawValue.

impl ErrorPayload<&RawValue>

pub fn into_owned(self) -> ErrorPayload

Convert this borrowed error payload into an owned payload by copying the data from the deserializer (if necessary).

impl<'a, Data> ErrorPayload<Data>

where Data: Borrow<RawValue> + 'a,

pub fn try_data_as<T: Deserialize<'a>>(&'a self) -> Option<Result<T>>

Deserialize the error’s data field, borrowing from the data field if necessary.

Returns

• None if the error has no data field.
• Some(Ok(data)) if the error has a data field that can be deserialized.
• Some(Err(err)) if the error has a data field that can’t be deserialized.

pub fn deser_data<T: DeserializeOwned>(self) -> Result<ErrorPayload<T>, Self>

Attempt to deserialize the data field.

Returns

• Ok(ErrorPayload<T>) if the data field can be deserialized
• Err(self) if the data field can’t be deserialized, or if there is no data field.

pub fn as_revert_data(&self) -> Option<Bytes>

Attempt to extract revert data from the JsonRpcError be recursively traversing the error’s data field

This returns the first hex it finds in the data object, and its behavior may change with serde_json internal changes.

If no hex object is found, it will return an empty bytes IFF the error is a revert

Inspired by ethers-js logic: https://github.com/ethers-io/ethers.js/blob/9f990c57f0486728902d4b8e049536f2bb3487ee/packages/providers/src.ts/json-rpc-provider.ts#L25-L53

pub fn as_decoded_error<E: SolInterface>(&self, validate: bool) -> Option<E>

Extracts revert data and tries decoding it into given custom errors set.

Trait Implementations

impl<ErrData: Clone> Clone for ErrorPayload<ErrData>

fn clone(&self) -> ErrorPayload<ErrData>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<ErrData: Debug> Debug for ErrorPayload<ErrData>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, ErrData: Deserialize<'de>> Deserialize<'de> for ErrorPayload<ErrData>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<ErrData: Display> Display for ErrorPayload<ErrData>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> From<T> for ErrorPayload<T>

where T: Error + RpcObject,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<ErrData: PartialEq> PartialEq for ErrorPayload<ErrData>

fn eq(&self, other: &ErrorPayload<ErrData>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<ErrData> Serialize for ErrorPayload<ErrData>

where ErrData: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<ErrData: Eq> Eq for ErrorPayload<ErrData>

impl<ErrData> StructuralPartialEq for ErrorPayload<ErrData>