Struct ElectrumClient 

pub struct ElectrumClient { /* private fields */ }

A client to issue TCP requests to an electrum server.

Implementations

impl ElectrumClient

pub fn new( electrum_url: &str, tls: bool, validate_domain: bool, ) -> Result<Arc<Self>, LwkError>

Construct an Electrum client

pub fn ping(&self) -> Result<(), LwkError>

Ping the Electrum server

pub fn broadcast(&self, tx: &Transaction) -> Result<Arc<Txid>, LwkError>

Broadcast a transaction to the network so that a miner can include it in a block.

pub fn full_scan( &self, wollet: &Wollet, ) -> Result<Option<Arc<Update>>, LwkError>

Scan the blockchain for the scripts generated by a watch-only wallet

This method scans both external and internal address chains, stopping after finding 20 consecutive unused addresses (the gap limit) as recommended by BIP44.

Returns Some(Update) if any changes were found during scanning, or None if no changes were detected.

To scan beyond the gap limit use full_scan_to_index() instead.

pub fn full_scan_to_index( &self, wollet: &Wollet, index: u32, ) -> Result<Option<Arc<Update>>, LwkError>

Scan the blockchain for the scripts generated by a watch-only wallet up to a specified derivation index

While full_scan() stops after finding 20 consecutive unused addresses (the gap limit), this method will scan at least up to the given derivation index. This is useful to prevent missing funds in cases where outputs exist beyond the gap limit.

Will scan both external and internal address chains up to the given index for maximum safety, even though internal addresses may not need such deep scanning.

If transactions are found beyond the gap limit during this scan, subsequent calls to full_scan() will automatically scan up to the highest used index, preventing any previously-found transactions from being missed.

pub fn get_tx(&self, txid: &Txid) -> Result<Arc<Transaction>, LwkError>

Fetch the transaction with the given id

pub fn tip(&self) -> Result<Arc<BlockHeader>, LwkError>

Return the current tip of the blockchain

Trait Implementations

impl Debug for ElectrumClient

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for ElectrumClient

type LiftType = Arc<ElectrumClient>

impl<UT> LowerError<UT> for ElectrumClient

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for ElectrumClient

type ReturnType = <Arc<ElectrumClient> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for ElectrumClient

const TYPE_ID_META: MetadataBuffer