mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 09:50:08 +01:00
Code Issues Projects Releases Wiki Activity
2b6370dfd7
btcd/rpcclient
History
Olaoluwa Osuntokun caac0f821a
multi: update btcutil imports to point to new sub-module 
In this commit, we update all the btcutil imports to point to the new
sub-module.

In the same commit, we also modify the recently added `btcutil/go.mod`
file as we need to continue pointing to the _old_ version of btcd, until
we merge this PR and push a new tag.
2022-01-10 18:44:58 -08:00
..
examples multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
chain_test.go btcjson+rpcclient: support new unified softfork bitcoind format 2019-11-05 16:28:33 -08:00
chain.go rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
CONTRIBUTORS Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
cookiefile.go rpcclient: Read first line of cookie instead of trimming space 2020-06-08 09:51:09 -04:00
doc.go btcjson, rpclient: Fix typo 2020-03-04 09:23:11 -05:00
example_test.go rpcclient: implement createwallet with functional options 2020-10-26 14:54:05 -04:00
extensions.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
infrastructure.go rpcclient: Add retry with backoffs to HTTP POST requests 2021-11-16 09:08:07 -05:00
log.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
mining.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
net.go rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
notify.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
rawrequest.go rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
rawtransactions.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00
wallet.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00

README.md

rpcclient

Build Status ISC License GoDoc

rpcclient 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/btcd/rpcclient

License

Package rpcclient is licensed under the copyfree ISC License.