// TODO: don't use RwLock. i think we need a concurrent hashmap or we will hit all sorts of deadlocks mod block_watcher; mod provider; use futures::future; use governor::clock::{Clock, QuantaClock, QuantaInstant}; use governor::middleware::NoOpMiddleware; use governor::state::{InMemoryState, NotKeyed}; use governor::NotUntil; use governor::RateLimiter; use std::collections::HashMap; use std::num::NonZeroU32; use std::sync::Arc; use std::time::Duration; use tokio::sync::{mpsc, RwLock}; use tokio::time::sleep; use tracing::log::warn; use warp::Filter; // use crate::types::{BlockMap, ConnectionsMap, RpcRateLimiterMap}; use crate::block_watcher::{BlockWatcher, BlockWatcherSender}; use crate::provider::Web3Connection; static APP_USER_AGENT: &str = concat!( "satoshiandkin/", env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"), ); type RpcRateLimiter = RateLimiter>; type RpcRateLimiterMap = RwLock>; type ConnectionsMap = RwLock>; /// Load balance to the rpc /// TODO: i'm not sure about having 3 locks here. can we share them? struct RpcTier { /// RPC urls sorted by active requests /// TODO: what type for the rpc? rpcs: RwLock>, connections: Arc, ratelimits: RpcRateLimiterMap, } impl RpcTier { async fn try_new( servers: Vec<(&str, u32)>, http_client: Option, block_watcher_sender: BlockWatcherSender, clock: &QuantaClock, ) -> anyhow::Result { let mut rpcs: Vec = vec![]; let mut connections = HashMap::new(); let mut ratelimits = HashMap::new(); for (s, limit) in servers.into_iter() { rpcs.push(s.to_string()); let connection = Web3Connection::try_new( s.to_string(), http_client.clone(), block_watcher_sender.clone(), ) .await?; connections.insert(s.to_string(), connection); if limit > 0 { let quota = governor::Quota::per_second(NonZeroU32::new(limit).unwrap()); let rate_limiter = governor::RateLimiter::direct_with_clock(quota, clock); ratelimits.insert(s.to_string(), rate_limiter); } } Ok(RpcTier { rpcs: RwLock::new(rpcs), connections: Arc::new(RwLock::new(connections)), ratelimits: RwLock::new(ratelimits), }) } /// get the best available rpc server async fn next_upstream_server(&self) -> Result> { let mut balanced_rpcs = self.rpcs.write().await; // sort rpcs by their active connections let connections = self.connections.read().await; balanced_rpcs .sort_unstable_by(|a, b| connections.get(a).unwrap().cmp(connections.get(b).unwrap())); let mut earliest_not_until = None; for selected_rpc in balanced_rpcs.iter() { // TODO: check current block number. if behind, make our own NotUntil here let ratelimits = self.ratelimits.write().await; // check rate limits match ratelimits.get(selected_rpc).unwrap().check() { Ok(_) => { // rate limit succeeded } Err(not_until) => { // rate limit failed // save the smallest not_until. if nothing succeeds, return an Err with not_until in it if earliest_not_until.is_none() { earliest_not_until = Some(not_until); } else { let earliest_possible = earliest_not_until.as_ref().unwrap().earliest_possible(); let new_earliest_possible = not_until.earliest_possible(); if earliest_possible > new_earliest_possible { earliest_not_until = Some(not_until); } } continue; } }; // increment our connection counter self.connections .write() .await .get_mut(selected_rpc) .unwrap() .inc_active_requests(); // return the selected RPC return Ok(selected_rpc.clone()); } // return the smallest not_until if let Some(not_until) = earliest_not_until { Err(not_until) } else { unimplemented!(); } } /// get all available rpc servers async fn get_upstream_servers(&self) -> Result, NotUntil> { let mut earliest_not_until = None; let mut selected_rpcs = vec![]; for selected_rpc in self.rpcs.read().await.iter() { // check rate limits match self .ratelimits .write() .await .get(selected_rpc) .unwrap() .check() { Ok(_) => { // rate limit succeeded } Err(not_until) => { // rate limit failed // save the smallest not_until. if nothing succeeds, return an Err with not_until in it if earliest_not_until.is_none() { earliest_not_until = Some(not_until); } else { let earliest_possible = earliest_not_until.as_ref().unwrap().earliest_possible(); let new_earliest_possible = not_until.earliest_possible(); if earliest_possible > new_earliest_possible { earliest_not_until = Some(not_until); } } continue; } }; // increment our connection counter self.connections .write() .await .get_mut(selected_rpc) .unwrap() .inc_active_requests(); // this is rpc should work selected_rpcs.push(selected_rpc.clone()); } if !selected_rpcs.is_empty() { return Ok(selected_rpcs); } // return the earliest not_until if let Some(not_until) = earliest_not_until { Err(not_until) } else { // TODO: is this right? Ok(vec![]) } } } /// The application struct Web3ProxyApp { /// clock used for rate limiting /// TODO: use tokio's clock (will require a different ratelimiting crate) clock: QuantaClock, /// Send requests to the best server available balanced_rpc_tiers: Arc>, /// Send private requests (like eth_sendRawTransaction) to all these servers private_rpcs: Option>, /// write lock on these when all rate limits are hit balanced_rpc_ratelimiter_lock: RwLock<()>, private_rpcs_ratelimiter_lock: RwLock<()>, } impl Web3ProxyApp { async fn try_new( balanced_rpc_tiers: Vec>, private_rpcs: Vec<(&str, u32)>, ) -> anyhow::Result { let clock = QuantaClock::default(); let (mut block_watcher, block_watcher_sender) = BlockWatcher::new(clock.clone()); // make a http shared client // TODO: how should we configure the connection pool? // TODO: 5 minutes is probably long enough. unlimited is a bad idea if something let http_client = reqwest::ClientBuilder::new() .timeout(Duration::from_secs(300)) .user_agent(APP_USER_AGENT) .build()?; // start the block_watcher tokio::spawn(async move { block_watcher.run().await }); let balanced_rpc_tiers = Arc::new( future::join_all(balanced_rpc_tiers.into_iter().map(|balanced_rpc_tier| { RpcTier::try_new( balanced_rpc_tier, Some(http_client.clone()), block_watcher_sender.clone(), &clock, ) })) .await .into_iter() .collect::>>()?, ); let private_rpcs = if private_rpcs.is_empty() { None } else { Some(Arc::new( RpcTier::try_new( private_rpcs, Some(http_client), block_watcher_sender, &clock, ) .await?, )) }; // TODO: warn if no private relays Ok(Web3ProxyApp { clock, balanced_rpc_tiers, private_rpcs, balanced_rpc_ratelimiter_lock: Default::default(), private_rpcs_ratelimiter_lock: Default::default(), }) } /// send the request to the approriate RPCs /// TODO: dry this up async fn proxy_web3_rpc( self: Arc, json_body: serde_json::Value, ) -> anyhow::Result { let eth_send_raw_transaction = serde_json::Value::String("eth_sendRawTransaction".to_string()); if self.private_rpcs.is_some() && json_body.get("method") == Some(ð_send_raw_transaction) { let private_rpcs = self.private_rpcs.clone().unwrap(); // there are private rpcs configured and the request is eth_sendSignedTransaction. send to all private rpcs loop { let read_lock = self.private_rpcs_ratelimiter_lock.read().await; match private_rpcs.get_upstream_servers().await { Ok(upstream_servers) => { let (tx, mut rx) = mpsc::unbounded_channel::>(); let clone = self.clone(); let connections = private_rpcs.connections.clone(); let json_body = json_body.clone(); tokio::spawn(async move { clone .try_send_requests(upstream_servers, connections, json_body, tx) .await }); let response = rx .recv() .await .ok_or_else(|| anyhow::anyhow!("no successful response"))?; if let Ok(response) = response { return Ok(warp::reply::json(&response)); } } Err(not_until) => { // TODO: move this to a helper function // sleep (with a lock) until our rate limits should be available drop(read_lock); let write_lock = self.balanced_rpc_ratelimiter_lock.write().await; let deadline = not_until.wait_time_from(self.clock.now()); sleep(deadline).await; drop(write_lock); } }; } } else { // this is not a private transaction (or no private relays are configured) // try to send to each tier, stopping at the first success loop { // TODO: i'm not positive that this locking is correct let read_lock = self.balanced_rpc_ratelimiter_lock.read().await; // there are multiple tiers. save the earliest not_until (if any). if we don't return, we will sleep until then and then try again let mut earliest_not_until = None; for balanced_rpcs in self.balanced_rpc_tiers.iter() { match balanced_rpcs.next_upstream_server().await { Ok(upstream_server) => { let (tx, mut rx) = mpsc::unbounded_channel::>(); let clone = self.clone(); let connections = balanced_rpcs.connections.clone(); let json_body = json_body.clone(); tokio::spawn(async move { clone .try_send_requests( vec![upstream_server], connections, json_body, tx, ) .await }); let response = rx .recv() .await .ok_or_else(|| anyhow::anyhow!("no successful response"))?; if let Ok(response) = response { return Ok(warp::reply::json(&response)); } } Err(not_until) => { // save the smallest not_until. if nothing succeeds, return an Err with not_until in it if earliest_not_until.is_none() { earliest_not_until = Some(not_until); } else { // TODO: do we need to unwrap this far? can we just compare the not_untils let earliest_possible = earliest_not_until.as_ref().unwrap().earliest_possible(); let new_earliest_possible = not_until.earliest_possible(); if earliest_possible > new_earliest_possible { earliest_not_until = Some(not_until); } } } } } // we haven't returned an Ok, sleep and try again // TODO: move this to a helper function drop(read_lock); let write_lock = self.balanced_rpc_ratelimiter_lock.write().await; // unwrap should be safe since we would have returned if it wasn't set let deadline = if let Some(earliest_not_until) = earliest_not_until { earliest_not_until.wait_time_from(self.clock.now()) } else { // TODO: exponential backoff? Duration::from_secs(1) }; sleep(deadline).await; drop(write_lock); } } } async fn try_send_requests( &self, rpc_servers: Vec, connections: Arc, json_request_body: serde_json::Value, tx: mpsc::UnboundedSender>, ) -> anyhow::Result<()> { // {"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1} let incoming_id = json_request_body .get("id") .ok_or_else(|| anyhow::anyhow!("bad id"))? .to_owned(); let method = json_request_body .get("method") .and_then(|x| x.as_str()) .ok_or_else(|| anyhow::anyhow!("bad id"))? .to_string(); let params = json_request_body .get("params") .ok_or_else(|| anyhow::anyhow!("no params"))? .to_owned(); // send the query to all the servers let bodies = future::join_all(rpc_servers.into_iter().map(|rpc| { let incoming_id = incoming_id.clone(); let connections = connections.clone(); let method = method.clone(); let params = params.clone(); let tx = tx.clone(); async move { // get the client for this rpc server let provider = connections.read().await.get(&rpc).unwrap().clone_provider(); let response = provider.request(&method, params).await; connections .write() .await .get_mut(&rpc) .unwrap() .dec_active_requests(); let mut response = response?; // replace the id with what we originally received if let Some(response_id) = response.get_mut("id") { *response_id = incoming_id; } // send the first good response to a one shot channel. that way we respond quickly // drop the result because errors are expected after the first send // TODO: if "no block with that header" or some other jsonrpc errors, skip this response let _ = tx.send(Ok(response)); Ok::<(), anyhow::Error>(()) } })) .await; // TODO: use iterators instead of pushing into a vec let mut errs = vec![]; for x in bodies { match x { Ok(_) => {} Err(e) => { // TODO: better errors warn!("Got an error sending request: {}", e); errs.push(e); } } } // get the first error (if any) let e: anyhow::Result = if !errs.is_empty() { Err(errs.pop().unwrap()) } else { Err(anyhow::anyhow!("no successful responses")) }; // send the error to the channel if tx.send(e).is_ok() { // if we were able to send an error, then we never sent a success return Err(anyhow::anyhow!("no successful responses")); } else { // if sending the error failed. the other side must be closed (which means we sent a success earlier) Ok(()) } } } #[tokio::main] async fn main() { // install global collector configured based on RUST_LOG env var. tracing_subscriber::fmt::init(); // TODO: load the config from yaml instead of hard coding // TODO: support multiple chains in one process. then we could just point "chain.stytt.com" at this and caddy wouldn't need anything else // TODO: i kind of want to make use of caddy's load balancing and health checking and such though let listen_port = 8445; // TODO: be smart about about using archive nodes? let state = Web3ProxyApp::try_new( vec![ // local nodes vec![("ws://10.11.12.16:8545", 0), ("ws://10.11.12.16:8946", 0)], // paid nodes // TODO: add paid nodes (with rate limits) // free nodes // TODO: add rate limits vec![ ("https://main-rpc.linkpool.io", 0), ("https://rpc.ankr.com/eth", 0), ], ], vec![ ("https://api.edennetwork.io/v1/beta", 0), ("https://api.edennetwork.io/v1/", 0), ], ) .await .unwrap(); let state: Arc = Arc::new(state); let proxy_rpc_filter = warp::any() .and(warp::post()) .and(warp::body::json()) .then(move |json_body| state.clone().proxy_web3_rpc(json_body)) .map(handle_anyhow_errors); warp::serve(proxy_rpc_filter) .run(([0, 0, 0, 0], listen_port)) .await; } /// convert result into an http response. use this at the end of your warp filter pub fn handle_anyhow_errors(res: anyhow::Result) -> Box { match res { Ok(r) => Box::new(r.into_response()), // TODO: json error? Err(e) => Box::new(warp::reply::with_status( format!("{}", e), reqwest::StatusCode::INTERNAL_SERVER_ERROR, )), } }