2017-08-24 22:33:51 +02:00
|
|
|
netsync
|
|
|
|
=======
|
|
|
|
|
2021-03-04 23:12:45 +01:00
|
|
|
[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
|
2017-08-24 22:33:51 +02:00
|
|
|
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
2021-03-04 23:12:45 +01:00
|
|
|
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/netsync)
|
2017-08-24 22:33:51 +02:00
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2017-08-24 23:46:59 +02:00
|
|
|
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.
|
2017-08-24 22:33:51 +02:00
|
|
|
|
|
|
|
## Installation and Updating
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ go get -u github.com/btcsuite/btcd/netsync
|
|
|
|
```
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
Package netsync is licensed under the [copyfree](http://copyfree.org) ISC License.
|