Struct electrum_client::raw_client::RawClient

pub struct RawClient<S> where
    S: Read + Write,  { /* fields omitted */ }

Instance of an Electrum client

A Client maintains a constant connection with an Electrum server and exposes methods to interact with it. It can also subscribe and receive notifictations from the server about new blocks or activity on a specific scriptPubKey.

The Client is modeled in such a way that allows the external caller to have full control over its functionality: no threads or tasks are spawned internally to monitor the state of the connection.

More transport methods can be used by manually creating an instance of this struct with an arbitray S type.

Implementations

impl RawClient<ElectrumPlaintextStream>

pub fn new<A: ToSocketAddrs>(
    socket_addrs: A,
    timeout: Option<Duration>
) -> Result<Self, Error>

Creates a new plaintext client and tries to connect to socket_addr.

impl RawClient<ElectrumSslStream>

pub fn new_ssl<A: ToSocketAddrsDomain + Clone>(
    socket_addrs: A,
    validate_domain: bool,
    timeout: Option<Duration>
) -> Result<Self, Error>

Creates a new SSL client and tries to connect to socket_addr. Optionally, if validate_domain is true, validate the server's certificate.

pub fn new_ssl_from_stream<A: ToSocketAddrsDomain>(
    socket_addr: A,
    validate_domain: bool,
    tcp_stream: TcpStream
) -> Result<Self, Error>

Create a new SSL client using an existing TcpStream

impl RawClient<ElectrumProxyStream>

pub fn new_proxy<T: ToTargetAddr>(
    target_addr: T,
    proxy: &Socks5Config
) -> Result<Self, Error>

Creates a new socks client and tries to connect to target_addr using proxy_addr as a socks proxy server. The DNS resolution of target_addr, if required, is done through the proxy. This allows to specify, for instance, .onion addresses.

pub fn new_proxy_ssl<T: ToTargetAddr>(
    target_addr: T,
    validate_domain: bool,
    proxy: &Socks5Config
) -> Result<RawClient<ElectrumSslStream>, Error>

Creates a new TLS client that connects to target_addr using proxy_addr as a socks proxy server. The DNS resolution of target_addr, if required, is done through the proxy. This allows to specify, for instance, .onion addresses.

Trait Implementations

impl<S: Debug> Debug for RawClient<S> where
    S: Read + Write, 

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

Formats the value using the given formatter.

impl<T: Read + Write> ElectrumApi for RawClient<T>

pub fn batch_call(&self, batch: &Batch) -> Result<Vec<Value>, Error>

Execute a queue of calls stored in a Batch struct. Returns Ok() only if all of the calls are successful. The order of the JSON Values returned reflects the order in which the calls were made on the Batch struct.

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

Subscribes to notifications for new block headers, by sending a blockchain.headers.subscribe call and returns the current tip as raw bytes instead of deserializing them.

pub fn block_headers_pop_raw(
    &self
) -> Result<Option<RawHeaderNotification>, Error>

Tries to pop one queued notification for a new block header that we might have received. Returns a the header in raw bytes if a notification is found in the queue, None otherwise.

pub fn block_header_raw(&self, height: usize) -> Result<Vec<u8>, Error>

Gets the raw bytes of block header for height height.

pub fn block_headers(
    &self,
    start_height: usize,
    count: usize
) -> Result<GetHeadersRes, Error>

Tries to fetch count block headers starting from start_height.

pub fn estimate_fee(&self, number: usize) -> Result<f64, Error>

Estimates the fee required in Satoshis per kilobyte to confirm a transaction in number blocks.

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

Returns the minimum accepted fee by the server's node in Bitcoin, not Satoshi.

pub fn script_subscribe(
    &self,
    script: &Script
) -> Result<Option<ScriptStatus>, Error>

Subscribes to notifications for activity on a specific scriptPubKey.

pub fn script_unsubscribe(&self, script: &Script) -> Result<bool, Error>

Subscribes to notifications for activity on a specific scriptPubKey.

