Mirroristas/kaspad
2
0
Fork 0
mirror of https://github.com/kaspanet/kaspad.git synced 2025-03-30 15:08:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
kaspad/rpcclient
History
stasatdaglabs 3d8dd8724d
[NOD-816] Remove TxIndex and AddrIndex (#653) 
* [NOD-816] Remove TxIndex.

* [NOD-816] Remove AddrIndex.

* [NOD-816] Remove mentions of TxIndex and AddrIndex.

* [NOD-816] Remove mentions of getrawtransaction.

* [NOD-816] Remove mentions of searchrawtransaction.

* [NOD-816] Remove cmd/addsubnetwork.

* [NOD-816] Fix a comment.

* [NOD-816] Fix a comment.

* [NOD-816] Implement BlockDAG.TxConfirmations.

* [NOD-816] Return confirmations in getTxOut.

* [NOD-816] Rename TxConfirmations to UTXOConfirmations.

* [NOD-816] Rename txConfirmations to utxoConfirmations.

* [NOD-816] Fix capitalization in variable names.

* [NOD-816] Add acceptance index to addblock.

* [NOD-816] Get rid of txrawresult-confirmations.

* [NOD-816] Fix config flag.
2020-03-10 16:09:31 +02:00
..
examples
[NOD-668] Rename height to blueScore in OnFilteredBlockAdded. (#589)
2020-01-16 14:10:26 +02:00
CONTRIBUTORS
Import btcrpcclient repo into rpcclient directory.
2017-08-15 19:51:58 -05:00
dag.go
[NOD-754] Fix staticcheck errors (#627)
2020-02-18 16:56:38 +02:00
doc.go
[NOD-641] Upgrade to github.com/pkg/errors v0.9.1 and use errors.As where needed (#614)
2020-02-03 12:38:33 +02:00
infrastructure.go
[NOD-721] Add defers (#638)
2020-02-24 09:19:44 +02:00
log.go
[NOD-806] Exit early after panic (#650)
2020-03-08 11:24:37 +02:00
mining.go
[NOD-650] Remove CPU miner from the node and add kaspaminer in ./cmd (#587)
2020-01-19 15:18:26 +02:00
net.go
[NOD-738] Move rpcmodel helper functions to pointers package (#629)
2020-02-18 14:06:34 +02:00
notify.go
[NOD-754] Fix staticcheck errors (#627)
2020-02-18 16:56:38 +02:00
rawrequest.go
[NOD-510] Change all references to Bitcoin to Kaspa (#531)
2019-12-12 15:21:41 +02:00
rawtransactions.go
[NOD-816] Remove TxIndex and AddrIndex (#653)
2020-03-10 16:09:31 +02:00
README.md
[NOD-693] Update link to license (#639)
2020-02-20 17:12:53 +02:00

README.md

rpcclient

ISC License GoDoc

rpcclient implements a Websocket-enabled Kaspa JSON-RPC client package written in Go. It provides a robust and easy to use client for interfacing with a Kaspa RPC server that uses a kaspad compatible Kaspa 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
  • Websockets Example Connects to a kaspad RPC server using TLS-secured websockets, registers for block connected and block disconnected notifications, and gets the current block count
  • HTTP POST Example Connects to a kaspad RPC server using HTTP POST mode with TLS disabled and gets the current block count

Major Features

  • Supports Websockets and HTTP POST mode
  • Provides callback and registration functions for kaspad notifications
  • 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