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
Ori Newman f72afc8bbb [NOD-499] Change ports and network magics (#550) 
* [NOD-499] Change network magics

* [NOD-499] Change default rpc ports

* [NOD-499] Change default p2p ports

* [NOD-499] Change port 18333 to 10433 everywhere

* [NOD-499] Change port 8333 to 10333 everywhere

* [NOD-499] Fix TestElementWire

* [NOD-499] Fix tests

* [NOD-499] Change port 10333->16111 and 10332->16110

* [NOD-499] Change port 10433->16211 and 10432->16210

* [NOD-499] Change port 10633->16511 and 10632->16510

* [NOD-499] Change port 10533->16611 and 10532->16610
2019-12-18 16:18:37 +02:00
..
examples
[NOD-499] Change ports and network magics (#550)
2019-12-18 16:18:37 +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-532] Replace "chain" with "DAG" where appropriate (#537)
2019-12-17 13:40:03 +02:00
infrastructure.go
[NOD-532] Replace "chain" with "DAG" where appropriate (#537)
2019-12-17 13:40:03 +02:00
log.go
[NOD-510] Change all references to Bitcoin to Kaspa (#531)
2019-12-12 15:21:41 +02:00
mining.go
[NOD-510] Change all references to Bitcoin to Kaspa (#531)
2019-12-12 15:21:41 +02:00
net.go
[NOD-532] Replace "chain" with "DAG" where appropriate (#537)
2019-12-17 13:40:03 +02:00
notify.go
[NOD-532] Replace "chain" with "DAG" where appropriate (#537)
2019-12-17 13:40:03 +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