github.com/palcoin-project/palcd@v1.0.0/netsync/README.md (about)

     1  netsync
     2  =======
     3  
     4  [![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
     5  [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
     6  [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/netsync)
     7  
     8  ## Overview
     9  
    10  This package implements a concurrency safe block syncing protocol. The
    11  SyncManager communicates with connected peers to perform an initial block
    12  download, keep the chain and unconfirmed transaction pool in sync, and announce
    13  new blocks connected to the chain. Currently the sync manager selects a single
    14  sync peer that it downloads all blocks from until it is up to date with the
    15  longest chain the sync peer is aware of.
    16  
    17  ## Installation and Updating
    18  
    19  ```bash
    20  $ go get -u github.com/btcsuite/btcd/netsync
    21  ```
    22  
    23  ## License
    24  
    25  Package netsync is licensed under the [copyfree](http://copyfree.org) ISC License.