btcd/chaincfg
Olaoluwa Osuntokun 987745ed25 blockchain: implement AlwaysActiveHeight for forced deployment activation
This commit introduces the concept of `AlwaysActiveHeight` to the
deployment mechanism, allowing a deployment to be forced into the active
state if the next block's height meets or exceeds this threshold.

This is intended primarily to be used alongside the new Testnet4
deployment, as the past major soft forks are meant to be active from the
very first block height.
2025-03-12 13:24:20 -05:00
..
chainhash bump go mod versions 2025-02-10 16:37:15 +09:00
deployment_time_frame.go chaincfg: use DeploymentStarter/DeploymentEnder instead of start/end times 2022-01-25 15:27:37 -08:00
doc.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
genesis.go chaincfg: add TestNet4 params 2025-03-11 14:52:25 -05:00
genesis_test.go chaincfg: add TestNet4 params 2025-03-11 14:52:25 -05:00
params.go blockchain: implement AlwaysActiveHeight for forced deployment activation 2025-03-12 13:24:20 -05:00
params_test.go wire: add bitcoin network magic for default SigNet 2024-11-25 10:29:15 -03: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 TestNet4 params 2025-03-11 14:52:25 -05: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.