Skip to content

docs: Update for rpcclient v9 module. #3729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jholdstock wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −9
Open

docs: Update for rpcclient v9 module. #3729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ https://decred.org/community/

The following versioned modules are provided by dcrd repository:

* [rpcclient/v8](https://github.com/decred/dcrd/tree/master/rpcclient) - Implements
* [rpcclient/v9](https://github.com/decred/dcrd/tree/master/rpcclient) - Implements
a robust and easy to use Websocket-enabled Decred JSON-RPC client
* [dcrjson/v4](https://github.com/decred/dcrd/tree/master/dcrjson) - Provides
infrastructure for working with Decred JSON-RPC APIs
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/module_hierarchy.gv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ digraph {
standalone [label="blockchain/standalone/v2" fillcolor=firebrick4]
lru [label="container/lru" fillcolor=royalblue3]
peer [label="peer/v3" fillcolor=khaki]
rpcclient [label="rpcclient/v8" fillcolor=mediumseagreen]
rpcclient [label="rpcclient/v9" fillcolor=mediumseagreen]
addrmgr [label="addrmgr/v3" fillcolor=lightsalmon]
blockchain [label="blockchain/v5" fillcolor=orchid]
apbf [label="container/apbf" fillcolor=goldenrod]
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/module_hierarchy.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/json_rpc_api.mediawiki
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3458,7 +3458,7 @@ import (
"path/filepath"

"github.com/decred/dcrd/dcrutil/v4"
"github.com/decred/dcrd/rpcclient/v8"
"github.com/decred/dcrd/rpcclient/v9"
)

func main() {
Expand Down Expand Up @@ -3522,7 +3522,7 @@ import (

"github.com/decred/dcrd/chaincfg/chainhash"
"github.com/decred/dcrd/dcrutil/v4"
"github.com/decred/dcrd/rpcclient/v8"
"github.com/decred/dcrd/rpcclient/v9"
)

func main() {
Expand Down Expand Up @@ -3612,7 +3612,7 @@ import (
"time"

"github.com/decred/dcrd/dcrutil/v4"
"github.com/decred/dcrd/rpcclient/v8"
"github.com/decred/dcrd/rpcclient/v9"
)

func main() {
Expand Down
6 changes: 3 additions & 3 deletions rpcclient/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ rpcclient

[![Build Status](https://github.com/decred/dcrd/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/dcrd/actions)
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![Doc](https://img.shields.io/badge/doc-reference-blue.svg)](https://pkg.go.dev/github.com/decred/dcrd/rpcclient/v8)
[![Doc](https://img.shields.io/badge/doc-reference-blue.svg)](https://pkg.go.dev/github.com/decred/dcrd/rpcclient/v9)

rpcclient implements a Websocket-enabled Decred JSON-RPC client package written
in [Go](https://golang.org/). It provides a robust and easy to use client for
Expand All @@ -18,7 +18,7 @@ implement and the API is not stable yet.

## Documentation

* [API Reference](https://pkg.go.dev/github.com/decred/dcrd/rpcclient/v8)
* [API Reference](https://pkg.go.dev/github.com/decred/dcrd/rpcclient/v9)
* [dcrd Websockets Example](https://github.com/decred/dcrd/tree/master/rpcclient/examples/dcrdwebsockets)
Connects to a dcrd RPC server using TLS-secured websockets, registers for
block connected and block disconnected notifications, and gets the current
Expand All @@ -38,7 +38,7 @@ implement and the API is not stable yet.

## Installation and Updating

This package is part of the `github.com/decred/dcrd/rpcclient/v8` module. Use
This package is part of the `github.com/decred/dcrd/rpcclient/v9` module. Use
the standard go tooling for working with modules to incorporate it.

## License
Expand Down