seedhammer/dcrd
seedhammer/dcrd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

peer: Update README.md/doc.go to reflect reality.

Browse Source
This commit is contained in:
Dave Collins 2020-08-06 12:20:07 -05:00
parent 3e0e466ac0
commit f1d6b2fc10
No known key found for this signature in database
GPG Key ID: B8904D9D9C93D1F2
2 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
peer/README.md
View File

@ -5,25 +5,25 @@ peer
[![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)
Package peer provides a common base for creating and managing bitcoin network
Package peer provides a common base for creating and managing Decred network
peers.
This package has intentionally been designed so it can be used as a standalone
package for any projects needing a full featured bitcoin peer base to build on.
package for any projects needing a full featured Decred peer base to build on.
## Overview
This package builds upon the wire package, which provides the fundamental
primitives necessary to speak the bitcoin wire protocol, in order to simplify
primitives necessary to speak the Decred wire protocol, in order to simplify
the process of creating fully functional peers. In essence, it provides a
common base for creating concurrent safe fully validating nodes, Simplified
Payment Verification (SPV) nodes, proxies, etc.
A quick overview of the major features peer provides are as follows:
- Provides a basic concurrent safe bitcoin peer for handling bitcoin
- Provides a basic concurrent safe Decred peer for handling Decred
communications via the peer-to-peer protocol
- Full duplex reading and writing of bitcoin protocol messages
- Full duplex reading and writing of Decred protocol messages
- Automatic handling of the initial handshake process including protocol
version negotiation
- Asynchronous message queueing of outbound messages with optional channel for
@ -33,10 +33,10 @@ A quick overview of the major features peer provides are as follows:
incoming connections so they have flexibility to establish connections as
they see fit (proxies, etc)
- User agent name and version
- Bitcoin network
- Decred network
- Service support signalling (full nodes, etc)
- Maximum supported protocol version
- Ability to register callbacks for handling bitcoin protocol messages
- Ability to register callbacks for handling Decred protocol messages
- Inventory message batching and send trickling with known inventory detection
and avoidance
- Automatic periodic keep-alive pinging and pong responses

1
peer/doc.go
View File

@ -140,6 +140,5 @@ raw message bytes using a format similar to hexdump -C.
Improvement Proposals
This package supports all improvement proposals supported by the wire package.
(https://pkg.go.dev/github.com/decred/dcrd/wire#hdr-Bitcoin_Improvement_Proposals)
*/
package peer