lbcd/chaincfg
Dave Collins c7e5d56b58 chaincfg: Register networks instead of hard coding. (#660)
This modifies the chaincfg package to register the default network
params via the init function instead of manually hard coding their data
into the maps.  This is less error prone when adding new default
networks.

A new function named mustRegister has been introduced that panics if
there are any errors when registering the network that the new code
makes use of and appropriate tests have been added.
2016-04-11 12:34:28 -05:00
..
doc.go Import btcnet repo into chaincfg directory. 2015-02-05 21:53:44 -06:00
genesis.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
genesis_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
internal_test.go Import btcnet repo into chaincfg directory. 2015-02-05 21:53:44 -06:00
params.go chaincfg: Register networks instead of hard coding. (#660) 2016-04-11 12:34:28 -05:00
params_test.go chaincfg: Register networks instead of hard coding. (#660) 2016-04-11 12:34:28 -05:00
README.md docs: Make various README.md files consistent. 2015-10-23 14:51:36 -05:00
register_test.go Import btcnet repo into chaincfg directory. 2015-02-05 21:53:44 -06:00

chaincfg

[Build Status] (https://travis-ci.org/btcsuite/btcd) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [GoDoc] (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

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

$ 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:

    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:

    git tag -v TAG_NAME
    

License

Package chaincfg is licensed under the copyfree ISC License.