Struct ChiaQuery 

pub struct ChiaQuery { /* private fields */ }

Implementations

impl ChiaQuery

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

Create a new client. This will:

1. Establish the peer TLS identity (generated by default — no files needed).
2. Discover peers via DNS and connect up to max_peers concurrently.
3. Initialise the coinset.org HTTP client.

Peer discovery failing is fatal (ChiaQueryError::PeerDiscoveryFailed) ONLY when the coinset fallback is disabled; with the fallback enabled the client is usable immediately and the peer pool refills in the background.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Absence-aware get_coin_record_by_name: Ok(None) when the coin provably does not exist, Err when the read could not be completed. Used by the ChainSource facade to honour the fail-closed Ok(None)-vs-Err contract.

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

Absence-aware read of the spend that spent coin_id: Ok(None) when the coin is provably unspent/unknown, Err on failure.

pub async fn peak_height_opt(&self) -> Result<Option<u32>, ChiaQueryError>

The current peak height (Ok(None) when unavailable), Err on failure.

pub async fn peer_count(&self) -> usize

How many Chia full-node peers this client HOLDS right now.

Exposed because a consumer that presents itself as a light client has to be able to SAY how many peers it is a client of, and until now the pool’s size was observable only as the boolean has_peers. A count is not derivable from that, and a consumer with no way to read it is left either silent or quoting ChiaQueryConfig::max_peers — an intention presented as a measurement.

It is the LIVE count, never the target: a filling pool reports the smaller number. See peer::pool::PeerPool::peer_count for what “held” means with respect to a peer that has died without being used since.

pub async fn peer_peak_height(&self) -> Option<u32>

The peak height this client’s OWN peers have reported, or None when they have reported none yet.

Distinct from peak_height_opt, which answers “what is the chain’s peak” and consults coinset FIRST — so its figure is a third party’s view of the chain even on a client holding peers. This one answers “what have MY peers told me”, which is the only form of the question a light client can demonstrate, and it makes no network call at all: the pool tracks it from inbound NewPeakWallet messages.

None is UNKNOWN, never height zero. The pool spells an unobserved peak 0 internally, and every block is trivially above zero, so returning it would silently satisfy any “is this buried yet” comparison a caller makes.

pub async fn block_timestamp_opt( &self, height: u32, ) -> Result<Option<u64>, ChiaQueryError>

The Unix timestamp of the block at height (Ok(None) when absent), Err on failure.

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>

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>

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>

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>

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>

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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);