btcd/chaincfg
Olaoluwa Osuntokun dc4dc15d8c
chaincfg: create new abstract deployment starter/ender interfaces
In this commit, we create a series of new interfaces that'll allow us to
abstract "when" exactly a deployment starts and ends. As is, all
deployments start/end based on a unix timestamp, which is compared
against the MTP of a given block to determine if a new deployment has
started or ended. This works fine for BIP 9 which uses time based
timeouts, but not so much for BIP 8. In order to prep a future refactor
that allows our version bits implementation to support both time and
block based start/end times, this new abstraction has been introduced.
2022-01-25 15:27:30 -08:00
..
chainhash docs: update shields 2021-03-05 07:45:19 -05:00
deployment_time_frame.go chaincfg: create new abstract deployment starter/ender interfaces 2022-01-25 15:27:30 -08:00
doc.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
genesis.go wire+chaincfg: add signet params 2021-04-22 13:10:44 +02:00
genesis_test.go wire+chaincfg: add signet params 2021-04-22 13:10:44 +02:00
params.go chaincfg: fix deployment bit numbers 2021-05-11 15:55:06 -04:00
params_test.go wire+chaincfg: add signet params 2021-04-22 13:10:44 +02:00
README.md multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08: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/btcd/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.