MCPcopy Index your code
hub / github.com/bitcoindevkit/rust-electrum-client

github.com/bitcoindevkit/rust-electrum-client @0.25.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 0.25.0 ↗ · + Follow
336 symbols 703 edges 18 files 77 documented · 23%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

rust-electrum-client

<a href="https://crates.io/crates/electrum-client"><img src="https://img.shields.io/crates/v/electrum-client.svg"/></a>
<a href="https://docs.rs/electrum-client"><img src="https://img.shields.io/badge/docs.rs-electrum--client-blue"/></a>
<a href="https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html"><img src="https://img.shields.io/badge/MSRV-1.75.0%2B-orange.svg"/></a>
<a href="https://github.com/bitcoindevkit/rust-electrum-client/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT%2FApache--2.0-red.svg"/></a>
<a href="https://github.com/bitcoindevkit/rust-electrum-client/actions/workflows/cont_integration.yml"><img src="https://github.com/bitcoindevkit/rust-electrum-client/actions/workflows/cont_integration.yml/badge.svg"></a>

Bitcoin Electrum client library. Supports plaintext, TLS and Onion servers.

Minimum Supported Rust Version (MSRV)

This library should compile with any combination of features with Rust 1.75.0.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Extension points exported contracts — how you extend this code

ToTargetAddr (Interface)
A trait for objects that can be converted to `TargetAddr`. [8 implementers]
src/socks/mod.rs
ElectrumApi (Interface)
API calls exposed by an Electrum client [4 implementers]
src/api.rs
ToSocketAddrsDomain (Interface)
A trait for [`ToSocketAddrs`](https://doc.rust-lang.org/std/net/trait.ToSocketAddrs.html) that can also be turned into a [3 …
src/raw_client.rs
ToElectrumScriptHash (Interface)
Trait used to convert a struct into the Electrum representation of an address [1 implementers]
src/types.rs
WritevExt (Interface)
(no doc) [2 implementers]
src/socks/writev.rs

Core symbols most depended-on inside this repo

clone
called by 31
src/stream.rs
get_test_client
called by 24
src/raw_client.rs
call
called by 21
src/raw_client.rs
iter
called by 15
src/batch.rs
string_of_size
called by 12
src/socks/v5.rs
authorization_provider
called by 11
src/config.rs
build
called by 10
src/config.rs
bind
called by 9
src/socks/v5.rs

Shape

Method 203
Function 84
Class 36
Enum 8
Interface 5

Languages

Rust100%

Modules by API surface

src/raw_client.rs90 symbols
src/api.rs44 symbols
src/socks/v5.rs43 symbols
src/client.rs41 symbols
src/types.rs38 symbols
src/config.rs21 symbols
src/socks/v4.rs18 symbols
src/batch.rs14 symbols
src/socks/mod.rs7 symbols
src/stream.rs6 symbols
examples/jwt_dynamic_auth.rs6 symbols
src/socks/writev.rs3 symbols

For agents

$ claude mcp add rust-electrum-client \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact