mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 18:00:11 +01:00
Code Issues Projects Releases Wiki Activity
An alternative full node bitcoin implementation written in Go (golang)
143 Commits 4 Branches 66 Tags 58 MiB
Go 99.8%
Shell 0.1%
0519b86a9d
Go to file
Alex 0519b86a9d Add version command to JSON-RPC API for API versioning
2016-12-22 12:38:38 -05:00
examples Update for recent chainhash-related API changes. (#81) 2016-08-08 14:16:04 -05:00
.gitignore Initial commit. 2014-05-07 11:14:39 -05:00
.travis.yml Modify goclean to use gometalint like btcd 2016-11-16 15:00:41 -06:00
chain.go review: fix typos 2016-11-09 11:13:10 -08:00
CONTRIBUTORS Update CONTRIBUTORS. 2014-06-02 09:50:03 -05:00
doc.go Relicense to the btcsuite developers. 2015-05-01 12:03:51 -05:00
extensions.go Add version command to JSON-RPC API for API versioning 2016-12-22 12:38:38 -05:00
goclean.sh Remove -v from go test. 2016-12-07 10:14:06 -05:00
infrastructure.go Add gofmt to metalinter. 2016-11-16 16:01:47 -05:00
LICENSE Add version command to JSON-RPC API for API versioning 2016-12-22 12:38:38 -05:00
log.go Relicense to the btcsuite developers. 2015-05-01 12:03:51 -05:00
mining.go Simplify code per gosimple linter. 2016-11-16 15:05:11 -06:00
net.go Simplify code per gosimple linter. 2016-11-16 15:05:11 -06:00
notify.go Remove unnecessary convs found by unconvert. 2016-11-16 15:16:16 -06:00
rawrequest.go Relicense to the btcsuite developers. 2015-05-01 12:03:51 -05:00
rawtransactions.go Update for recent chainhash-related API changes. (#81) 2016-08-08 14:16:04 -05:00
README.md Update installation section in README.md 2016-09-15 14:25:23 -04:00
wallet.go Simplify code per gosimple linter. 2016-11-16 15:05:11 -06:00

README.md

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 -u github.com/btcsuite/btcrpcclient

License

Package btcrpcclient is licensed under the copyfree ISC License.