Client

Struct Client 

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

Implementations§

Source§

impl Client

Source

pub fn new(address: &str, port: u16) -> Result<Self, Error>

Create a new electrum client.

§Arguments
  • address - url/ip of the electrum server as String
  • port - port of the electrum server
Source

pub fn new_local(address: &str, port: u16) -> Result<Self, Error>

Create a new local electrum client: SSL certificate validation id disabled in order to be used with self-signed certificates.

§Arguments
  • address - url/ip of the electrum server as String
  • port - port of the electrum server
Source

pub fn listen<RQ, RS>(self) -> (Sender<RQ>, Receiver<RS>)
where RQ: Into<CoinRequest> + Debug + Send + 'static, RS: From<CoinResponse> + Debug + Send + 'static,

Source

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

Try to get a transaction by its txid

§Errors

This function will return an error if:

  • fail to send the request
  • parsing response fails
  • the response is not of expected type
  • the transaction does not exists
Source

pub fn get_coins_at( &mut self, script: &Script, ) -> Result<(Vec<(TxOut, OutPoint)>, HashMap<Txid, Transaction>), Error>

Get coins that pay to the given spk and their related transaction. This method will make several calls to the electrum server:

  • it will first request a list of all transactions txid that have an output paying to the spk.
  • it will then fetch all txs, store them and extract all the coins that pay to the given spk.
  • it will return a list of (TxOut, OutPoint) and a map of transactions.
§Errors

This function will return an error if:

  • a call to the electrum server fail
Source

pub fn get_coins_tx_at(&mut self, script: &Script) -> Result<Vec<Txid>, Error>

Get a list of txid of all transaction that have an output paying to the given spk

§Errors

This function will return an error if:

  • fail sending the request
  • receive a wrong response
Source

pub fn broadcast(&mut self, tx: &Transaction) -> Result<(), Error>

Broadcast the given transaction.

§Errors

This function will return an error if:

  • fail to send the request
  • get a wrong response
Source

pub fn url(&self) -> String

Returns the URL of the electrum client.

§Returns

A String containing the URL of the electrum server.

Source

pub fn port(&self) -> u16

Returns the port of the electrum client.

§Returns

A u16 containing the port of the electrum server.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnwindSafe for Client

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<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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