Struct SimplexClient 

pub struct SimplexClient { /* private fields */ }

Store-backed writer for Commonware Simplex blocks and certificates.

The writer stores five logical indexes:

• header bytes by header digest
• full { header, body } bytes by header digest
• notarized { proof, header } bytes by Simplex view
• finalized { proof, header } bytes by Simplex view
• finalized { proof, header } bytes by header height

Implementations

impl SimplexClient

pub fn new(store_url: &str) -> Self

pub fn from_client(client: StoreClient) -> Self

pub fn store_client(&self) -> &StoreClient

pub fn into_store_client(self) -> StoreClient

pub fn prepare_header<B>(&self, header: &B) -> PreparedUpload

where B: Block,

pub fn prepare_block<B>( &self, header: &B, body: impl Into<Bytes>, ) -> PreparedUpload

where B: Block,

pub fn prepare_block_data<B>(&self, data: &BlockData<B>) -> PreparedUpload

where B: Block,

pub fn prepare_notarized<B, S, D>( &self, notarized: &Notarized<B, S, D>, ) -> Result<PreparedUpload, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest,

pub fn prepare_finalized<B, S, D>( &self, finalized: &Finalized<B, S, D>, ) -> Result<PreparedUpload, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest,

pub fn stage_upload( &self, prepared: &PreparedUpload, batch: &mut StoreWriteBatch, ) -> Result<(), SimplexError>

pub async fn mark_upload_persisted( &self, prepared: PreparedUpload, sequence_number: u64, ) -> UploadReceipt

pub async fn mark_upload_failed( &self, _prepared: PreparedUpload, _err: impl ToString, )

pub async fn upload_header<B>( &self, header: &B, ) -> Result<UploadReceipt, SimplexError>

where B: Block,

pub async fn upload_block<B>( &self, header: &B, body: impl Into<Bytes>, ) -> Result<UploadReceipt, SimplexError>

where B: Block,

pub async fn upload_notarized<B, S, D>( &self, notarized: &Notarized<B, S, D>, ) -> Result<UploadReceipt, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest,

pub async fn upload_finalized<B, S, D>( &self, finalized: &Finalized<B, S, D>, ) -> Result<UploadReceipt, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest,

pub async fn get_header_raw<D: Digest>( &self, digest: &D, ) -> Result<Option<Bytes>, SimplexError>

pub async fn get_block_raw<D: Digest>( &self, digest: &D, ) -> Result<Option<Bytes>, SimplexError>

pub async fn get_notarized_raw( &self, view: View, ) -> Result<Option<Bytes>, SimplexError>

pub async fn get_finalized_by_view_raw( &self, view: View, ) -> Result<Option<Bytes>, SimplexError>

pub async fn get_finalized_by_height_raw( &self, height: Height, ) -> Result<Option<Bytes>, SimplexError>

pub async fn latest_finalized_raw(&self) -> Result<Option<Bytes>, SimplexError>

pub async fn get_header<B, D>( &self, digest: &D, cfg: &<B as Read>::Cfg, ) -> Result<Option<B>, SimplexError>

where B: Block<Digest = D>, D: Digest,

pub async fn get_block<B, D>( &self, digest: &D, cfg: &<BlockData<B> as Read>::Cfg, ) -> Result<Option<BlockData<B>>, SimplexError>

where B: Block<Digest = D>, D: Digest,

pub async fn get_notarized<B, S, D>( &self, view: View, cfg: &<Notarized<B, S, D> as Read>::Cfg, ) -> Result<Option<Notarized<B, S, D>>, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest, <S::Certificate as Read>::Cfg: Clone,

pub async fn get_finalized_by_height<B, S, D>( &self, height: Height, cfg: &<Finalized<B, S, D> as Read>::Cfg, ) -> Result<Option<Finalized<B, S, D>>, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest, <S::Certificate as Read>::Cfg: Clone,

pub async fn get_finalized_by_view<B, S, D>( &self, view: View, cfg: &<Finalized<B, S, D> as Read>::Cfg, ) -> Result<Option<Finalized<B, S, D>>, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest, <S::Certificate as Read>::Cfg: Clone,

pub async fn latest_finalized<B, S, D>( &self, cfg: &<Finalized<B, S, D> as Read>::Cfg, ) -> Result<Option<Finalized<B, S, D>>, SimplexError>

where B: Block<Digest = D>, S: Scheme, D: Digest, <S::Certificate as Read>::Cfg: Clone,

Trait Implementations

impl Clone for SimplexClient

fn clone(&self) -> SimplexClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimplexClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StoreBatchUpload for SimplexClient

type Prepared = PreparedUpload

type Receipt = UploadReceipt

type Error = SimplexError

fn stage_upload( &self, prepared: &Self::Prepared, batch: &mut StoreWriteBatch, ) -> Result<(), Self::Error>

fn commit_error(&self, error: ClientError) -> Self::Error

fn mark_upload_persisted<'a>( &'a self, prepared: Self::Prepared, sequence_number: u64, ) -> BoxFuture<'a, Self::Receipt>

where Self: Sync + 'a, Self::Prepared: 'a,

fn mark_upload_failed<'a>( &'a self, prepared: Self::Prepared, error: String, ) -> BoxFuture<'a, ()>

where Self: Sync + 'a, Self::Prepared: 'a,

fn commit_upload<'a>( &'a self, client: &'a StoreClient, prepared: Self::Prepared, ) -> Pin<Box<dyn Future<Output = Result<Self::Receipt, Self::Error>> + Send + 'a>>

where Self: Sized + Sync + 'a, Self::Prepared: 'a, Self::Receipt: 'a, Self::Error: 'a,