From f1d6b2fc10bad0a4c76bcd43932fe3236db9d538 Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Thu, 6 Aug 2020 12:20:07 -0500 Subject: [PATCH] peer: Update README.md/doc.go to reflect reality. --- peer/README.md | 14 +++++++------- peer/doc.go | 1 - 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/peer/README.md b/peer/README.md index 83197050..77181519 100644 --- a/peer/README.md +++ b/peer/README.md @@ -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 diff --git a/peer/doc.go b/peer/doc.go index 30553f52..e35e318b 100644 --- a/peer/doc.go +++ b/peer/doc.go @@ -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