Skip to content

docs: Update docs for peer/v4. #3749

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
Open

docs: Update docs for peer/v4. #3749

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 @@ -180,7 +180,7 @@ The following versioned modules are provided by dcrd repository:
return values, and notifications
* [wire](https://github.com/decred/dcrd/tree/master/wire) - Implements the
Decred wire protocol
* [peer/v3](https://github.com/decred/dcrd/tree/master/peer) - Provides a common
* [peer/v4](https://github.com/decred/dcrd/tree/master/peer) - Provides a common
base for creating and managing Decred network peers
* [blockchain/v5](https://github.com/decred/dcrd/tree/master/blockchain) -
Implements Decred block handling and chain selection rules
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 @@ -24,7 +24,7 @@ digraph {
gcs [label="gcs/v4" fillcolor=gold]
standalone [label="blockchain/standalone/v2" fillcolor=firebrick4]
lru [label="container/lru" fillcolor=royalblue3]
peer [label="peer/v3" fillcolor=khaki]
peer [label="peer/v4" fillcolor=khaki]
rpcclient [label="rpcclient/v8" fillcolor=mediumseagreen]
addrmgr [label="addrmgr/v3" fillcolor=lightsalmon]
blockchain [label="blockchain/v5" fillcolor=orchid]
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 peer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ peer

[![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/peer/v2)
[![Doc](https://img.shields.io/badge/doc-reference-blue.svg)](https://pkg.go.dev/github.com/decred/dcrd/peer/v4)

Package peer provides a common base for creating and managing Decred network
peers.
Expand Down Expand Up @@ -53,12 +53,12 @@ A quick overview of the major features peer provides are as follows:

## Installation and Updating

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

## Examples

* [New Outbound Peer Example](https://pkg.go.dev/github.com/decred/dcrd/peer/v3#example-package-NewOutboundPeer)
* [New Outbound Peer Example](https://pkg.go.dev/github.com/decred/dcrd/peer/v4#example-package-NewOutboundPeer)
Demonstrates the basic process for initializing and creating an outbound peer.
Peers negotiate by exchanging version and verack messages. For demonstration,
a simple handler for the version message is attached to the peer.
Expand Down