Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CBST-02: add retries #187

Merged
merged 2 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions crates/common/src/pbs/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ impl PbsError {
pub fn is_timeout(&self) -> bool {
matches!(self, PbsError::Reqwest(err) if err.is_timeout())
}

/// Whether the error is retryable in requests to relays
pub fn should_retry(&self) -> bool {
matches!(self, PbsError::RelayResponse { .. } | PbsError::Reqwest { .. })
}
}

#[derive(Debug, Error, PartialEq, Eq)]
Expand Down
53 changes: 50 additions & 3 deletions crates/pbs/src/mev_boost/register_validator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use eyre::bail;
use futures::future::{join_all, select_ok};
use reqwest::header::USER_AGENT;
use tracing::{debug, error, Instrument};
use url::Url;

use crate::{
constants::{MAX_SIZE_DEFAULT, REGISTER_VALIDATOR_ENDPOINT_TAG, TIMEOUT_ERROR_CODE_STR},
Expand All @@ -35,7 +36,7 @@ pub async fn register_validator<S: BuilderApiState>(
let mut handles = Vec::with_capacity(relays.len());
for relay in relays {
handles.push(tokio::spawn(
send_register_validator(
send_register_validator_with_timeout(
registrations.clone(),
relay,
send_headers.clone(),
Expand Down Expand Up @@ -63,15 +64,61 @@ pub async fn register_validator<S: BuilderApiState>(
}
}

#[tracing::instrument(skip_all, name = "handler", fields(relay_id = relay.id.as_ref()))]
async fn send_register_validator(
/// Register validator to relay, retry connection errors until the
/// given timeout has passed
async fn send_register_validator_with_timeout(
registrations: Vec<ValidatorRegistration>,
relay: RelayClient,
headers: HeaderMap,
timeout_ms: u64,
) -> Result<(), PbsError> {
let url = relay.register_validator_url()?;
let mut remaining_timeout_ms = timeout_ms;
let mut retry = 0;
let mut backoff = Duration::from_millis(250);

loop {
ltitanb marked this conversation as resolved.
Show resolved Hide resolved
let start_request = Instant::now();
match send_register_validator(
url.clone(),
&registrations,
&relay,
headers.clone(),
remaining_timeout_ms,
retry,
)
.await
{
Ok(_) => return Ok(()),

Err(err) if err.should_retry() => {
tokio::time::sleep(backoff).await;
backoff += Duration::from_millis(250);

remaining_timeout_ms =
timeout_ms.saturating_sub(start_request.elapsed().as_millis() as u64);

if remaining_timeout_ms == 0 {
return Err(err);
}
}

Err(err) => return Err(err),
};

retry += 1;
}
}

#[tracing::instrument(skip_all, name = "handler", fields(relay_id = relay.id.as_ref(), retry = retry))]
async fn send_register_validator(
url: Url,
registrations: &[ValidatorRegistration],
relay: &RelayClient,
headers: HeaderMap,
timeout_ms: u64,
retry: u32,
) -> Result<(), PbsError> {
let start_request = Instant::now();
let res = match relay
.client
Expand Down
57 changes: 52 additions & 5 deletions crates/pbs/src/mev_boost/submit_block.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ use cb_common::{
use futures::future::select_ok;
use reqwest::header::USER_AGENT;
use tracing::{debug, warn};
use url::Url;

use crate::{
constants::{MAX_SIZE_SUBMIT_BLOCK, SUBMIT_BLINDED_BLOCK_ENDPOINT_TAG, TIMEOUT_ERROR_CODE_STR},
Expand All @@ -37,11 +38,11 @@ pub async fn submit_block<S: BuilderApiState>(
let relays = state.relays();
let mut handles = Vec::with_capacity(relays.len());
for relay in relays.iter() {
handles.push(Box::pin(send_submit_block(
handles.push(Box::pin(submit_block_with_timeout(
&signed_blinded_block,
relay,
send_headers.clone(),
state.config.pbs_config.timeout_get_payload_ms,
state.pbs_config().timeout_get_payload_ms,
)));
}

Expand All @@ -52,17 +53,63 @@ pub async fn submit_block<S: BuilderApiState>(
}
}

/// Submit blinded block to relay, retry connection errors until the
/// given timeout has passed
async fn submit_block_with_timeout(
signed_blinded_block: &SignedBlindedBeaconBlock,
relay: &RelayClient,
headers: HeaderMap,
timeout_ms: u64,
) -> Result<SubmitBlindedBlockResponse, PbsError> {
let url = relay.submit_block_url()?;
let mut remaining_timeout_ms = timeout_ms;
let mut retry = 0;
let mut backoff = Duration::from_millis(250);

loop {
let start_request = Instant::now();
match send_submit_block(
url.clone(),
signed_blinded_block,
relay,
headers.clone(),
remaining_timeout_ms,
retry,
)
.await
{
Ok(response) => return Ok(response),

Err(err) if err.should_retry() => {
tokio::time::sleep(backoff).await;
backoff += Duration::from_millis(250);

remaining_timeout_ms =
timeout_ms.saturating_sub(start_request.elapsed().as_millis() as u64);

if remaining_timeout_ms == 0 {
return Err(err);
}
}

Err(err) => return Err(err),
};

retry += 1;
}
}

// submits blinded signed block and expects the execution payload + blobs bundle
// back
#[tracing::instrument(skip_all, name = "handler", fields(relay_id = relay.id.as_ref()))]
#[tracing::instrument(skip_all, name = "handler", fields(relay_id = relay.id.as_ref(), retry = retry))]
async fn send_submit_block(
url: Url,
signed_blinded_block: &SignedBlindedBeaconBlock,
relay: &RelayClient,
headers: HeaderMap,
timeout_ms: u64,
retry: u32,
) -> Result<SubmitBlindedBlockResponse, PbsError> {
let url = relay.submit_block_url()?;

let start_request = Instant::now();
let res = match relay
.client
Expand Down