3942a116e4
First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Finally, it's modifies the Installation section to Installation and Updating and adds a '-u' to the 'go get' command since it works for both and thus is simpler.
87 lines
2.2 KiB
Markdown
87 lines
2.2 KiB
Markdown
chaincfg
|
|
========
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcd) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
[]
|
|
(http://godoc.org/github.com/btcsuite/btcd/chaincfg)
|
|
|
|
Package chaincfg defines chain configuration parameters for the three standard
|
|
Bitcoin networks and provides the ability for callers to define their own custom
|
|
Bitcoin networks.
|
|
|
|
Although this package was primarily written for btcd, it has intentionally been
|
|
designed so it can be used as a standalone package for any projects needing to
|
|
use parameters for the standard Bitcoin networks or for projects needing to
|
|
define their own network.
|
|
|
|
## Sample Use
|
|
|
|
```Go
|
|
package main
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"log"
|
|
|
|
"github.com/btcsuite/btcutil"
|
|
"github.com/btcsuite/btcd/chaincfg"
|
|
)
|
|
|
|
var testnet = flag.Bool("testnet", false, "operate on the testnet Bitcoin network")
|
|
|
|
// By default (without -testnet), use mainnet.
|
|
var chainParams = &chaincfg.MainNetParams
|
|
|
|
func main() {
|
|
flag.Parse()
|
|
|
|
// Modify active network parameters if operating on testnet.
|
|
if *testnet {
|
|
chainParams = &chaincfg.TestNet3Params
|
|
}
|
|
|
|
// later...
|
|
|
|
// Create and print new payment address, specific to the active network.
|
|
pubKeyHash := make([]byte, 20)
|
|
addr, err := btcutil.NewAddressPubKeyHash(pubKeyHash, chainParams)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
fmt.Println(addr)
|
|
}
|
|
```
|
|
|
|
## Installation and Updating
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcd/chaincfg
|
|
```
|
|
|
|
## GPG Verification Key
|
|
|
|
All official release tags are signed by Conformal so users can ensure the code
|
|
has not been tampered with and is coming from the btcsuite developers. To
|
|
verify the signature perform the following:
|
|
|
|
- Download the public key from the Conformal website at
|
|
https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
|
|
|
|
- Import the public key into your GPG keyring:
|
|
```bash
|
|
gpg --import GIT-GPG-KEY-conformal.txt
|
|
```
|
|
|
|
- Verify the release tag with the following command where `TAG_NAME` is a
|
|
placeholder for the specific tag:
|
|
```bash
|
|
git tag -v TAG_NAME
|
|
```
|
|
|
|
## License
|
|
|
|
Package chaincfg is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|