Mirroristas/kaspad
2
0
Fork 0
mirror of https://github.com/kaspanet/kaspad.git synced 2025-10-13 16:49:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
kaspad/rpcclient
History
stasatdaglabs 8a234bf4a3 [DEV-242] Parameter names should be also camelCase in JSON-RPC (#118) 
* [DEV-242] Modified some help functionality to convert to lowercase camel case instead of just lowercase.

* [DEV-242] Corrected help functionality for struct field names.

* [DEV-242] Corrected help functionality for struct names.

* [DEV-242] Cleaned up toLowercaseCamelCase.

* [DEV-242] Renamed toLowercaseCamelCase to toCamelCase.

* [DEV-242] Converted the rest of the stuff in rpcserverhelp.go to camelCase. Fixed a bug in the camelCase converter.

* [DEV-242] camelCase-ified the last few RPC parameter names.

* [DEV-242] Fixed an off-by-one bug in toCamelCase.

* [DEV-242] Changed back from "jsonRpc" to "jsonrpc".

* [DEV-242] Moved toCamelCase into utils, wrote unit tests for it, and fixed an off-by-one bug.

* [DEV-242] Re-exported DefaultHomeDir because it's required in windows_service.go.

* [DEV-242] Added a comment above DefaultHomeDir to satisfy golint.

* [DEV-242] Formatted config/config.go.
2018-11-05 18:50:55 +02:00
..
examples
[DEV-134] Implement Continuous Integration (#105)
2018-10-25 18:58:41 +03:00
CONTRIBUTORS
Import btcrpcclient repo into rpcclient directory.
2017-08-15 19:51:58 -05:00
dag.go
[DEV-37] Rename rpcclient/chain.go -> dag.go + update all references to xxxChainxxx commands to xxxDAGxxx (#12)
2018-06-21 17:42:54 +03:00
doc.go
[DEV-134] Implement Continuous Integration (#105)
2018-10-25 18:58:41 +03:00
extensions.go
[DEV-134] Implement Continuous Integration (#105)
2018-10-25 18:58:41 +03:00
infrastructure.go
[DEV-134] Implement Continuous Integration (#105)
2018-10-25 18:58:41 +03:00
log.go
Import btcrpcclient repo into rpcclient directory.
2017-08-15 19:51:58 -05:00
mining.go
[DEV-127] remove getwork rpc command
2018-09-23 11:23:56 +03:00
net.go
[DEV-195] Implement addmanualnode, getallmanualnodesinfo, getmanualnodeinfo and removemanualnode RPC-API calls (#87)
2018-10-11 12:38:54 +03:00
notify.go
[DEV-134] Implement Continuous Integration (#105)
2018-10-25 18:58:41 +03:00
rawrequest.go
[DEV-242] Parameter names should be also camelCase in JSON-RPC (#118)
2018-11-05 18:50:55 +02:00
rawtransactions.go
[DEV-130] convert searchrawtransaction ints to bools (#61)
2018-09-23 11:30:47 +03:00
README.md
Updated references.
2018-06-03 18:34:09 +03:00
wallet.go
[DEV-242] Parameter names should be also camelCase in JSON-RPC (#118)
2018-11-05 18:50:55 +02: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/daglabs/btcd/rpcclient

License

Package rpcclient is licensed under the copyfree ISC License.