LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity
An alternative full node implementation of LBRY's blockchain written in Go (golang)
26 commits 9 branches 35 tags 20 MiB
Go 99.9%
Shell 0.1%
Find a file
Dave Collins 0fc9504da4 Improve overview in doc.go.
2014-05-10 02:50:19 -05:00
examples Add README.md for bitcoincorehttp example. 2014-05-09 21:09:51 -05:00
.gitignore Initial commit. 2014-05-07 11:14:39 -05:00
.travis.yml Add support for TravisCI. 2014-05-09 01:16:47 -05:00
chain.go Make btcrpcclient use the new and consistent reply types. 2014-05-07 11:23:00 -05:00
CONTRIBUTORS Add CONTRIBUTORS file. 2014-05-07 11:23:16 -05:00
doc.go Improve overview in doc.go. 2014-05-10 02:50:19 -05:00
extensions.go Initial commit. 2014-05-07 11:14:39 -05:00
infrastructure.go Auto recreate notification state on reconnect. 2014-05-10 02:15:09 -05:00
LICENSE Initial commit. 2014-05-07 11:14:39 -05:00
log.go Initial commit. 2014-05-07 11:14:39 -05:00
mining.go Make btcrpcclient use the new and consistent reply types. 2014-05-07 11:23:00 -05:00
net.go Make btcrpcclient use the new and consistent reply types. 2014-05-07 11:23:00 -05:00
notify.go Auto recreate notification state on reconnect. 2014-05-10 02:15:09 -05:00
rawtransactions.go Convert CreateRawTransaction to higher-level types. 2014-05-09 21:24:25 -05:00
README.md Update README.md. 2014-05-10 02:48:11 -05:00
wallet.go Fix FutureWalletPassphraseChange.Receive comment. 2014-05-08 13:12:56 -05:00

README.md

btcrpcclient

[Build Status] (https://travis-ci.org/conformal/btcrpcclient) [GoDoc] (http://godoc.org/github.com/conformal/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
  • 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 asynchrous 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/conformal/btcrpcclient

License

Package btcrpcclient is licensed under the copyfree ISC License.