mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 01:40:07 +01:00
Code Issues Projects Releases Wiki Activity
master
btcd/rpcclient
History
Oliver Gugger 24eb815168
Merge pull request #2256 from ziggie1984/timeout-https-client 
rpcclient: add timeout to http request.
2024-10-11 06:58:36 -06:00
..
examples Formatting code with gofmt 2024-09-25 17:56:44 +08:00
backend_version_test.go multi: turn BackendVersion into an interface 2024-02-27 23:04:47 +08:00
backend_version.go multi: turn BackendVersion into an interface 2024-02-27 23:04:47 +08:00
chain_test.go fix typos (#2100) 2024-03-25 09:44:25 -04:00
chain.go main: Add invalidateblock and reconsiderblock rpc commands 2024-06-19 19:58:37 -04: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 multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
errors_test.go rpcclient: define specific errors for chain backends 2024-03-18 23:08:47 +08:00
errors.go rpcclient: update error str to match both versions (#2205) 2024-06-25 10:27:44 -04:00
example_test.go rpcclient: implement createwallet with functional options 2020-10-26 14:54:05 -04:00
extensions.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
infrastructure.go Merge pull request #2256 from ziggie1984/timeout-https-client 2024-10-11 06:58:36 -06:00
log.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
mining.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
net.go rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
notify.go fix typos (#2100) 2024-03-25 09:44:25 -04:00
rawrequest.go rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
rawtransactions.go Merge pull request #2142 from YusukeShimizu/feeRate-BTCkvB 2024-04-02 19:19:26 -07:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00
wallet.go Fix struct names (#2169) 2024-06-19 11:38:54 -04:00
zmq.go fix: typo (#2184) 2024-06-19 11:36:16 -04: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.