stratum-tool

Command-line tool for communicating with Electrum server

Monthly Downloads: 4

Programming language: Haskell

License: GNU Affero General Public License v3.0 only

Tags: Utils    

README

<!-- -- mode: markdown; coding: utf-8 -- -->

StratumTool – Bitcoin network query tool

This tool allows querying Electrum servers using Stratum Protocol without local Electrum installation. Possible use cases include querying bitcoin address balances, block headers, raw transactions, unspent outputs, or any other command supported by Electrum protocol.

The internal implementation is more complete than the command-line interface so it is easy to expand to more complex queries in future.

Installation from a package

Ubuntu

There is PPA containing the most recent release for Ubuntu 12.04, 14.04, and 14.10. Build for 12.04 lacks SSL support because of cumbersome dependencies of connection library.

To install:

sudo add-apt-repository ppa:zouppen/stratum-tool
sudo apt-get update
sudo apt-get install stratum-tool

Debian

For Debian 7 (wheezy) there are experimental builds available at my site. Just like Ubuntu 12.04 build, this build lacks SSL support.

Arch

StratumTool is available on the AUR.

To install:

pacaur -S stratum-tool

Useful commands

Here is listing of useful commands. Of course you may use any other command supported by Stratum protocol.

Command	Arguments	Synopsis
blockchain.address.get_history	Bitcoin address	Lists transactions with TxOuts to given address
blockchain.address.get_balance	Bitcoin address	Lists both unconfirmed and confirmed balances of given address
blockchain.address.listunspent	Bitcoin address	List unspent transactions of given address
blockchain.utxo.get_address	Transaction hash and index	Get target address of given transaction hash output
blockchain.transaction.broadcast	Hex encoded transaction	Broadcast given transaction
blockchain.transaction.get	Transaction hash	Retrieves given transaction in hex encoded format
blockchain.block.get_header	Block hash	Retrieves given block headers

All command with only single argument may be used in --multi mode which allows running the command with multiple data on single invocation.

Examples

Querying Kryptoradio wallet balance:

stratum-tool blockchain.address.get_balance 1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5

Query multiple wallets at once

stratum-tool -m blockchain.address.get_balance 1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5 1duckuPMxPbfDvx2HBBtGHataWtqb9X1Z

Single command with multiple arguments:

stratum-tool blockchain.utxo.get_address 7e791721c61415d26966ab8530ffd550a045ad1b79ca870a4eca14f57b6a5b8c 1

Subscribe to given addresses and print their balances while they change. Output is forwarded to ts which inserts timestamp to the beginning. The addresses in this example are a collection of most active bitcoin addresses. (since v0.0.2):

stratum-tool -fs blockchain.address.get_balance 1NxaBCFQwejSZbQfWcYNwgqML5wWoE3rK4 1bonesyw5998F8JuMtUeRfyR5j2en5MxN 1LuckyB5VGzdZLZSBZvw8DR17iiFCpST7L 1bonesU8XznVHnMCs5oDsPVRcQAqo1Hth | ts

For more information, see stratum-tool --help

Output format

The output depends on output formatting and Stratum command. By default the output format is JSON in breadcrumbs format which is useful for shell scripts and humans:

$ stratum-tool -m blockchain.address.get_balance 1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5 1duckuPMxPbfDvx2HBBtGHataWtqb9X1Z
1duckuPMxPbfDvx2HBBtGHataWtqb9X1Z.unconfirmed = 0
1duckuPMxPbfDvx2HBBtGHataWtqb9X1Z.confirmed = 2317254
1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5.unconfirmed = 0
1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5.confirmed = 71286480

When using --json option the output format is JSON:

$ stratum-tool -j -m blockchain.address.get_balance 1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5 1duckuPMxPbfDvx2HBBtGHataWtqb9X1Z
{"1duckuPMxPbfDvx2HBBtGHataWtqb9X1Z":{"unconfirmed":0,"confirmed":2317254},"1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5":{"unconfirmed":0,"confirmed":71286480}}

Currency conversion

Since version 0.0.3, it is possible to use BitPay exchange rates for converting bitcoin amounts to your currency. See list of supported currencies. Example usage: --currency EUR.

Encryption

Since version 0.0.4, SSL encryption is enabled by default without certificate checks. Electrum servers use self-signed certificates anyway so you should be a bit cautious if you connect over insecure network. You can force certificate check with -S safessl run time option. The encryption can be disabled at build time using -ssl flag which results much easier build-time dependencies.

Compiling

StratumTool is written in Haskell and can be built using Cabal.

If you are running Ubuntu and you like to build from sources I recommend adding our PPA and installing all the build dependencies from there:

sudo apt-get build-dep stratum-tool

If PPA is not an option then I recommend using Cabal with a sandbox. In the root directory of the source package, run:

cabal update
cabal sandbox init
cabal install

The binaries will be placed at .cabal/bin inside the sandboxed source directory.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Contact

Bug reports and feature requests are welcome via GitHub issues. You can also contact the author via e-mail address [email protected].

If you find this product useful you can show your support to Kryptoradio project (1FvEggFtNSYS9pcBoYB9wDxH9fa1mrNPW5) or buy some stuff from BTC Store. :-)