Struct Client

pub struct Client { /* private fields */ }

Generalized Electrum client that supports multiple backends. Can re-instantiate client_type if connections drops

Implementations

impl Client

pub fn new(url: &str) -> Result<Self, Error>

Default constructor supporting multiple backends by providing a prefix

Supported prefixes are:

• tcp:// for a TCP plaintext client.
• ssl:// for an SSL-encrypted client. The server certificate will be verified.

If no prefix is specified, then tcp:// is assumed.

See Client::from_config for more configuration options

Examples found in repository

examples/plaintext.rs (line 4)

fn main() {
    let client = Client::new("tcp://electrum.blockstream.info:50001").unwrap();
    let res = client.ping();
    println!("{:#?}", res);
}

examples/ssl.rs (line 4)

fn main() {
    let client = Client::new("ssl://electrum.blockstream.info:50002").unwrap();
    let res = client.ping();
    println!("{:#?}", res);
}

pub fn from_config(url: &str, config: Config) -> Result<Self, Error>

Generic constructor that supports multiple backends and allows configuration through the Config

Examples found in repository

examples/tor.rs (line 9)

fn main() {
    // NOTE: This assumes Tor is running localy, with an unauthenticated Socks5 listening at
    // localhost:9050
    let proxy = Socks5Config::new("127.0.0.1:9050");
    let config = ConfigBuilder::new().socks5(Some(proxy)).build();

    let client = Client::from_config("tcp://explorernuoc63nb.onion:110", config.clone()).unwrap();
    let res = client.ping();
    println!("{:#?}", res);

    // works both with onion v2/v3 (if your Tor supports them)
    let client = Client::from_config(
        "tcp://explorerzydxu5ecjrkwceayqybizmpjjznk5izmitf2modhcusuqlid.onion:110",
        config,
    )
    .unwrap();
    let res = client.ping();
    println!("{:#?}", res);
}

Trait Implementations

impl ElectrumApi for Client

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.