Skip to main content

ChiaQuery

Struct ChiaQuery 

Source
pub struct ChiaQuery { /* private fields */ }

Implementations§

Source§

impl ChiaQuery

Source

pub async fn new(cfg: ChiaQueryConfig) -> Result<Self, ChiaQueryError>

Create a new client. This will:

  1. Load TLS certificates from the configured paths.
  2. Discover peers via DNS and connect up to max_peers concurrently.
  3. Initialise the coinset.org HTTP client.

At least one peer must connect successfully, otherwise this returns ChiaQueryError::PeerDiscoveryFailed.

Source

pub async fn get_additions_and_removals( &self, header_hash: &str, ) -> Result<AdditionsAndRemovals, ChiaQueryError>

Source

pub async fn get_block( &self, header_hash: &str, ) -> Result<FullBlock, ChiaQueryError>

Source

pub async fn get_block_by_height( &self, height: u32, ) -> Result<FullBlock, ChiaQueryError>

Fetch a full block by height. Peer-backed via RequestBlock.

Source

pub async fn get_block_count_metrics( &self, ) -> Result<BlockCountMetrics, ChiaQueryError>

Source

pub async fn get_block_record( &self, header_hash: &str, ) -> Result<BlockRecord, ChiaQueryError>

Source

pub async fn get_block_record_by_height( &self, height: u32, ) -> Result<BlockRecord, ChiaQueryError>

Source

pub async fn get_block_records( &self, start: u32, end: u32, ) -> Result<Vec<BlockRecord>, ChiaQueryError>

Source

pub async fn get_block_spends( &self, header_hash: &str, ) -> Result<Vec<CoinSpend>, ChiaQueryError>

Source

pub async fn get_block_spends_with_conditions( &self, header_hash: &str, ) -> Result<Vec<CoinSpendWithConditions>, ChiaQueryError>

Source

pub async fn get_blocks( &self, start: u32, end: u32, exclude_header_hash: bool, exclude_reorged: bool, ) -> Result<Vec<FullBlock>, ChiaQueryError>

Source

pub async fn get_unfinished_block_headers( &self, ) -> Result<Vec<UnfinishedBlockHeader>, ChiaQueryError>

Source

pub async fn get_coin_record_by_name( &self, name: &str, ) -> Result<CoinRecord, ChiaQueryError>

Source

pub async fn get_coin_records_by_hint( &self, hint: &str, start_height: Option<u32>, end_height: Option<u32>, include_spent_coins: bool, ) -> Result<Vec<CoinRecord>, ChiaQueryError>

Source

pub async fn get_coin_records_by_hints( &self, hints: &[String], start_height: Option<u32>, end_height: Option<u32>, include_spent_coins: bool, ) -> Result<Vec<CoinRecord>, ChiaQueryError>

Source

pub async fn get_coin_records_by_names( &self, names: &[String], start_height: Option<u32>, end_height: Option<u32>, include_spent_coins: bool, ) -> Result<Vec<CoinRecord>, ChiaQueryError>

Source

pub async fn get_coin_records_by_parent_ids( &self, parent_ids: &[String], start_height: Option<u32>, end_height: Option<u32>, include_spent_coins: bool, ) -> Result<Vec<CoinRecord>, ChiaQueryError>

Source

pub async fn get_coin_records_by_puzzle_hash( &self, puzzle_hash: &str, start_height: Option<u32>, end_height: Option<u32>, include_spent_coins: bool, ) -> Result<Vec<CoinRecord>, ChiaQueryError>

Source

pub async fn get_coin_records_by_puzzle_hashes( &self, puzzle_hashes: &[String], start_height: Option<u32>, end_height: Option<u32>, include_spent_coins: bool, ) -> Result<Vec<CoinRecord>, ChiaQueryError>

Source

pub async fn get_memos_by_coin_name( &self, name: &str, ) -> Result<Value, ChiaQueryError>

Source

pub async fn get_puzzle_and_solution( &self, coin_id: &str, height: Option<u32>, ) -> Result<CoinSpend, ChiaQueryError>

Source

pub async fn get_puzzle_and_solution_with_conditions( &self, coin_id: &str, height: Option<u32>, ) -> Result<CoinSpendWithConditions, ChiaQueryError>

Source

pub async fn push_tx( &self, spend_bundle: &SpendBundle, ) -> Result<TxStatus, ChiaQueryError>

Source

pub async fn get_fee_estimate( &self, spend_bundle: Option<&SpendBundle>, target_times: Option<&[u64]>, spend_count: Option<u64>, ) -> Result<FeeEstimate, ChiaQueryError>

Source

pub async fn get_aggsig_additional_data(&self) -> Result<String, ChiaQueryError>

Source

pub async fn get_network_info(&self) -> Result<NetworkInfo, ChiaQueryError>

Source

pub async fn get_blockchain_state( &self, ) -> Result<BlockchainState, ChiaQueryError>

Source

pub async fn get_network_space( &self, newer_block_header_hash: &str, older_block_header_hash: &str, ) -> Result<u64, ChiaQueryError>

Source

pub async fn get_all_mempool_items( &self, ) -> Result<HashMap<String, MempoolItem>, ChiaQueryError>

Source

pub async fn get_all_mempool_tx_ids( &self, ) -> Result<Vec<String>, ChiaQueryError>

Source

pub async fn get_mempool_item_by_tx_id( &self, tx_id: &str, ) -> Result<MempoolItem, ChiaQueryError>

Source

pub async fn get_mempool_items_by_coin_name( &self, coin_name: &str, include_spent_coins: Option<bool>, ) -> Result<Vec<MempoolItem>, ChiaQueryError>

Source

pub async fn wait_for_confirmation( &self, coin_id: &str, poll_interval: Duration, timeout: Duration, ) -> Result<CoinRecord, ChiaQueryError>

Poll the blockchain until a coin appears on-chain (confirmed) or the timeout elapses.

Returns the CoinRecord once the coin is found with a non-zero confirmed_block_index. Returns an error if the timeout expires before the coin is confirmed.

let client = ChiaQuery::new(ChiaQueryConfig::default()).await?;
let record = client.wait_for_confirmation(
    "0xabc...",
    Duration::from_secs(5),   // poll every 5 seconds
    Duration::from_secs(300), // give up after 5 minutes
).await?;
println!("confirmed at height {}", record.confirmed_block_index);

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more