dcrd/chaincfg
Dave Collins cecfb5a0b4
multi: Update README.md files for go modules.
This updates the installation and updating section of the README.md
files in the various packages to call out the module they are a part of
and instruct the consumer to use the standard go tooling instead of the
old, and no longer correct, package-based 'go get -u' instructions.
2021-01-22 14:39:23 -06:00
..
chainhash multi: Update README.md files for go modules. 2021-01-22 14:39:23 -06:00
doc.go chaincfg: Update doc.go. 2021-01-02 12:44:34 -06:00
generatesubsidytables.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
go.mod chaincfg: Prepare v3.0.0. 2020-09-25 13:53:10 -05:00
go.sum chaincfg: Prepare v3.0.0. 2020-09-25 13:53:10 -05:00
init_test.go multi: sprinkle on more errors.As/Is 2020-12-24 13:46:38 -06:00
init.go chaincfg: Convert global param defs to funcs. 2019-06-12 20:14:34 -05:00
mainnetparams_test.go chaincfg: Convert global param defs to funcs. 2019-06-12 20:14:34 -05:00
mainnetparams.go chaincfg: Update seed URL 2021-01-22 00:40:03 -06:00
params.go multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
README.md multi: Update README.md files for go modules. 2021-01-22 14:39:23 -06:00
regnetparams_test.go chaincfg: Convert global param defs to funcs. 2019-06-12 20:14:34 -05:00
regnetparams.go multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
simnetparams_test.go chaincfg: Convert global param defs to funcs. 2019-06-12 20:14:34 -05:00
simnetparams.go multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
subsidy.go chaincfg: Avoid block 1 subsidy codegen explosion. 2019-07-28 14:19:13 -05:00
subsidydefinitions.go chaincfg: Gate mustPayout with subsidy generation. 2019-10-30 20:28:31 -05:00
subsidytables.go chaincfg: Avoid block 1 subsidy codegen explosion. 2019-07-28 14:19:13 -05:00
testnetparams_test.go chaincfg: Convert global param defs to funcs. 2019-06-12 20:14:34 -05:00
testnetparams.go chaincfg: Update seed URL 2021-01-22 00:40:03 -06:00

chaincfg

Build Status ISC License Doc

Package chaincfg defines chain configuration parameters for the four standard Decred networks.

Although this package was primarily written for dcrd, it has intentionally been designed so it can be used as a standalone package for any projects needing to use parameters for the standard Decred networks or for projects needing to define their own network.

Sample Use

package main

import (
	"flag"
	"fmt"
	"log"

	"github.com/decred/dcrd/dcrutil/v2"
	"github.com/decred/dcrd/chaincfg/v2"
)

var testnet = flag.Bool("testnet", false, "operate on the testnet Decred 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

This package is part of the github.com/decred/dcrd/chaincfg/v3 module. Use the standard go tooling for working with modules to incorporate it.

License

Package chaincfg is licensed under the copyfree ISC License.