Mirroristas/kaspad
2
0
Fork 0
mirror of https://github.com/kaspanet/kaspad.git synced 2025-09-13 21:10:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
kaspad/rpcclient
History
stasatdaglabs 49418f4222 [NOD-669] Rename start/endHash -> low/highHash (#591) 
* [NOD-669] Remove the "get" from getBlueBlocksBetween.

* [NOD-669] Remove the "Get" from GetBlueBlocksHeadersBetween.

* [NOD-669] In blueBlocksBetween, rename startHash to lowHash and stopHash to highHash.

* [NOD-669] Rename startHash to lowHash and stopHash to highHash in blockLocator logic.

* [NOD-669] Remove zeroHash logic in blockLocator.

* [NOD-669] Finish renaming startHash and stopHash in blockdag.

* [NOD-669] Rename startHash and stopHash in blockdag where I previously missed it.

* [NOD-669] Rename startHash and stopHash in blockdag where I previously missed it some more.

* [NOD-669] Rename startHash and stopHash in blockdag where I previously missed it some more some more.

* [NOD-669] Fix bad grammar in method names.

* [NOD-669] Rename lowHash to blockHash in SelectedParentChain.

* [NOD-669] Fix a comment.
2020-01-20 12:47:16 +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-510] Change all references to Bitcoin to Kaspa (#531)
2019-12-12 15:21:41 +02:00
doc.go
[NOD-517] Update doc.go files (#559)
2020-01-02 16:57:43 +02:00
infrastructure.go
[NOD-532] Replace "chain" with "DAG" where appropriate (#537)
2019-12-17 13:40:03 +02:00
log.go
[NOD-590] Export newLogClosure (#557)
2019-12-26 18:26:22 +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-669] Rename start/endHash -> low/highHash (#591)
2020-01-20 12:47:16 +02:00
notify.go
[NOD-668] Rename height to blueScore in OnFilteredBlockAdded. (#589)
2020-01-16 14:10:26 +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-532] Replace "chain" with "DAG" where appropriate (#537)
2019-12-17 13:40:03 +02:00
README.md
[NOD-494] Update readmes (#543)
2019-12-16 17:37:17 +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