An alternative full node implementation of LBRY's blockchain written in Go (golang)
Find a file
Dave Collins 9ca93b30ad Update to make use of latest version of btcjson.
This commit contains several changes needed to update the client to use
the latest version of btcjson.  In addition, it contains a couple of other
minor changes along the way.

While the underlying changes are quite large, the public API of this
package is still the same, so caller should generally not have to update
their code due to that.  However, the underlying btcjson package API has
changed significantly.  Since this package hides the vast majority of that
from callers, it should not afffect them very much.  However, one area in
particular to watch out for is that the old btcjson.Error is now
btcjson.RPCError, so any callers doing any type assertions there will need
to update.

The following is a summary of the changes:

- The underlying btcjson significantly changed how commands work, so the
  internals of this package have been reworked to be based off of requests
  instead of the now non-existant btcjson.Cmd interface
- Update all call sites of btcjson.New<Foo>Cmd since they can no longer
  error or take varargs
- The ids for each request are part of the request now instead of the
  command to match the new btcjson model and are strict uint64s so type
  assertions are no longer needed (slightly improved efficiency)
- Remove the old temporary workaround for the getbalance command with an
  account of "*" since btcwallet has since been fixed
- Change all instances of JSONToAmount to btcutil.NewAmount since that
  function was removed in favor of btcutil.Amount
- Change all btcws invocations to btcjson since they have been combined
2015-04-05 22:56:39 -05:00
examples Update btcwire path import paths to new location. 2015-02-05 15:50:03 -06:00
.gitignore Initial commit. 2014-05-07 11:14:39 -05:00
.travis.yml Update Go versions for Travis. 2015-02-05 17:24:42 -05:00
chain.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
CONTRIBUTORS Update CONTRIBUTORS. 2014-06-02 09:50:03 -05:00
doc.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
extensions.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
goclean.sh Update TravisCI to goclean script. 2015-01-15 20:58:39 -06:00
infrastructure.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
LICENSE Update license year to 2015. 2015-01-03 02:24:28 -06:00
log.go Update btclog import paths to new location. 2015-01-16 13:08:45 -06:00
mining.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
net.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
notify.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
rawrequest.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
rawtransactions.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00
README.md Update btcrpcclient import paths to new location. 2015-01-15 21:21:40 -06:00
wallet.go Update to make use of latest version of btcjson. 2015-04-05 22:56:39 -05:00

btcrpcclient

[Build Status] (https://travis-ci.org/btcsuite/btcrpcclient) [GoDoc] (http://godoc.org/github.com/btcsuite/btcrpcclient)

btcrpcclient implements a Websocket-enabled Bitcoin JSON-RPC client package written in Go. It provides a robust and easy to use client for interfacing with a Bitcoin RPC server that uses a btcd/bitcoin core compatible Bitcoin JSON-RPC API.

Status

This package is currently under active development. It is already stable and the infrastructure is complete. However, there are still several RPCs left to implement and the API is not stable yet.

Documentation

  • API Reference
  • btcd Websockets Example
    Connects to a btcd RPC server using TLS-secured websockets, registers for block connected and block disconnected notifications, and gets the current block count
  • btcwallet Websockets Example
    Connects to a btcwallet RPC server using TLS-secured websockets, registers for notifications about changes to account balances, and gets a list of unspent transaction outputs (utxos) the wallet can sign
  • Bitcoin Core HTTP POST Example
    Connects to a bitcoin core RPC server using HTTP POST mode with TLS disabled and gets the current block count

Major Features

  • Supports Websockets (btcd/btcwallet) and HTTP POST mode (bitcoin core)
  • Provides callback and registration functions for btcd/btcwallet notifications
  • Supports btcd extensions
  • Translates to and from higher-level and easier to use Go types
  • Offers a synchronous (blocking) and asynchronous API
  • When running in Websockets mode (the default):
    • Automatic reconnect handling (can be disabled)
    • Outstanding commands are automatically reissued
    • Registered notifications are automatically reregistered
    • Back-off support on reconnect attempts

Installation

$ go get github.com/btcsuite/btcrpcclient

License

Package btcrpcclient is licensed under the copyfree ISC License.