peer: Refactor peer code into its own package.
This commit introduces package peer which contains peer related features
refactored from peer.go.
The following is an overview of the features the package provides:
- Provides a basic concurrent safe bitcoin peer for handling bitcoin
communications via the peer-to-peer protocol
- Full duplex reading and writing of bitcoin protocol messages
- Automatic handling of the initial handshake process including protocol
version negotiation
- Automatic periodic keep-alive pinging and pong responses
- Asynchronous message queueing of outbound messages with optional
channel for notification when the message is actually sent
- Inventory message batching and send trickling with known inventory
detection and avoidance
- Ability to wait for shutdown/disconnect
- Flexible peer configuration
- Caller is responsible for creating outgoing connections and listening
for incoming connections so they have flexibility to establish
connections as they see fit (proxies, etc.)
- User agent name and version
- Bitcoin network
- Service support signalling (full nodes, bloom filters, etc.)
- Maximum supported protocol version
- Ability to register callbacks for handling bitcoin protocol messages
- Proper handling of bloom filter related commands when the caller does
not specify the related flag to signal support
- Disconnects the peer when the protocol version is high enough
- Does not invoke the related callbacks for older protocol versions
- Snapshottable peer statistics such as the total number of bytes read
and written, the remote address, user agent, and negotiated protocol
version
- Helper functions for pushing addresses, getblocks, getheaders, and
reject messages
- These could all be sent manually via the standard message output
function, but the helpers provide additional nice functionality such
as duplicate filtering and address randomization
- Full documentation with example usage
- Test coverage
In addition to the addition of the new package, btcd has been refactored
to make use of the new package by extending the basic peer it provides to
work with the blockmanager and server to act as a full node. The
following is a broad overview of the changes to integrate the package:
- The server is responsible for all connection management including
persistent peers and banning
- Callbacks for all messages that are required to implement a full node
are registered
- Logic necessary to serve data and behave as a full node is now in the
callback registered with the peer
Finally, the following peer-related things have been improved as a part
of this refactor:
- Don't log or send reject message due to peer disconnects
- Remove trace logs that aren't particularly helpful
- Finish an old TODO to switch the queue WaitGroup over to a channel
- Improve various comments and fix some code consistency cases
- Improve a few logging bits
- Implement a most-recently-used nonce tracking for detecting self
connections and generate a unique nonce for each peer
2015-10-02 08:03:20 +02:00
|
|
|
peer
|
|
|
|
|
====
|
|
|
|
|
|
2017-05-25 18:29:23 +02:00
|
|
|
[](http://copyfree.org)
|
peer: Refactor peer code into its own package.
This commit introduces package peer which contains peer related features
refactored from peer.go.
The following is an overview of the features the package provides:
- Provides a basic concurrent safe bitcoin peer for handling bitcoin
communications via the peer-to-peer protocol
- Full duplex reading and writing of bitcoin protocol messages
- Automatic handling of the initial handshake process including protocol
version negotiation
- Automatic periodic keep-alive pinging and pong responses
- Asynchronous message queueing of outbound messages with optional
channel for notification when the message is actually sent
- Inventory message batching and send trickling with known inventory
detection and avoidance
- Ability to wait for shutdown/disconnect
- Flexible peer configuration
- Caller is responsible for creating outgoing connections and listening
for incoming connections so they have flexibility to establish
connections as they see fit (proxies, etc.)
- User agent name and version
- Bitcoin network
- Service support signalling (full nodes, bloom filters, etc.)
- Maximum supported protocol version
- Ability to register callbacks for handling bitcoin protocol messages
- Proper handling of bloom filter related commands when the caller does
not specify the related flag to signal support
- Disconnects the peer when the protocol version is high enough
- Does not invoke the related callbacks for older protocol versions
- Snapshottable peer statistics such as the total number of bytes read
and written, the remote address, user agent, and negotiated protocol
version
- Helper functions for pushing addresses, getblocks, getheaders, and
reject messages
- These could all be sent manually via the standard message output
function, but the helpers provide additional nice functionality such
as duplicate filtering and address randomization
- Full documentation with example usage
- Test coverage
In addition to the addition of the new package, btcd has been refactored
to make use of the new package by extending the basic peer it provides to
work with the blockmanager and server to act as a full node. The
following is a broad overview of the changes to integrate the package:
- The server is responsible for all connection management including
persistent peers and banning
- Callbacks for all messages that are required to implement a full node
are registered
- Logic necessary to serve data and behave as a full node is now in the
callback registered with the peer
Finally, the following peer-related things have been improved as a part
of this refactor:
- Don't log or send reject message due to peer disconnects
- Remove trace logs that aren't particularly helpful
- Finish an old TODO to switch the queue WaitGroup over to a channel
- Improve various comments and fix some code consistency cases
- Improve a few logging bits
- Implement a most-recently-used nonce tracking for detecting self
connections and generate a unique nonce for each peer
2015-10-02 08:03:20 +02:00
|
|
|
|
|
|
|
|
Package peer provides a common base for creating and managing bitcoin network
|
|
|
|
|
peers.
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
2015-10-23 04:31:31 +02:00
|
|
|
This package builds upon the wire package, which provides the fundamental
|
|
|
|
|
primitives necessary to speak the bitcoin 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
|
|
|
|
|
communications via the peer-to-peer protocol
|
|
|
|
|
- Full duplex reading and writing of bitcoin protocol messages
|
|
|
|
|
- Automatic handling of the initial handshake process including protocol
|
|
|
|
|
version negotiation
|
|
|
|
|
- Asynchronous message queueing of outbound messages with optional channel for
|
|
|
|
|
notification when the message is actually sent
|
|
|
|
|
- Flexible peer configuration
|
|
|
|
|
- Caller is responsible for creating outgoing connections and listening for
|
|
|
|
|
incoming connections so they have flexibility to establish connections as
|
|
|
|
|
they see fit (proxies, etc)
|
|
|
|
|
- User agent name and version
|
|
|
|
|
- Bitcoin network
|
|
|
|
|
- Service support signalling (full nodes, bloom filters, etc)
|
|
|
|
|
- Maximum supported protocol version
|
|
|
|
|
- Ability to register callbacks for handling bitcoin protocol messages
|
|
|
|
|
- Inventory message batching and send trickling with known inventory detection
|
|
|
|
|
and avoidance
|
|
|
|
|
- Automatic periodic keep-alive pinging and pong responses
|
|
|
|
|
- Random nonce generation and self connection detection
|
|
|
|
|
- Proper handling of bloom filter related commands when the caller does not
|
|
|
|
|
specify the related flag to signal support
|
|
|
|
|
- Disconnects the peer when the protocol version is high enough
|
|
|
|
|
- Does not invoke the related callbacks for older protocol versions
|
|
|
|
|
- Snapshottable peer statistics such as the total number of bytes read and
|
|
|
|
|
written, the remote address, user agent, and negotiated protocol version
|
|
|
|
|
- Helper functions pushing addresses, getblocks, getheaders, and reject
|
|
|
|
|
messages
|
|
|
|
|
- These could all be sent manually via the standard message output function,
|
|
|
|
|
but the helpers provide additional nice functionality such as duplicate
|
|
|
|
|
filtering and address randomization
|
|
|
|
|
- Ability to wait for shutdown/disconnect
|
|
|
|
|
- Comprehensive test coverage
|
2021-08-19 20:41:48 +02:00
|
|
|
|
