lbcd/chaincfg/README.md

99 lines
2.6 KiB
Markdown
Raw Normal View History

chaincfg
========
2014-05-22 19:45:08 +02:00
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
Package chaincfg defines chain configuration parameters for the three standard
Bitcoin networks and provides the ability for callers to define their own custom
2014-05-22 19:45:08 +02:00
Bitcoin networks.
Although this package was primarily written for btcd, it has intentionally been
2014-05-22 19:45:08 +02:00
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"
2014-05-22 19:45:08 +02:00
"github.com/btcsuite/btcutil"
"github.com/btcsuite/btcd/chaincfg"
2014-05-22 19:45:08 +02:00
)
var testnet = flag.Bool("testnet", false, "operate on the testnet Bitcoin network")
// By default (without -testnet), use mainnet.
var chainParams = &chaincfg.MainNetParams
2014-05-22 19:45:08 +02:00
func main() {
flag.Parse()
// Modify active network parameters if operating on testnet.
if *testnet {
chainParams = &chaincfg.TestNet3Params
2014-05-22 19:45:08 +02:00
}
// later...
// Create and print new payment address, specific to the active network.
pubKeyHash := make([]byte, 20)
addr, err := btcutil.NewAddressPubKeyHash(pubKeyHash, chainParams)
2014-05-22 19:45:08 +02:00
if err != nil {
log.Fatal(err)
2014-05-22 19:45:08 +02:00
}
fmt.Println(addr)
}
```
## Documentation
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/chaincfg)
2014-05-22 19:45:08 +02:00
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site
[here](http://godoc.org/github.com/btcsuite/btcd/chaincfg).
2014-05-22 19:45:08 +02:00
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/chaincfg
2014-05-22 19:45:08 +02:00
## Installation
```bash
$ go get github.com/btcsuite/btcd/chaincfg
2014-05-22 19:45:08 +02:00
```
## 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 Conformal. 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.