Struct RequestResponseProtocol

pub struct RequestResponseProtocol<I: NodeImplementation<SeqTypes>, V: Versions, N: ConnectedNetwork<PubKey>, P: SequencerPersistence> {
    inner: RequestResponse<Sender, Receiver<Bytes>, Request, RecipientSource<I, V>, DataSource<I, V, N, P>, PubKey>,
    config: RequestResponseConfig,
    public_key: PubKey,
    private_key: BLSPrivKey,
}

A concrete type wrapper around RequestResponse. We need this so that we can implement local traits like StateCatchup. It also helps with readability.

Fields

inner: RequestResponse<Sender, Receiver<Bytes>, Request, RecipientSource<I, V>, DataSource<I, V, N, P>, PubKey>

The actual inner request response protocol

config: RequestResponseConfig

The configuration we used for the above inner protocol. This is nice to have for estimating when we should make another request

public_key: PubKey

The public key of this node

private_key: BLSPrivKey

The private key of this node

Implementations

impl<I: NodeImplementation<SeqTypes>, V: Versions, N: ConnectedNetwork<PubKey>, P: SequencerPersistence> RequestResponseProtocol<I, V, N, P>

pub fn new( config: RequestResponseConfig, sender: Sender, receiver: Receiver<Bytes>, recipient_source: RecipientSource<I, V>, data_source: DataSource<I, V, N, P>, public_key: PubKey, private_key: BLSPrivKey, ) -> Self

Create a new RequestResponseProtocol from the inner

impl<I: NodeImplementation<SeqTypes>, V: Versions, N: ConnectedNetwork<PubKey>, P: SequencerPersistence> RequestResponseProtocol<I, V, N, P>

pub async fn request_indefinitely<F, Fut, O>( &self, request: Request, request_type: RequestType, response_validation_fn: F, ) -> Result<O, RequestError>

where F: Fn(&Request, Response) -> Fut + Send + Sync + 'static + Clone, Fut: Future<Output = Result<O>> + Send + Sync + 'static, O: Send + Sync + 'static + Clone,

Trait Implementations

impl<I: Clone + NodeImplementation<SeqTypes>, V: Clone + Versions, N: Clone + ConnectedNetwork<PubKey>, P: Clone + SequencerPersistence> Clone for RequestResponseProtocol<I, V, N, P>

fn clone(&self) -> RequestResponseProtocol<I, V, N, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: NodeImplementation<SeqTypes>, V: Versions, N: ConnectedNetwork<PubKey>, P: SequencerPersistence> Deref for RequestResponseProtocol<I, V, N, P>

type Target = RequestResponse<Sender, Receiver<Arc<Vec<u8>>>, Request, RecipientSource<I, V>, DataSource<I, V, N, P>, VerKey>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<I: NodeImplementation<SeqTypes>, V: Versions, N: ConnectedNetwork<PubKey>, P: SequencerPersistence> StateCatchup for RequestResponseProtocol<I, V, N, P>

fn try_fetch_leaf<'life0, 'async_trait>( &'life0 self, _retry: usize, height: u64, stake_table: HSStakeTable<SeqTypes>, success_threshold: U256, ) -> Pin<Box<dyn Future<Output = Result<Leaf2>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch the leaf at the given height without retrying on transient errors.

fn try_fetch_accounts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _retry: usize, instance: &'life1 NodeState, height: u64, view: ViewNumber, fee_merkle_tree_root: FeeMerkleCommitment, accounts: &'life2 [FeeAccount], ) -> Pin<Box<dyn Future<Output = Result<Vec<FeeAccountProof>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetch the given list of accounts without retrying on transient errors.

fn try_remember_blocks_merkle_tree<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _retry: usize, instance: &'life1 NodeState, height: u64, view: ViewNumber, mt: &'life2 mut BlockMerkleTree, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetch and remember the blocks frontier without retrying on transient errors.

fn try_fetch_chain_config<'life0, 'async_trait>( &'life0 self, _retry: usize, commitment: Commitment<ChainConfig>, ) -> Pin<Box<dyn Future<Output = Result<ChainConfig>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch the chain config without retrying on transient errors.

fn try_fetch_reward_accounts_v2<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _retry: usize, instance: &'life1 NodeState, height: u64, view: ViewNumber, reward_merkle_tree_root: RewardMerkleCommitmentV2, accounts: &'life2 [RewardAccountV2], ) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV2>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetch the given list of reward accounts without retrying on transient errors.

fn try_fetch_reward_accounts_v1<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _retry: usize, instance: &'life1 NodeState, height: u64, view: ViewNumber, reward_merkle_tree_root: RewardMerkleCommitmentV1, accounts: &'life2 [RewardAccountV1], ) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV1>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetch the given list of reward accounts without retrying on transient errors.

fn backoff(&self) -> &BackoffParams

Returns the backoff parameters for the catchup provider.

fn name(&self) -> String

Returns the name of the catchup provider.

fn fetch_accounts<'life0, 'life1, 'async_trait>( &'life0 self, _instance: &'life1 NodeState, height: u64, view: ViewNumber, fee_merkle_tree_root: FeeMerkleCommitment, accounts: Vec<FeeAccount>, ) -> Pin<Box<dyn Future<Output = Result<Vec<FeeAccountProof>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch the given list of accounts, retrying on transient errors.

fn fetch_leaf<'life0, 'async_trait>( &'life0 self, height: u64, stake_table: HSStakeTable<SeqTypes>, success_threshold: U256, ) -> Pin<Box<dyn Future<Output = Result<Leaf2>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch the leaf at the given height, retrying on transient errors.

fn fetch_chain_config<'life0, 'async_trait>( &'life0 self, commitment: Commitment<ChainConfig>, ) -> Pin<Box<dyn Future<Output = Result<ChainConfig>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch the chain config, retrying on transient errors.

fn remember_blocks_merkle_tree<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _instance: &'life1 NodeState, height: u64, view: ViewNumber, mt: &'life2 mut BlockMerkleTree, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetch and remember the blocks frontier, retrying on transient errors.

fn fetch_reward_accounts_v2<'life0, 'life1, 'async_trait>( &'life0 self, _instance: &'life1 NodeState, height: u64, view: ViewNumber, reward_merkle_tree_root: RewardMerkleCommitmentV2, accounts: Vec<RewardAccountV2>, ) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV2>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch the given list of reward accounts, retrying on transient errors.

fn fetch_reward_accounts_v1<'life0, 'life1, 'async_trait>( &'life0 self, _instance: &'life1 NodeState, height: u64, view: ViewNumber, reward_merkle_tree_root: RewardMerkleCommitmentV1, accounts: Vec<RewardAccountV1>, ) -> Pin<Box<dyn Future<Output = Result<Vec<RewardAccountProofV1>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch the given list of reward accounts, retrying on transient errors.

fn is_local(&self) -> bool

Returns true if the catchup provider is local (e.g. does not make calls to remote resources).