Struct hotshot_task_impls::builder::BuilderClient

pub struct BuilderClient<TYPES: NodeType, Ver: StaticVersionType> {
    client: Client<Error, Ver>,
    _marker: PhantomData<TYPES>,
}

Client for builder API

Fields

client: Client<Error, Ver>

Underlying surf_disco::Client for the legacy builder api

_marker: PhantomData<TYPES>

Marker for [NodeType] used here

Implementations

impl<TYPES: NodeType> BuilderClient<TYPES, StaticVersion<0, 1>>

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<AvailableBlockHeaderInput<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_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

impl<TYPES: NodeType> BuilderClient<TYPES, StaticVersion<0, 99>>

pub async fn bundle( &self, parent_view: u64, parent_hash: VidCommitment, view_number: u64, ) -> Result<Bundle<TYPES>, BuilderClientError>

Claim block

Errors

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

impl<TYPES: NodeType, Ver: StaticVersionType> BuilderClient<TYPES, Ver>

pub fn new(base_url: impl Into<Url>) -> Self

Construct a new client from base url

Panics

If the URL is malformed.

pub async fn connect(&self, timeout: Duration) -> bool

Wait for server to become available Returns false if server doesn’t respond with OK healthcheck before timeout

pub async fn available_blocks( &self, parent: VidCommitment, view_number: u64, sender: TYPES::SignatureKey, signature: &<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType, ) -> Result<Vec<AvailableBlockInfo<TYPES>>, BuilderClientError>

Query builder for available blocks

Errors

• BuilderClientError::BlockNotFound if blocks aren’t available for this parent
• BuilderClientError::Api if API isn’t responding or responds incorrectly