Struct Index 

pub struct Index { /* private fields */ }

Implementations

impl Index

pub fn open(settings: &Settings) -> Result<Self, Error>

pub fn open_with_event_sender( settings: &Settings, event_sender: Option<Sender<Event>>, ) -> Result<Self, Error>

pub fn have_full_utxo_index(&self) -> bool

pub fn is_special_outpoint(outpoint: OutPoint) -> bool

Unlike normal outpoints, which are added to index on creation and removed when spent, the UTXO entry for special outpoints may be updated.

The special outpoints are the null outpoint, which receives lost sats, and the unbound outpoint, which receives unbound inscriptions.

pub fn contains_output(&self, output: &OutPoint) -> Result<bool, Error>

pub fn has_address_index(&self) -> bool

pub fn has_inscription_index(&self) -> bool

pub fn has_rune_index(&self) -> bool

pub fn has_sat_index(&self) -> bool

pub fn status(&self, json_api: bool) -> Result<StatusHtml, Error>

pub fn info(&self) -> Result<Info, Error>

pub fn update(&self) -> Result<(), Error>

pub fn export( &self, filename: &String, include_addresses: bool, ) -> Result<(), Error>

pub fn block_count(&self) -> Result<u32, Error>

pub fn block_height(&self) -> Result<Option<Height>, Error>

pub fn block_hash( &self, height: Option<u32>, ) -> Result<Option<BlockHash>, Error>

pub fn blocks(&self, take: usize) -> Result<Vec<(u32, BlockHash)>, Error>

pub fn rare_sat_satpoints(&self) -> Result<Vec<(Sat, SatPoint)>, Error>

pub fn rare_sat_satpoint(&self, sat: Sat) -> Result<Option<SatPoint>, Error>

pub fn get_rune_by_id(&self, id: RuneId) -> Result<Option<Rune>, Error>

pub fn get_rune_by_number(&self, number: usize) -> Result<Option<Rune>, Error>

pub fn rune( &self, rune: Rune, ) -> Result<Option<(RuneId, RuneEntry, Option<InscriptionId>)>, Error>

pub fn runes(&self) -> Result<Vec<(RuneId, RuneEntry)>, Error>

pub fn runes_paginated( &self, page_size: usize, page_index: usize, ) -> Result<(Vec<(RuneId, RuneEntry)>, bool), Error>

pub fn encode_rune_balance(id: RuneId, balance: u128, buffer: &mut Vec<u8>)

pub fn decode_rune_balance( buffer: &[u8], ) -> Result<((RuneId, u128), usize), Error>

pub fn get_rune_balances_for_output( &self, outpoint: OutPoint, ) -> Result<Option<BTreeMap<SpacedRune, Pile>>, Error>

pub fn get_rune_balance_map( &self, ) -> Result<BTreeMap<SpacedRune, BTreeMap<OutPoint, Pile>>, Error>

pub fn get_rune_balances( &self, ) -> Result<Vec<(OutPoint, Vec<(RuneId, u128)>)>, Error>

pub fn block_header(&self, hash: BlockHash) -> Result<Option<Header>, Error>

pub fn block_header_info( &self, hash: BlockHash, ) -> Result<Option<GetBlockHeaderResult>, Error>

pub fn block_stats( &self, height: u64, ) -> Result<Option<GetBlockStatsResult>, Error>

pub fn get_block_by_height(&self, height: u32) -> Result<Option<Block>, Error>

pub fn get_block_by_hash(&self, hash: BlockHash) -> Result<Option<Block>, Error>

pub fn get_collections_paginated( &self, page_size: usize, page_index: usize, ) -> Result<(Vec<InscriptionId>, bool), Error>

pub fn get_children_by_sequence_number_paginated( &self, sequence_number: u32, page_size: usize, page_index: usize, ) -> Result<(Vec<InscriptionId>, bool), Error>

pub fn get_parents_by_sequence_number_paginated( &self, parent_sequence_numbers: Vec<u32>, page_size: usize, page_index: usize, ) -> Result<(Vec<InscriptionId>, bool), Error>

pub fn get_etching(&self, txid: Txid) -> Result<Option<SpacedRune>, Error>

pub fn get_inscription_ids_by_sat( &self, sat: Sat, ) -> Result<Vec<InscriptionId>, Error>

pub fn get_inscription_ids_by_sat_paginated( &self, sat: Sat, page_size: u64, page_index: u64, ) -> Result<(Vec<InscriptionId>, bool), Error>

pub fn get_inscription_id_by_sat_indexed( &self, sat: Sat, inscription_index: isize, ) -> Result<Option<InscriptionId>, Error>

pub fn get_inscription_satpoint_by_id( &self, inscription_id: InscriptionId, ) -> Result<Option<SatPoint>, Error>

pub fn get_inscription_by_id( &self, inscription_id: InscriptionId, ) -> Result<Option<Inscription>, Error>

pub fn inscription_count(&self, txid: Txid) -> Result<u32, Error>

pub fn inscription_exists( &self, inscription_id: InscriptionId, ) -> Result<bool, Error>

pub fn get_inscriptions_on_output_with_satpoints( &self, outpoint: OutPoint, ) -> Result<Option<Vec<(SatPoint, InscriptionId)>>, Error>

pub fn get_inscriptions_for_output( &self, outpoint: OutPoint, ) -> Result<Option<Vec<InscriptionId>>, Error>

pub fn get_inscriptions_for_outputs( &self, outpoints: &Vec<OutPoint>, ) -> Result<Option<Vec<InscriptionId>>, Error>

pub fn get_unspent_or_unconfirmed_output( &self, txid: &Txid, vout: u32, ) -> Result<Option<GetTxOutResult>, Error>

pub fn get_transaction_info( &self, txid: &Txid, ) -> Result<Option<GetRawTransactionResult>, Error>

pub fn get_transaction(&self, txid: Txid) -> Result<Option<Transaction>, Error>

pub fn get_transaction_hex_recursive( &self, txid: Txid, ) -> Result<Option<String>, Error>

pub fn find(&self, sat: Sat) -> Result<Option<SatPoint>, Error>

pub fn find_range( &self, range_start: Sat, range_end: Sat, ) -> Result<Option<Vec<FindRangeOutput>>, Error>

pub fn list(&self, outpoint: OutPoint) -> Result<Option<Vec<(u64, u64)>>, Error>

pub fn is_output_spent(&self, outpoint: OutPoint) -> Result<bool, Error>

pub fn is_output_in_active_chain( &self, outpoint: OutPoint, ) -> Result<bool, Error>

pub fn block_time(&self, height: Height) -> Result<Blocktime, Error>

pub fn get_inscriptions_paginated( &self, page_size: u32, page_index: u32, ) -> Result<(Vec<InscriptionId>, bool), Error>

pub fn get_inscriptions_in_block( &self, block_height: u32, ) -> Result<Vec<InscriptionId>, Error>

pub fn get_runes_in_block( &self, block_height: u64, ) -> Result<Vec<SpacedRune>, Error>

pub fn get_highest_paying_inscriptions_in_block( &self, block_height: u32, n: usize, ) -> Result<(Vec<InscriptionId>, usize), Error>

pub fn get_home_inscriptions(&self) -> Result<Vec<InscriptionId>, Error>

pub fn get_feed_inscriptions( &self, n: usize, ) -> Result<Vec<(u32, InscriptionId)>, Error>

pub fn get_inscription_entry( &self, inscription_id: InscriptionId, ) -> Result<Option<InscriptionEntry>, Error>

pub fn get_address_info( &self, address: &Address, ) -> Result<Vec<OutPoint>, Error>