Struct DataAnchorClient 

pub struct DataAnchorClient<Encoding = Default, Compression = Default>
where
    Encoding: DataAnchorEncoding + Default,
    Compression: DataAnchorCompressionAsync,
{ /* private fields */ }

Implementations

impl<Encoding, Compression> DataAnchorClient<Encoding, Compression>

where Encoding: DataAnchorEncoding + Default, Compression: DataAnchorCompressionAsync,

pub async fn get_blobs<T>( &self, slot: u64, identifier: BloberIdentifier, ) -> DataAnchorClientResult<Option<Vec<T>>>

where T: Decodable,

Fetches all blobs for a given slot from the IndexerRpcClient.

pub async fn get_blobs_by_blober<T>( &self, identifier: BloberIdentifier, time_range: Option<TimeRange>, ) -> DataAnchorClientResult<Vec<T>>

where T: Decodable,

Fetches blobs for a given blober and time range from the IndexerRpcClient.

pub async fn get_blobs_by_payer<T>( &self, payer: Pubkey, network_name: String, time_range: Option<TimeRange>, ) -> DataAnchorClientResult<Vec<T>>

where T: Decodable,

Fetches blobs for a given payer, network name and time range from the IndexerRpcClient.

pub async fn get_blobs_by_network<T>( &self, network_name: String, time_range: Option<TimeRange>, ) -> DataAnchorClientResult<Vec<T>>

where T: Decodable,

Fetches blobs for a given network and time range from the IndexerRpcClient.

pub async fn get_blobs_by_namespace_for_payer<T>( &self, namespace: String, payer_pubkey: Option<Pubkey>, time_range: Option<TimeRange>, ) -> DataAnchorClientResult<Vec<T>>

where T: Decodable,

Fetches blobs for a given namespace and time range from the IndexerRpcClient.

pub async fn get_payers_by_network( &self, network: String, ) -> DataAnchorClientResult<Vec<PubkeyFromStr>>

Fetches payers for a given network from the IndexerRpcClient.

pub async fn get_proof( &self, slot: u64, identifier: BloberIdentifier, ) -> DataAnchorClientResult<Option<CompoundInclusionProof>>

Fetches compound proof for a given slot from the IndexerRpcClient.

pub async fn get_proof_for_blob( &self, blob: Pubkey, ) -> DataAnchorClientResult<Option<CompoundInclusionProof>>

Fetches compound proof for a given blob PDA Pubkey from the IndexerRpcClient.

impl<Encoding, Compression> DataAnchorClient<Encoding, Compression>

where Encoding: DataAnchorEncoding + Default, Compression: DataAnchorCompressionAsync,

pub async fn get_ledger_blobs_from_signatures<T>( &self, identifier: BloberIdentifier, signatures: Vec<Signature>, ) -> DataAnchorClientResult<T>

where T: Decodable,

Returns the raw blob data from the ledger for the given signatures.

pub async fn get_ledger_blobs<T>( &self, slot: u64, identifier: BloberIdentifier, lookback_slots: Option<u64>, ) -> DataAnchorClientResult<Vec<T>>

where T: Decodable,

Fetches all blobs finalized in a given slot from the ledger.

pub async fn get_blob_messages( &self, slot: u64, identifier: BloberIdentifier, ) -> DataAnchorClientResult<Vec<(Pubkey, VersionedMessage)>>

Fetches blob messages for a given slot Returns a tuple of (Pubkey, VersionedMessage) where the Pubkey is the address of the data_anchor_blober::state::blob::Blob account and the VersionedMessage is the message that included the data_anchor_blober::instruction::FinalizeBlob instruction.

pub async fn list_blobers( &self, ) -> DataAnchorClientResult<Vec<BloberWithNamespace>>

Lists all blober accounts owned by the payer.

pub async fn get_blober( &self, identifier: BloberIdentifier, ) -> DataAnchorClientResult<Option<Blober>>

Retrieves a blober account by its identifier.

pub async fn get_checkpoint( &self, blober: BloberIdentifier, ) -> DataAnchorClientResult<Option<Checkpoint>>

Retrieves the checkpoint containing the Groth16 proof for a given blober account.

impl<Encoding, Compression> DataAnchorClient<Encoding, Compression>

where Encoding: DataAnchorEncoding + Default, Compression: DataAnchorCompressionAsync,

