web3-proxy/web3_proxy/src/errors.rs
2023-10-23 18:46:53 -07:00

1317 lines
50 KiB
Rust

//! Utlities for logging errors for admins and displaying errors to users.
use crate::frontend::authorization::Authorization;
use crate::jsonrpc::{self, JsonRpcErrorData, ParsedResponse, StreamResponse};
use crate::response_cache::ForwardedResponse;
use crate::rpcs::blockchain::Web3ProxyBlock;
use crate::rpcs::one::Web3Rpc;
use crate::rpcs::provider::EthersHttpProvider;
use axum::extract::rejection::JsonRejection;
use axum::extract::ws::Message;
use axum::{
headers,
http::StatusCode,
response::{IntoResponse, Response},
Json,
};
use derive_more::{Display, Error, From};
use ethers::prelude::ContractError;
use ethers::types::{H256, U64};
use http::header::InvalidHeaderValue;
use http::uri::InvalidUri;
use ipnet::AddrParseError;
use migration::sea_orm::DbErr;
use redis_rate_limiter::redis::RedisError;
use redis_rate_limiter::RedisPoolError;
use reqwest::header::ToStrError;
use rust_decimal::Error as DecimalError;
use serde_json::json;
use serde_json::value::RawValue;
use siwe::VerificationError;
use std::sync::Arc;
use std::time::Duration;
use std::{borrow::Cow, net::IpAddr};
use tokio::{sync::AcquireError, task::JoinError, time::Instant};
use tracing::{debug, error, trace, warn};
pub type Web3ProxyResult<T> = Result<T, Web3ProxyError>;
// TODO: take "IntoResponse" instead of Response?
pub type Web3ProxyResponse = Web3ProxyResult<Response>;
impl From<Web3ProxyError> for Web3ProxyResult<()> {
fn from(value: Web3ProxyError) -> Self {
Err(value)
}
}
#[derive(Debug, Display, Error, From)]
pub enum Web3ProxyError {
Abi(ethers::abi::Error),
#[error(ignore)]
#[from(ignore)]
AccessDenied(Cow<'static, str>),
#[error(ignore)]
Anyhow(anyhow::Error),
Arc(Arc<Self>),
#[from(ignore)]
#[display(fmt = "{:?} to {:?}", min, max)]
ArchiveRequired {
min: Option<U64>,
max: Option<U64>,
},
#[error(ignore)]
#[from(ignore)]
BadRequest(Cow<'static, str>),
#[error(ignore)]
#[from(ignore)]
BadResponse(Cow<'static, str>),
BadRouting,
Contract(ContractError<EthersHttpProvider>),
Database(DbErr),
DatabaseArc(Arc<DbErr>),
Decimal(DecimalError),
EthersHttpClient(ethers::providers::HttpClientError),
EthersProvider(ethers::prelude::ProviderError),
EthersWsClient(ethers::prelude::WsClientError),
#[display(fmt = "{:?} < {}", head, requested)]
#[from(ignore)]
FarFutureBlock {
head: Option<U64>,
requested: U64,
},
GasEstimateNotU256,
HdrRecord(hdrhistogram::errors::RecordError),
Headers(headers::Error),
HeaderToString(ToStrError),
HttpUri(InvalidUri),
Hyper(hyper::Error),
InfluxDb2Request(influxdb2::RequestError),
#[display(fmt = "{} > {}", min, max)]
#[from(ignore)]
InvalidBlockBounds {
min: u64,
max: u64,
},
InvalidHeaderValue(InvalidHeaderValue),
InvalidEip,
InvalidInviteCode,
Io(std::io::Error),
UnknownReferralCode,
InvalidReferer,
InvalidSignatureLength,
InvalidUserTier,
InvalidUserAgent,
InvalidUserKey,
IpAddrParse(AddrParseError),
#[error(ignore)]
#[from(ignore)]
IpNotAllowed(IpAddr),
JoinError(JoinError),
JsonRejection(JsonRejection),
#[display(fmt = "{:?}", _0)]
#[error(ignore)]
JsonRpcErrorData(JsonRpcErrorData),
#[from(ignore)]
#[display(fmt = "{}", _0)]
MdbxPanic(String, Cow<'static, str>),
NoBlockNumberOrHash,
NoBlocksKnown,
NoConsensusHeadBlock,
NoDatabaseConfigured,
NoHandleReady,
NoServersSynced,
#[display(fmt = "{}/{}", num_known, min_head_rpcs)]
#[from(ignore)]
NotEnoughRpcs {
num_known: usize,
min_head_rpcs: usize,
},
#[display(fmt = "{}/{}", available, needed)]
#[from(ignore)]
NotEnoughSoftLimit {
available: u32,
needed: u32,
},
NotFound,
#[error(ignore)]
#[from(ignore)]
MethodNotFound(Cow<'static, str>),
NoVolatileRedisDatabase,
#[error(ignore)]
#[from(ignore)]
#[display(fmt = "{} @ {}", _0, _1)]
OldHead(Arc<Web3Rpc>, Web3ProxyBlock),
OriginRequired,
#[error(ignore)]
#[from(ignore)]
OriginNotAllowed(headers::Origin),
#[display(fmt = "{:?}", _0)]
#[error(ignore)]
ParseBytesError(Option<ethers::types::ParseBytesError>),
ParseMsgError(siwe::ParseError),
ParseAddressError,
#[display(fmt = "{:?}, {:?}", _0, _1)]
RateLimited(Authorization, Option<Instant>),
Redis(RedisError),
RedisDeadpool(RedisPoolError),
RefererRequired,
#[display(fmt = "{:?}", _0)]
#[error(ignore)]
#[from(ignore)]
RefererNotAllowed(headers::Referer),
Reqwest(reqwest::Error),
SemaphoreAcquireError(AcquireError),
SerdeJson(serde_json::Error),
SiweVerification(VerificationError),
/// simple way to return an error message to the user and an anyhow to our logs
#[display(fmt = "{}, {}, {:?}", _0, _1, _2)]
StatusCode(StatusCode, Cow<'static, str>, Option<serde_json::Value>),
#[display(fmt = "streaming response")]
#[error(ignore)]
StreamResponse(StreamResponse<Arc<RawValue>>),
#[cfg(feature = "stripe")]
StripeWebhookError(stripe::WebhookError),
/// TODO: what should be attached to the timout?
#[display(fmt = "{:?}", _0)]
#[error(ignore)]
Timeout(Option<Duration>),
UlidDecode(ulid::DecodeError),
#[error(ignore)]
UnknownBlockHash(H256),
#[display(fmt = "known: {known}, unknown: {unknown}")]
#[error(ignore)]
UnknownBlockNumber {
known: U64,
unknown: U64,
},
UnknownKey,
#[error(ignore)]
UnhandledMethod(Cow<'static, str>),
UserAgentRequired,
#[error(ignore)]
UserAgentNotAllowed(headers::UserAgent),
UserIdZero,
PaymentRequired,
WatchRecvError(tokio::sync::watch::error::RecvError),
WatchSendError,
WebsocketOnly,
#[display(fmt = "{:?}, {}", _0, _1)]
#[error(ignore)]
WithContext(Option<Box<Web3ProxyError>>, Cow<'static, str>),
}
impl Web3ProxyError {
pub fn as_json_response_parts(
&self,
id: Box<RawValue>,
) -> (StatusCode, jsonrpc::SingleResponse) {
let (code, response_data) = self.as_response_parts();
let response = jsonrpc::ParsedResponse::from_response_data(response_data, id);
(code, response.into())
}
/// turn the error into an axum response.
/// <https://www.jsonrpc.org/specification#error_object>
/// TODO? change to `to_response_parts(self)`
pub fn as_response_parts(&self) -> (StatusCode, ForwardedResponse<Arc<RawValue>>) {
// TODO: include a unique request id in the data
let (code, err): (StatusCode, JsonRpcErrorData) = match self {
Self::Abi(err) => {
warn!(?err, "abi error");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "abi error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::AccessDenied(msg) => {
// TODO: attach something to this trace. probably don't include much in the message though. don't want to leak creds by accident
trace!(%msg, "access denied");
(
StatusCode::FORBIDDEN,
JsonRpcErrorData {
message: format!("FORBIDDEN: {}", msg).into(),
code: StatusCode::FORBIDDEN.as_u16().into(),
data: None,
},
)
}
Self::ArchiveRequired { min, max } => {
// TODO: attach something to this trace. probably don't include much in the message though. don't want to leak creds by accident
trace!(?min, ?max, "archive node required");
(
StatusCode::OK,
JsonRpcErrorData {
message: "Archive data required".into(),
code: StatusCode::OK.as_u16().into(),
data: Some(json!({
"min": min,
"max": max,
})),
},
)
}
Self::Anyhow(err) => {
error!(?err, "anyhow: {}", err);
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
// TODO: is it safe to expose all of our anyhow strings?
message: "INTERNAL SERVER ERROR".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::Arc(err) => {
return err.as_response_parts();
}
Self::BadRequest(err) => {
trace!(?err, "BAD_REQUEST");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "bad request".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::BadResponse(err) => {
// TODO: think about this one more. ankr gives us this because ethers fails to parse responses without an id
debug!(?err, "BAD_RESPONSE: {}", err);
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "bad response".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::BadRouting => {
error!("BadRouting");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "bad routing".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: None,
},
)
}
Self::Contract(err) => {
warn!(?err, "Contract Error: {}", err);
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "contract error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::Database(err) => {
error!(?err, "database err: {}", err);
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "database error!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::DatabaseArc(err) => {
error!(?err, "database (arc) err: {}", err);
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "database (arc) error!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::Decimal(err) => {
debug!(?err, "Decimal Error: {}", err);
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "decimal error".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::EthersHttpClient(err) => match JsonRpcErrorData::try_from(err) {
Ok(err) => {
trace!(?err, "EthersHttpClient jsonrpc error");
(StatusCode::OK, err)
}
Err(err) => {
warn!(?err, "EthersHttpClient");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "ethers http client error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
},
Self::EthersProvider(err) => match JsonRpcErrorData::try_from(err) {
Ok(err) => {
trace!(?err, "EthersProvider jsonrpc error");
(StatusCode::OK, err)
}
Err(err) => {
warn!(?err, "EthersProvider");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "ethers provider error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
},
Self::EthersWsClient(err) => match JsonRpcErrorData::try_from(err) {
Ok(err) => {
trace!(?err, "EthersWsClient jsonrpc error");
(StatusCode::OK, err)
}
Err(err) => {
warn!(?err, "EthersWsClient");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "ethers ws client error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
},
Self::FarFutureBlock { head, requested } => {
trace!(?head, ?requested, "FarFutureBlock");
(
StatusCode::OK,
JsonRpcErrorData {
message: "requested block is too far in the future".into(),
code: (-32002).into(),
data: Some(json!({
"head": head,
"requested": requested,
})),
},
)
}
// Self::JsonRpcForwardedError(x) => (StatusCode::OK, x),
Self::GasEstimateNotU256 => {
trace!("GasEstimateNotU256");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "gas estimate result is not an U256".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: None,
},
)
}
Self::HdrRecord(err) => {
warn!(?err, "HdrRecord");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "hdr record error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::Headers(err) => {
trace!(?err, "HeadersError");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "headers error".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::HeaderToString(err) => {
trace!(?err, "HeaderToString");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "header to string error".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::HttpUri(err) => {
trace!(?err, "HttpUri");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: err.to_string().into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::Hyper(err) => {
warn!(?err, "hyper");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
// TODO: is it safe to expose these error strings?
message: err.to_string().into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::InfluxDb2Request(err) => {
// TODO: attach a request id to the message and to this error so that if people report problems, we can dig in sentry to find out more
error!(?err, "influxdb2");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "influxdb2 error!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::InvalidBlockBounds { min, max } => {
trace!(%min, %max, "InvalidBlockBounds");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "Invalid blocks bounds requested".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(json!({
"min": min,
"max": max,
})),
},
)
}
Self::IpAddrParse(err) => {
debug!(?err, "IpAddrParse");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: err.to_string().into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::IpNotAllowed(ip) => {
trace!(?ip, "IpNotAllowed");
(
StatusCode::FORBIDDEN,
JsonRpcErrorData {
message: "IP is not allowed!".into(),
code: StatusCode::FORBIDDEN.as_u16().into(),
data: Some(serde_json::Value::String(ip.to_string())),
},
)
}
Self::InvalidHeaderValue(err) => {
trace!(?err, "InvalidHeaderValue");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "invalid header value".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::InvalidEip => {
trace!("InvalidEip");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "invalid message eip given".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::InvalidInviteCode => {
trace!("InvalidInviteCode");
(
StatusCode::UNAUTHORIZED,
JsonRpcErrorData {
message: "invalid invite code".into(),
code: StatusCode::UNAUTHORIZED.as_u16().into(),
data: None,
},
)
}
Self::Io(err) => {
warn!(?err, "std io");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "std io".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
// TODO: is it safe to expose our io error strings?
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::InvalidReferer => {
trace!("InvalidReferer");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "invalid referer!".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::InvalidSignatureLength => {
trace!("InvalidSignatureLength");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "invalid signature length".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::InvalidUserAgent => {
trace!("InvalidUserAgent");
(
StatusCode::FORBIDDEN,
JsonRpcErrorData {
message: "invalid user agent!".into(),
code: StatusCode::FORBIDDEN.as_u16().into(),
data: None,
},
)
}
Self::InvalidUserKey => {
trace!("InvalidUserKey");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "UserKey was not a ULID or UUID".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::InvalidUserTier => {
warn!("InvalidUserTier");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "UserTier is not valid!".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::JoinError(err) => {
let code = if err.is_cancelled() {
trace!(?err, "JoinError. likely shutting down");
StatusCode::BAD_GATEWAY
} else {
warn!(?err, "JoinError");
StatusCode::INTERNAL_SERVER_ERROR
};
(
code,
JsonRpcErrorData {
// TODO: different messages of cancelled or not?
message: "Unable to complete request".into(),
code: code.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::JsonRejection(err) => {
trace!(?err, "JsonRejection");
let (message, code): (&str, _) = match &err {
JsonRejection::JsonDataError(_) => ("Invalid Request", -32600),
JsonRejection::JsonSyntaxError(_) => ("Parse error", -32700),
JsonRejection::MissingJsonContentType(_) => ("Invalid Request", -32600),
JsonRejection::BytesRejection(_) => ("Invalid Request", -32600),
x => {
warn!(?x, "what? isn't that all of them?");
// TODO: what code should this be?
("Parse error", -32700)
}
};
// TODO: i feel like this should be a 401, but the spec seems to say its a 200
(
StatusCode::OK,
JsonRpcErrorData {
message: message.into(),
code: code.into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::JsonRpcErrorData(jsonrpc_error_data) => {
// TODO: do this without clone? the Arc needed it though
(StatusCode::OK, jsonrpc_error_data.clone())
}
Self::MdbxPanic(rpc, msg) => {
error!(%msg, "mdbx panic");
// TODO: this is bad enough that we should send something to pager duty
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "mdbx panic".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(json!({"rpc": rpc})),
},
)
}
Self::MethodNotFound(method) => {
warn!("MethodNotFound: {}", method);
(
StatusCode::OK,
JsonRpcErrorData {
message: "Method not found".into(),
code: -32601,
data: Some(json!({
"method": method,
"extra": "contact us if you need this",
})),
},
)
}
Self::NoBlockNumberOrHash => {
warn!("NoBlockNumberOrHash");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "Blocks here must have a number or hash".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: None,
},
)
}
Self::NoBlocksKnown => {
error!("NoBlocksKnown");
(
StatusCode::BAD_GATEWAY,
JsonRpcErrorData {
message: "no blocks known".into(),
code: StatusCode::BAD_GATEWAY.as_u16().into(),
data: None,
},
)
}
Self::NoConsensusHeadBlock => {
error!("NoConsensusHeadBlock");
(
StatusCode::BAD_GATEWAY,
JsonRpcErrorData {
message: "no consensus head block".into(),
code: StatusCode::BAD_GATEWAY.as_u16().into(),
data: None,
},
)
}
Self::NoDatabaseConfigured => {
// TODO: this needs more context
debug!("no database configured");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "no database configured! this request needs a database".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: None,
},
)
}
Self::NoHandleReady => {
error!("NoHandleReady");
(
StatusCode::BAD_GATEWAY,
JsonRpcErrorData {
message: "unable to retry for request handle".into(),
code: StatusCode::BAD_GATEWAY.as_u16().into(),
data: None,
},
)
}
Self::NoVolatileRedisDatabase => {
error!("no volatile redis database configured");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "no volatile redis database configured!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: None,
},
)
}
Self::NoServersSynced => {
warn!("NoServersSynced");
(
StatusCode::BAD_GATEWAY,
JsonRpcErrorData {
message: "no servers synced".into(),
code: StatusCode::BAD_GATEWAY.as_u16().into(),
data: None,
},
)
}
Self::NotEnoughRpcs {
num_known,
min_head_rpcs,
} => {
error!(%num_known, %min_head_rpcs, "NotEnoughRpcs");
(
StatusCode::BAD_GATEWAY,
JsonRpcErrorData {
message: format!(
"not enough rpcs connected {}/{}",
num_known, min_head_rpcs
)
.into(),
code: StatusCode::BAD_GATEWAY.as_u16().into(),
data: None,
},
)
}
Self::NotEnoughSoftLimit { available, needed } => {
error!(available, needed, "NotEnoughSoftLimit");
(
StatusCode::BAD_GATEWAY,
JsonRpcErrorData {
message: "not enough soft limit available".into(),
code: StatusCode::BAD_GATEWAY.as_u16().into(),
data: Some(json!({
"available": available,
"needed": needed,
})),
},
)
}
Self::NotFound => {
// TODO: emit a stat?
// TODO: instead of an error, show a normal html page for 404?
(
StatusCode::NOT_FOUND,
JsonRpcErrorData {
message: "not found!".into(),
code: StatusCode::NOT_FOUND.as_u16().into(),
data: None,
},
)
}
Self::OldHead(rpc, old_head) => {
warn!(?old_head, "{} is lagged", rpc);
(
StatusCode::BAD_GATEWAY,
JsonRpcErrorData {
message: "RPC is lagged".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(json!({
"rpc": rpc.name,
"head": old_head,
})),
},
)
}
Self::OriginRequired => {
trace!("OriginRequired");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "Origin required".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::OriginNotAllowed(origin) => {
trace!(?origin, "OriginNotAllowed");
(
StatusCode::FORBIDDEN,
JsonRpcErrorData {
message: "Origin is not allowed!".into(),
code: StatusCode::FORBIDDEN.as_u16().into(),
data: Some(serde_json::Value::String(origin.to_string())),
},
)
}
Self::ParseBytesError(err) => {
trace!(?err, "ParseBytesError");
let data = err
.as_ref()
.map(|x| serde_json::Value::String(x.to_string()));
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "parse bytes error!".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data,
},
)
}
Self::ParseMsgError(err) => {
trace!(?err, "ParseMsgError");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "parse message error!".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::ParseAddressError => {
trace!("ParseAddressError");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "unable to parse address".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::PaymentRequired => {
trace!("PaymentRequiredError");
(
StatusCode::PAYMENT_REQUIRED,
JsonRpcErrorData {
message: "Payment is required to activate premium".into(),
code: StatusCode::PAYMENT_REQUIRED.as_u16().into(),
data: None,
},
)
}
// TODO: this should actually by the id of the key. multiple users might control one key
Self::RateLimited(authorization, retry_at) => {
// TODO: emit a stat
let retry_after = if let Some(retry_at) = retry_at {
retry_at.duration_since(Instant::now()).as_secs()
} else {
// TODO: what should we default to?
60
};
// create a string with either the IP or the rpc_key_id
let retry_data = if authorization.checks.rpc_secret_key_id.is_none() {
json!({"retry_after": retry_after, "ip": authorization.ip})
} else {
json!({"retry_after": retry_after, "ip": authorization.ip, "key_id": authorization.checks.rpc_secret_key_id.unwrap()})
};
(
StatusCode::TOO_MANY_REQUESTS,
JsonRpcErrorData {
message: "too many requests".into(),
code: StatusCode::TOO_MANY_REQUESTS.as_u16().into(),
data: Some(retry_data),
},
)
}
Self::Redis(err) => {
warn!(?err, "redis");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "redis error!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::RedisDeadpool(err) => {
error!(?err, "redis deadpool");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
// TODO: is it safe to expose our io error strings?
message: "redis pool error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::RefererRequired => {
trace!("referer required");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "Referer required".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::RefererNotAllowed(referer) => {
trace!(?referer, "referer not allowed");
(
StatusCode::FORBIDDEN,
JsonRpcErrorData {
message: "Referer is not allowed".into(),
code: StatusCode::FORBIDDEN.as_u16().into(),
data: Some(serde_json::Value::String(format!("{:?}", referer))),
},
)
}
Self::Reqwest(err) => {
warn!(?err, "reqwest");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "reqwest error!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::SemaphoreAcquireError(err) => {
error!(?err, "semaphore acquire");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
// TODO: is it safe to expose all of our anyhow strings?
message: "semaphore acquire error".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::SerdeJson(err) => {
trace!(?err, "serde json");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "de/serialization error!".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::SiweVerification(err) => {
trace!(?err, "Siwe Verification");
(
StatusCode::UNAUTHORIZED,
JsonRpcErrorData {
message: "siwe verification error".into(),
code: StatusCode::UNAUTHORIZED.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::StatusCode(status_code, err_msg, data) => {
// different status codes should get different error levels. 500s should warn. 400s should stat
let code = status_code.as_u16();
if (500..600).contains(&code) {
warn!(?data, "server error {}: {}", code, err_msg);
} else {
trace!(?data, "user error {}: {}", code, err_msg);
}
// TODO: would be great to do this without the cloning! Something blocked that and I didn't write a comment about it though
(
*status_code,
JsonRpcErrorData {
message: err_msg.clone(),
code: code.into(),
data: data.clone(),
},
)
}
Self::StreamResponse(..) => {
// TODO: should it really?
unimplemented!("streaming should be handled elsewhere");
}
#[cfg(feature = "stripe")]
Self::StripeWebhookError(err) => {
trace!(?err, "StripeWebhookError");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "stripe webhook error".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
// TODO: include the stripe signature? anything else?
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::Timeout(x) => {
let data = x.as_ref().map(|x| json!(x.as_secs_f32()));
(
StatusCode::REQUEST_TIMEOUT,
JsonRpcErrorData {
message: "request timed out".into(),
code: StatusCode::REQUEST_TIMEOUT.as_u16().into(),
// TODO: prettier message
// TODO: include the actual id!
data,
},
)
}
Self::UlidDecode(err) => {
trace!(?err, "UlidDecodeError");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "ulid decode error".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::UnhandledMethod(method) => {
unimplemented!(
"unhandled method ({}) should never be shown to a user",
method
);
}
Self::UnknownBlockHash(hash) => {
debug!(%hash, "UnknownBlockHash");
(
StatusCode::OK,
JsonRpcErrorData {
message: "block hash not found".into(),
code: -32000,
data: Some(json!({
"hash": hash,
})),
},
)
}
Self::UnknownBlockNumber { known, unknown } => {
debug!(%known, %unknown, "UnknownBlockNumber");
(
StatusCode::OK,
JsonRpcErrorData {
message: "block number not found".into(),
code: -32000,
data: Some(json!({
"unknown": unknown,
"known": known,
})),
},
)
}
Self::UnknownKey => (
StatusCode::UNAUTHORIZED,
JsonRpcErrorData {
message: "unknown api key!".into(),
code: StatusCode::UNAUTHORIZED.as_u16().into(),
data: None,
},
),
Self::UnknownReferralCode => {
trace!("UnknownReferralCode");
(
StatusCode::UNAUTHORIZED,
JsonRpcErrorData {
message: "invalid referral code".into(),
code: StatusCode::UNAUTHORIZED.as_u16().into(),
data: None,
},
)
}
Self::UserAgentRequired => {
trace!("UserAgentRequired");
(
StatusCode::UNAUTHORIZED,
JsonRpcErrorData {
message: "User agent required".into(),
code: StatusCode::UNAUTHORIZED.as_u16().into(),
data: None,
},
)
}
Self::UserAgentNotAllowed(ua) => {
trace!(%ua, "UserAgentNotAllowed");
(
StatusCode::FORBIDDEN,
JsonRpcErrorData {
message: "User agent is not allowed!".into(),
code: StatusCode::FORBIDDEN.as_u16().into(),
data: Some(serde_json::Value::String(ua.to_string())),
},
)
}
Self::UserIdZero => {
warn!("UserIdZero");
// TODO: this might actually be an application error and not a BAD_REQUEST
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "user ids should always be non-zero".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::WatchRecvError(err) => {
error!(?err, "WatchRecvError");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "watch recv error!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: Some(serde_json::Value::String(err.to_string())),
},
)
}
Self::WatchSendError => {
error!("WatchSendError");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: "watch send error!".into(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: None,
},
)
}
Self::WebsocketOnly => {
trace!("WebsocketOnly. redirect_public_url not set");
(
StatusCode::BAD_REQUEST,
JsonRpcErrorData {
message: "only websockets work here".into(),
code: StatusCode::BAD_REQUEST.as_u16().into(),
data: None,
},
)
}
Self::WithContext(err, msg) => match err {
Some(err) => {
warn!(?err, %msg, "error w/ context");
return err.as_response_parts();
}
None => {
warn!(%msg, "error w/ context");
(
StatusCode::INTERNAL_SERVER_ERROR,
JsonRpcErrorData {
message: msg.clone(),
code: StatusCode::INTERNAL_SERVER_ERROR.as_u16().into(),
data: None,
},
)
}
},
};
(code, ForwardedResponse::from(err))
}
#[inline]
pub fn into_response_with_id(self, id: Option<Box<RawValue>>) -> Response {
let (status_code, response_data) = self.as_response_parts();
let id = id.unwrap_or_default();
let response = ParsedResponse::from_response_data(response_data, id);
(status_code, Json(response)).into_response()
}
/// some things should keep going even if the db is down
pub fn split_db_errors(&self) -> Result<&Self, &Self> {
match self {
Web3ProxyError::NoDatabaseConfigured => Ok(self),
Web3ProxyError::Database(err) => {
warn!(?err, "db error while checking rpc key authorization");
Ok(self)
}
Web3ProxyError::DatabaseArc(err) => {
warn!(?err, "db arc error while checking rpc key authorization");
Ok(self)
}
Web3ProxyError::Arc(x) => {
// errors from inside moka cache helpers are wrapped in an Arc
x.split_db_errors()
}
_ => Err(self),
}
}
}
impl From<ethers::types::ParseBytesError> for Web3ProxyError {
fn from(err: ethers::types::ParseBytesError) -> Self {
Self::ParseBytesError(Some(err))
}
}
impl From<tokio::time::error::Elapsed> for Web3ProxyError {
fn from(_: tokio::time::error::Elapsed) -> Self {
Self::Timeout(None)
}
}
impl IntoResponse for Web3ProxyError {
#[inline]
fn into_response(self) -> Response {
self.into_response_with_id(Default::default())
}
}
pub trait Web3ProxyErrorContext<T> {
fn web3_context<S: Into<Cow<'static, str>>>(self, msg: S) -> Result<T, Web3ProxyError>;
}
impl<T> Web3ProxyErrorContext<T> for Option<T> {
fn web3_context<S: Into<Cow<'static, str>>>(self, msg: S) -> Result<T, Web3ProxyError> {
self.ok_or(Web3ProxyError::WithContext(None, msg.into()))
}
}
impl<T, E> Web3ProxyErrorContext<T> for Result<T, E>
where
E: Into<Web3ProxyError>,
{
fn web3_context<S: Into<Cow<'static, str>>>(self, msg: S) -> Result<T, Web3ProxyError> {
self.map_err(|err| Web3ProxyError::WithContext(Some(Box::new(err.into())), msg.into()))
}
}
impl Web3ProxyError {
pub fn into_message(self, id: Option<Box<RawValue>>) -> Message {
let (_, err) = self.as_response_parts();
let id = id.unwrap_or_default();
let err = ParsedResponse::from_response_data(err, id);
let msg = serde_json::to_string(&err).expect("errors should always serialize to json");
// TODO: what about a binary message?
Message::Text(msg)
}
}