Mirroristas/kaspad
2
0
Fork 0
mirror of https://github.com/kaspanet/kaspad.git synced 2025-03-30 15:08:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
kaspad/peer
History
Ori Newman d2daf334a5 [NOD-241] Implement lower resolution peer rendezvous point discovery (#353) 
* [NOD-241] Implement lower resolution peer rendezvous point discovery

* [NOD-241] Implement lower resolution peer rendezvous point discovery

* [NOD-241] Find exact rendezvous point

* [NOD-241] Find exact rendezvous point

* [NOD-241] Fix tests

* [NOD-241] Remove hash stop from MsgBlockLocator and add tests to MsgBlockLocator and MsgGetBlockLocator

* [NOD-241] Change everywhere startHash to hashStart and change comments

* [NOD-241] Fix locateBlockNodes to stop at hashStop

* [NOD-241] Formatted locatorSummary.

* [NOD-241] Fix node reversal

* [NOD-241] Fix hash start and hash stop order, and don't include startNode in dag.blockLocator

* [NOD-241] rename locateBlockNodes -> getBlueBlocksBetween and add a comment to it

* [NOD-241] change hash start to start hash and hash stop to stop hash

* [NOD-241] Move block locator stuff to a different file

* [NOD-241] Rename msggetblocks.go to msggetblockinvs.go

* [NOD-241] Format project

* [NOD-241] Rename rpcserverSyncManager.LocateHeaders to GetBlueBlocksHeadersBetween

* [NOD-241] Move the logic of finding the highest shared block to OnBlockLocator

* [NOD-241] Rename chainHeight -> nextChainHeight

* [NOD-241] Fix typo in comment
2019-08-19 15:35:13 +03:00
..
doc.go
[NOD-262] Renamed all instances of GetBlocks to GetBlockInvs. (#359)
2019-08-11 12:25:29 +03:00
example_test.go
[NOD-64] Remove subnetwork id supports all (#237)
2019-04-03 17:03:48 +03:00
export_test.go
peer: Refactor peer code into its own package.
2015-10-23 06:17:29 +05:30
log.go
[NOD-241] Implement lower resolution peer rendezvous point discovery (#353)
2019-08-19 15:35:13 +03:00
mruinvmap_test.go
[NOD-176] Moved daghash from dagconfig to util (#298)
2019-05-14 14:05:36 +03:00
mruinvmap.go
[DEV-376] Changed any instance of %v in format strings with a more specific format token (#188)
2019-02-20 14:02:52 +02:00
mrunoncemap_test.go
peer: Refactor peer code into its own package.
2015-10-23 06:17:29 +05:30
mrunoncemap.go
multi: Simplify code per gosimple linter.
2017-07-01 02:25:10 -05:00
peer_test.go
[NOD-241] Implement lower resolution peer rendezvous point discovery (#353)
2019-08-19 15:35:13 +03:00
peer.go
[NOD-241] Implement lower resolution peer rendezvous point discovery (#353)
2019-08-19 15:35:13 +03:00
README.md
[NOD-262] Renamed all instances of GetBlocks to GetBlockInvs. (#359)
2019-08-11 12:25:29 +03:00

README.md

peer

Build Status ISC License GoDoc

Package peer provides a common base for creating and managing bitcoin 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.

Overview

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, getblockinvs, 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

Installation and Updating

$ go get -u github.com/daglabs/btcd/peer

Examples

  • New Outbound Peer Example
    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.

License

Package peer is licensed under the copyfree ISC License.