pub async fn checkpoint_custom_proof( &self, slot: Slot, identifier: BloberIdentifier, customer_elf: CustomerElf, ) -> DataAnchorClientResult<String>

Requests ZK proof generation on the proof RPC for a given blober, slot and proof type.

pub async fn get_proof_request_status( &self, request_id: String, ) -> DataAnchorClientResult<RequestStatus>

Returns the status of a proof request by its request ID.

impl<Encoding, Compression> DataAnchorClient<Encoding, Compression>

where Encoding: DataAnchorEncoding + Default, Compression: DataAnchorCompressionAsync,

pub fn builder() -> DataAnchorClientBuilder<Encoding, Compression>

Create an instance of DataAnchorClient using the builder syntax

impl<Encoding, Compression> DataAnchorClient<Encoding, Compression>

where Encoding: DataAnchorEncoding + Default, Compression: DataAnchorCompressionAsync,

pub fn rpc_client(&self) -> Arc<RpcClient>

Returns the underlaying RpcClient.

pub fn payer(&self) -> Arc<Keypair>

Returns the transaction payer Keypair.

pub async fn encode_and_compress<T>( &self, data: &T, ) -> DataAnchorClientResult<Vec<u8>>

where T: Encodable,

pub async fn decompress_and_decode<T>( &self, bytes: &[u8], ) -> DataAnchorClientResult<T>

where T: Decodable,

pub async fn decompress_and_decode_vec<T>( &self, slice_of_bytes: impl Iterator<Item = &[u8]>, ) -> DataAnchorClientResult<Vec<T>>

where T: Decodable,

pub async fn initialize_blober( &self, fee_strategy: FeeStrategy, identifier: BloberIdentifier, timeout: Option<Duration>, ) -> DataAnchorClientResult<Vec<SuccessfulTransaction<TransactionType>>>

Initializes a new Blober PDA account.

pub async fn close_blober( &self, fee_strategy: FeeStrategy, identifier: BloberIdentifier, timeout: Option<Duration>, ) -> DataAnchorClientResult<Vec<SuccessfulTransaction<TransactionType>>>

Closes a Blober PDA account.

pub async fn upload_blob<T>( &self, blob_data: &T, fee_strategy: FeeStrategy, namespace: &str, timeout: Option<Duration>, ) -> DataAnchorClientResult<(Vec<SuccessfulTransaction<TransactionType>>, Pubkey)>

where T: Encodable,

Uploads a blob of data with the given Blober PDA account. Under the hood it creates a new data_anchor_blober::state::blob::Blob PDA which stores a incremental hash of the chunks from the blob data. On completion of the blob upload, the blob PDA gets closed sending it’s funds back to the DataAnchorClient::payer. If the blob upload fails, the blob PDA gets discarded and the funds also get sent to the DataAnchorClient::payer.

pub async fn discard_blob( &self, fee_strategy: FeeStrategy, blob: Pubkey, namespace: &str, timeout: Option<Duration>, ) -> DataAnchorClientResult<(Vec<SuccessfulTransaction<TransactionType>>, Pubkey)>

Discards a data_anchor_blober::state::blob::Blob PDA account registered with the provided Blober PDA account.

pub async fn configure_checkpoint( &self, fee_strategy: FeeStrategy, identifier: BloberIdentifier, authority: Pubkey, timeout: Option<Duration>, ) -> DataAnchorClientResult<(Vec<SuccessfulTransaction<TransactionType>>, Pubkey)>

Configures a checkpoint for a given blober with the given authority. This allows the authority to create checkpoints for the blober.

pub async fn estimate_fees( &self, blob_size: usize, blober: Pubkey, fee_strategy: FeeStrategy, ) -> DataAnchorClientResult<Fee>

Estimates fees for uploading a blob of the size blob_size with the given priority. This whole functions is basically a simulation that doesn’t run anything. Instead of executing transactions, it just sums the expected fees and number of signatures.

The data_anchor_blober::state::blob::Blob PDA account is always newly created, so for estimating compute fees we don’t even need the real keypair, any unused pubkey will do.

Trait Implementations

impl<Encoding, Compression> Clone for DataAnchorClient<Encoding, Compression>

where Encoding: DataAnchorEncoding + Default + Clone, Compression: DataAnchorCompressionAsync + Clone,

fn clone(&self) -> DataAnchorClient<Encoding, Compression>

Returns a duplicate of the value.

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

Performs copy-assignment from source.