Struct RawClient

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

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, timeout: Option<Duration>, ) -> 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, timeout: Option<Duration>, ) -> 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 for RawClient<S>

where S: Read + Write + Debug,

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

Formats the value using the given formatter.

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

fn raw_call( &self, method_name: &str, params: impl IntoIterator<Item = Param>, ) -> Result<Value, Error>

Executes the requested API call returning the raw answer.

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.

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.

impl<S> From<S> for RawClient<S>

where S: Read + Write,

fn from(stream: S) -> Self

Converts to this type from the input type.