lbcd/chaincfg
2018-05-23 16:46:15 -07:00
..
chainhash multi: update to point to roasbeef forks 2018-05-23 16:46:15 -07:00
doc.go Import btcnet repo into chaincfg directory. 2015-02-05 21:53:44 -06:00
genesis.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
genesis_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
params.go chaincfg: change hrp prefix for regtest network 2018-04-17 20:01:12 -07:00
params_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
README.md multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
register_test.go chaincfg: Add IsBech32SegwitPrefix utility method. 2017-07-08 10:26:15 +02:00

chaincfg

Build Status ISC License GoDoc

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.