mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-06-03 12:46:43 +00:00
3d45c8de50
* [NOD-1130] Delete rpcadapters.go. * [NOD-1130] Delete p2p. Move rpc to top level. * [NOD-1130] Remove DAGParams from rpcserverConfig. * [NOD-1130] Remove rpcserverPeer, rpcserverConnManager, rpcserverSyncManager, and rpcserverConfig. * [NOD-1130] Remove wallet RPC commands. * [NOD-1130] Remove wallet RPC commands. * [NOD-1130] Remove connmgr and peer. * [NOD-1130] Move rpcmodel into rpc. * [NOD-1130] Implement ConnectionCount. * [NOD-1130] Remove ping and node RPC commands. * [NOD-1130] Dummify handleGetNetTotals. * [NOD-1130] Add NetConnection to Peer. * [NOD-1130] Fix merge errors. * [NOD-1130] Implement Peers. * [NOD-1130] Fix HandleGetConnectedPeerInfo. * [NOD-1130] Fix SendRawTransaction. * [NOD-1130] Rename addManualNode to connect and removeManualNode to disconnect. * [NOD-1130] Add a stub for AddBlock. * [NOD-1130] Fix tests. * [NOD-1130] Replace half-baked contents of RemoveConnection with a stub. * [NOD-1130] Fix merge errors. * [NOD-1130] Make golint happy. * [NOD-1130] Get rid of something weird. * [NOD-1130] Rename minerClient back to client. * [NOD-1130] Add a few fields to GetConnectedPeerInfoResult. * [NOD-1130] Rename oneTry to isPermanent. * [NOD-1130] Implement ConnectionCount in NetAdapter. * [NOD-1130] Move RawMempoolVerbose out of mempool. * [NOD-1130] Move isSynced into the mining package. * [NOD-1130] Fix a compilation error. * [NOD-1130] Make golint happy. * [NOD-1130] Fix merge errors.
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
rpcclient
|
|
=========
|
|
|
|
[](https://choosealicense.com/licenses/isc/)
|
|
[](http://godoc.org/github.com/kaspanet/kaspad/rpcclient)
|
|
|
|
rpcclient implements a Websocket-enabled Kaspa JSON-RPC client package written
|
|
in [Go](http://golang.org/). 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](http://godoc.org/github.com/kaspanet/kaspad/rpcclient)
|
|
* [Websockets Example](https://github.com/kaspanet/kaspad/blob/master/rpcclient/examples/websockets)
|
|
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](https://github.com/kaspanet/kaspad/rpcclient/blob/master/examples/httppost)
|
|
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
|
|
|