pub fn script_pop(&self, script: &Script) -> Result<Option<ScriptStatus>, Error>

Tries to pop one queued notification for a the requested script. Returns None if there are no items in the queue.

pub fn script_get_balance(
    &self,
    script: &Script
) -> Result<GetBalanceRes, Error>

Returns the balance for a scriptPubKey.

pub fn batch_script_get_balance<'s, I>(
    &self,
    scripts: I
) -> Result<Vec<GetBalanceRes>, Error> where
    I: IntoIterator<Item = &'s Script> + Clone, 

Batch version of script_get_balance.

pub fn script_get_history(
    &self,
    script: &Script
) -> Result<Vec<GetHistoryRes>, Error>

Returns the history for a scriptPubKey

pub fn batch_script_get_history<'s, I>(
    &self,
    scripts: I
) -> Result<Vec<Vec<GetHistoryRes>>, Error> where
    I: IntoIterator<Item = &'s Script> + Clone, 

Batch version of script_get_history.

pub fn script_list_unspent(
    &self,
    script: &Script
) -> Result<Vec<ListUnspentRes>, Error>

Returns the list of unspent outputs for a scriptPubKey

pub fn batch_script_list_unspent<'s, I>(
    &self,
    scripts: I
) -> Result<Vec<Vec<ListUnspentRes>>, Error> where
    I: IntoIterator<Item = &'s Script> + Clone, 

Batch version of script_list_unspent.

pub fn transaction_get_raw(&self, txid: &Txid) -> Result<Vec<u8>, Error>

Gets the raw bytes of a transaction with txid. Returns an error if not found.

pub fn batch_transaction_get_raw<'t, I>(
    &self,
    txids: I
) -> Result<Vec<Vec<u8>>, Error> where
    I: IntoIterator<Item = &'t Txid> + Clone, 

Batch version of transaction_get_raw.

pub fn batch_block_header_raw<'s, I>(
    &self,
    heights: I
) -> Result<Vec<Vec<u8>>, Error> where
    I: IntoIterator<Item = u32> + Clone, 

Batch version of block_header_raw.

pub fn batch_estimate_fee<'s, I>(&self, numbers: I) -> Result<Vec<f64>, Error> where
    I: IntoIterator<Item = usize> + Clone, 

Batch version of estimate_fee.

pub fn transaction_broadcast_raw(&self, raw_tx: &[u8]) -> Result<Txid, Error>

Broadcasts the raw bytes of a transaction to the network.

pub fn transaction_get_merkle(
    &self,
    txid: &Txid,
    height: usize
) -> Result<GetMerkleRes, Error>

Returns the merkle path for the transaction txid confirmed in the block at height.

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

Returns the capabilities of the server.

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

Pings the server. This method can also be used as a "dummy" call to trigger the processing of incoming block header or script notifications.

pub fn block_header(&self, height: usize) -> Result<BlockHeader, Error>

Gets the block header for height height.

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

Subscribes to notifications for new block headers, by sending a blockchain.headers.subscribe call.

pub fn block_headers_pop(&self) -> Result<Option<HeaderNotification>, Error>

Tries to pop one queued notification for a new block header that we might have received. Returns None if there are no items in the queue.

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

Gets the transaction with txid. Returns an error if not found.

pub fn batch_transaction_get<'t, I>(
    &self,
    txids: I
) -> Result<Vec<Transaction>, Error> where
    I: IntoIterator<Item = &'t Txid> + Clone, 

Batch version of transaction_get.

pub fn batch_block_header<I>(
    &self,
    heights: I
) -> Result<Vec<BlockHeader>, Error> where
    I: IntoIterator<Item = u32> + Clone, 

Batch version of block_header.

pub fn transaction_broadcast(&self, tx: &Transaction) -> Result<Txid, Error>

Broadcasts a transaction to the network.

impl<S> From<S> for RawClient<S> where
    S: Read + Write, 

pub fn from(stream: S) -> Self

Performs the conversion.