Skip to main content

asyncio-based Electrum client library

Project description

Stratum (electrum-server) Client Protocol library

Uses python3 to be a client to the Electrum server network. It makes heavy use of asyncio module and newer Python 3 keywords such as await and async.

For non-server applications, you can probably find all you need already in the standard Electrum code and command line.

Features

  • can connect via Tor, SSL, proxied or directly

  • filter lists of peers by protocol, .onion name

  • manage lists of Electrum servers in simple JSON files.

  • fully asynchronous design, so can connect to multiple at once

  • a number of nearly-useful examples provided

Examples

In examples you will find a number little example programs.

  • cli.py send single commands, plan is to make this an interactive REPL

  • subscribe.py stream changes/events for an address or blocks.

  • explorer.py implements a simplistic block explorer website

  • spider.py find all Electrum servers recursively, read/write results to JSON

Version History

  • 0.8.0 Support for ElectrumX protocol 1.4 with some helpers to restore useful functions.

  • 0.7.4 Add actual_connection atrribute on StratumClient with some key details

  • 0.7.3 Not sure

  • 0.7.2 Bugfix: port numbers vs. protocols

  • 0.7.1 Python 2.6 compat fix

  • 0.7.0 Reconnect broken server connections automatically (after first connect).

  • 0.6.0 Various pull requests from other devs integrated. Thanks to @devrandom, @ysangkok!

  • 0.5.3 Documents the build/release process (no functional changes).

  • 0.5.2 Make aiosocks and bottom modules optional at runtime (thanks to @BioMike)

  • 0.5.1 Minor bug fixes

  • 0.5.0 First public release.

TODO List

  • be more robust about failed servers, reconnect and handle it.

  • connect to a few (3?) servers and compare top block and response times; pick best

  • some sort of persistant server list that can be updated as we run

  • type checking of parameters sent to server (maybe)?

  • lots of test code

  • an example that finds servers that do SSL with self-signed certificate

  • an example that fingerprints servers to learn what codebase they use

  • some bitcoin-specific code that all clients would need; like block header to hash

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

connectrum-0.8.1.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

connectrum-0.8.1-py3.7.egg (32.3 kB view details)

Uploaded Source

File details

Details for the file connectrum-0.8.1.tar.gz.

File metadata

  • Download URL: connectrum-0.8.1.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.19.8 CPython/2.7.10

File hashes

Hashes for connectrum-0.8.1.tar.gz
Algorithm Hash digest
SHA256 c7918e078c9bc07a8a9ca642e628ad442d1850ff5986144ecbe50d512f920c0b
MD5 e7948d7bb99dcc9eb886f22c5a577249
BLAKE2b-256 8abc243d647533525fc9bcc7b451f02a74ccf3519909d3497dc8dcf3e3ffbbc2

See more details on using hashes here.

File details

Details for the file connectrum-0.8.1-py3.7.egg.

File metadata

  • Download URL: connectrum-0.8.1-py3.7.egg
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.19.8 CPython/2.7.10

File hashes

Hashes for connectrum-0.8.1-py3.7.egg
Algorithm Hash digest
SHA256 2e99f09b4cc4d1ef49fc8e8f399d03f7daa2ed4c35159d1740e7bcae9c56c6d2
MD5 2aa5d47dabef9db2421ea4c315f1a467
BLAKE2b-256 c28ba29ca8efc13bfb9676e9d66aaf4c43ce3977190762fd1c69f29e26ba72d4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page