Type Alias BuilderClient

pub type BuilderClient<TYPES> = BuilderClient<TYPES, Version>;

Client for builder API

Aliased Type

struct BuilderClient<TYPES> {
    client: Client<Error, StaticVersion<0, 1>>,
    _marker: PhantomData<TYPES>,
}

Fields

client: Client<Error, StaticVersion<0, 1>>

Underlying surf_disco::Client for the legacy builder api

_marker: PhantomData<TYPES>

Marker for NodeType used here

Implementations

impl<TYPES: NodeType> BuilderClient<TYPES>

pub async fn claim_block_header_input( &self, block_hash: BuilderCommitment, view_number: u64, sender: TYPES::SignatureKey, signature: &<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType, ) -> Result<AvailableBlockHeaderInputV2<TYPES>, BuilderClientError>

Claim block header input

Errors

• BuilderClientError::BlockNotFound if block isn’t available
• BuilderClientError::Api if API isn’t responding or responds incorrectly

pub async fn claim_legacy_block_header_input( &self, block_hash: BuilderCommitment, view_number: u64, sender: TYPES::SignatureKey, signature: &<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType, ) -> Result<AvailableBlockHeaderInputV2Legacy<TYPES>, BuilderClientError>

Claim block header input, using the legacy AvailableBlockHeaderInputV2Legacy type

Errors

• BuilderClientError::BlockNotFound if block isn’t available
• BuilderClientError::Api if API isn’t responding or responds incorrectly

pub async fn claim_either_block_header_input( &self, block_hash: BuilderCommitment, view_number: u64, sender: TYPES::SignatureKey, signature: &<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType, ) -> Result<AvailableBlockHeaderInputV2Either<TYPES>, BuilderClientError>

Claim block header input, preferring the current AvailableBlockHeaderInputV2 type but falling back to the AvailableBlockHeaderInputV2Legacy type

Errors

• BuilderClientError::BlockNotFound if block isn’t available
• BuilderClientError::Api if API isn’t responding or responds incorrectly

pub async fn claim_block( &self, block_hash: BuilderCommitment, view_number: u64, sender: TYPES::SignatureKey, signature: &<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType, ) -> Result<AvailableBlockData<TYPES>, BuilderClientError>

Claim block

Errors

• BuilderClientError::BlockNotFound if block isn’t available
• BuilderClientError::Api if API isn’t responding or responds incorrectly

pub async fn claim_block_with_num_nodes( &self, block_hash: BuilderCommitment, view_number: u64, sender: TYPES::SignatureKey, signature: &<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType, num_nodes: usize, ) -> Result<AvailableBlockData<TYPES>, BuilderClientError>

Claim block and provide the number of nodes information to the builder for VID computation.

Errors

• BuilderClientError::BlockNotFound if block isn’t available
• BuilderClientError::Api if API isn’t responding or responds incorrectly