bluewallet / rn-electrum-client

Electrum Client for React Native

rn-electrum-client

Electrum Protocol Client for React Native

based on

• https://github.com/you21979/node-electrum-client
• https://github.com/7kharov/node-electrum-client

features

• persistence (ping strategy and reconnection)
• batch requests
• works in RN and nodejs
• both clearnet TCP and TLS
• zero dependencies

protocol spec

• https://electrumx-spesmilo.readthedocs.io/en/latest/protocol.html

usage

For Nodejs you can just provide standard modules net & tls to constructor explicitly, this library won't do require('net').

  const net = require('net');

and then

  const client = new ElectrumClient(net, false, 50001, 'electrum1.bluewallet.io', 'tcp');
  const ver = await client.initElectrum({ client: 'bluewallet', version: '1.4' });
  const balance = await client.blockchainScripthash_getBalance('716decbe1660861c3d93906cb1d98ee68b154fd4d23aed9783859c1271b52a9c');

For React Native luckily we have react-native-tcp-socket which mimics net & tls pretty closely, one of the ways to shim it is via package.json:

    "react-native": {
      "net": "react-native-tcp-socket",
      "tls": "react-native-tcp-socket"
    }

license

MIT

rn-electrum-client's Issues

Tor support

I briefly looked through the code and it looks like a Tor proxy would be used in this lib. Could it be as simple as adding https://github.com/JoshGlazebrook/socks or https://github.com/TooTallNate/node-socks-proxy-agent into client.js? Looks like the url and port would come from the BlueWallet app too.

Timeout support

Does this library support timeout? I tried passing it through the options object, but it doesn't seem to work. Do you plan on supporting this in the near future?

Add getBalanceHistory(batch)

Hello,

Please add a feature that gets the address balance including the tx history, as it's quit intensive to fetch an addresses history and calculate the total received/total seend values it requires calls to getBalanceBatch, getHitoryBatch and TransactionBatch (txBatch requests are needed for each tx from getTransactionBatch) plus addresses need conversion to a scripthash that needs to be compared to an address and the bitcoinjs library needs to convert the address to an output script too that's quit a lot of code. Would be nice if some electrum client supports just it be design.

Scripthash Unsubscribe support

Does this library provide the support for blockchain.scripthash.unsubscribe documented here https://electrumx.readthedocs.io/en/latest/protocol-methods.html#blockchain-scripthash-unsubscribe?

If not, would it be hard to add?

Error close connect with tls connection

I tried connecting to blockstream.info:465 using tls connection, I did the necessary polyfills of net and tls and I tried also with the method that you are using here
It seems that I'm connected for a short time but then the connection closes and starts trying to reconnect, as the result I obtain a bunch of errors Error: close connect.
I tried the same thing with tcp on blockstream.info:195 and it works properly, the problem is that i need to connect to this one blockstream.info:465using tls

Am I missing something?

Upload package to NPM / Yarn Registries

Currently using the package require using this repo via:

    "electrum-client": "https://github.com/BlueWallet/rn-electrum-client",

please upload it to NPM / Yarn Registries:
https://yarnpkg.com/package/rn-electrum-client
https://www.npmjs.com/package/rn-electrum-client

So it can be used instead with:

    "electrum-client": "rn-electrum-client",