Categorygithub.com/tendermint/btcdnetsync
package
0.1.1
Repository: https://github.com/tendermint/btcd.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
14
Dependents
0
Files
1.4k SLOC

# README

netsync

Build Status ISC License GoDoc

Overview

This package implements a concurrency safe block syncing protocol. The SyncManager communicates with connected peers to perform an initial block download, keep the chain and unconfirmed transaction pool in sync, and announce new blocks connected to the chain. Currently the sync manager selects a single sync peer that it downloads all blocks from until it is up to date with the longest chain the sync peer is aware of.

Installation and Updating

$ go get -u github.com/btcsuite/btcd/netsync

License

Package netsync is licensed under the copyfree ISC License.

# Functions

DisableLog disables all library log output.
New constructs a new SyncManager.
UseLogger uses a specified Logger to output package logging info.

# Structs

Config is a configuration struct used to initialize a new SyncManager.
SyncManager is used to communicate block related messages with peers.

# Interfaces

PeerNotifier exposes methods to notify peers of status changes to transactions, blocks, etc.