go-electrum

README

go-electrum

A pure Go Electrum bitcoin library supporting the latest ElectrumX protocol versions.
This makes it easy to write cryptocurrencies based services in a trustless fashion using Go without having to run a full node.

Packages provided

• electrum - Library for using JSON-RPC to talk directly to Electrum servers.

Usage

See example/ for more.

electrum

$ go get -u github.com/checksum0/go-electrum/electrum

package main

import (
  "log"

  "github.com/checksum0/go-electrum/electrum"
)

func main() {
	// Establishing a new SSL connection to an ElectrumX server
	server := electrum.NewServer()
	if err := server.ConnectTCP("bch.imaginary.cash:50001"); err != nil {
		log.Fatal(err)
	}

	// Making sure connection is not closed with timed "server.ping" call
	go func() {
		for {
			if err := server.Ping(); err != nil {
				log.Fatal(err)
			}
			time.Sleep(60 * time.Second)
		}
	}()

	// Making sure we declare to the server what protocol we want to use
	if err := server.ServerVersion(); err != nil {
		log.Fatal(err)
	}

	// Asking the server for the balance of address 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa
	// We must use scripthash of the address now as explained in ElectrumX docs
	scripthash := "8b01df4e368ea28f8dc0423bcf7a4923e3a12d307c875e47a0cfbf90b5c39161"
	balance, err := server.GetBalance(scripthash)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Address confirmed balance:   %+v", balance.Confirmed)
	log.Printf("Address unconfirmed balance: %+v", balance.Unconfirmed)
}

License

go-electrum is licensed under the MIT license. See LICENSE file for more details.

Copyright (c) 2019 Ian Descôteaux
Copyright (c) 2015 Tristan Rice

Based on Tristan Rice go-electrum unmaintained library.