Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrDuplicateNet describes an error where the parameters for a Bitcoin // network could not be set due to the network already being a standard // network or previously-registered into this package. ErrDuplicateNet = errors.New("duplicate Bitcoin network") // ErrUnknownHDKeyID describes an error where the provided id which // is intended to identify the network for a hierarchical deterministic // private extended key is not registered. ErrUnknownHDKeyID = errors.New("unknown hd private extended key bytes") )
var MainNetParams = Params{ Net: wire.MainNet, DefaultPort: "8108", PowLimit: mainPowLimit, PowLimitBits: 0x1d00ffff, SubsidyHalvingInterval: 210000, ResetMinDifficulty: false, BlockV1RejectNumRequired: 950, BlockV1RejectNumToCheck: 1000, CoinbaseBlockHeightNumRequired: 750, CoinbaseBlockHeightNumToCheck: 1000, RelayNonStdTxs: false, PubKeyHashAddrID: 0x00, ScriptHashAddrID: 0x05, PrivateKeyID: 0x80, HDPrivateKeyID: [4]byte{0x04, 0x88, 0xad, 0xe4}, HDPublicKeyID: [4]byte{0x04, 0x88, 0xb2, 0x1e}, HDCoinType: 0, }
MainNetParams defines the network parameters for the main Bitcoin network.
var RegressionNetParams = Params{ Name: "devnet", Net: wire.TestNet, DefaultPort: "12204", PowLimit: regressionPowLimit, PowLimitBits: 0x207fffff, SubsidyHalvingInterval: 150, ResetMinDifficulty: true, BlockV1RejectNumRequired: 75, BlockV1RejectNumToCheck: 100, CoinbaseBlockHeightNumRequired: 51, CoinbaseBlockHeightNumToCheck: 100, RelayNonStdTxs: true, PubKeyHashAddrID: 0x6f, ScriptHashAddrID: 0xc4, PrivateKeyID: 0xef, HDPrivateKeyID: [4]byte{0x04, 0x35, 0x83, 0x94}, HDPublicKeyID: [4]byte{0x04, 0x35, 0x87, 0xcf}, HDCoinType: 1, }
RegressionNetParams defines the network parameters for the regression test Bitcoin network. Not to be confused with the test Bitcoin network (version 3), this network is sometimes simply called "testnet".
var SimNetParams = Params{ Name: "simnet", Net: wire.SimNet, DefaultPort: "18555", PowLimit: simNetPowLimit, PowLimitBits: 0x207fffff, SubsidyHalvingInterval: 210000, ResetMinDifficulty: true, BlockV1RejectNumRequired: 75, BlockV1RejectNumToCheck: 100, CoinbaseBlockHeightNumRequired: 51, CoinbaseBlockHeightNumToCheck: 100, RelayNonStdTxs: true, PubKeyHashAddrID: 0x3f, ScriptHashAddrID: 0x7b, PrivateKeyID: 0x64, HDPrivateKeyID: [4]byte{0x04, 0x20, 0xb9, 0x00}, HDPublicKeyID: [4]byte{0x04, 0x20, 0xbd, 0x3a}, HDCoinType: 115, }
SimNetParams defines the network parameters for the simulation test Bitcoin network. This network is similar to the normal test network except it is intended for private use within a group of individuals doing simulation testing. The functionality is intended to differ in that the only nodes which are specifically specified are used to create the network rather than following normal discovery rules. This is important as otherwise it would just turn into another public testnet.
var TestNet3Params = Params{ Name: "testnet3", Net: wire.TestNet3, DefaultPort: "18108", PowLimit: testNet3PowLimit, PowLimitBits: 0x1d00ffff, SubsidyHalvingInterval: 210000, ResetMinDifficulty: true, BlockV1RejectNumRequired: 75, BlockV1RejectNumToCheck: 100, CoinbaseBlockHeightNumRequired: 51, CoinbaseBlockHeightNumToCheck: 100, RelayNonStdTxs: true, PubKeyHashAddrID: 0x6f, ScriptHashAddrID: 0xc4, PrivateKeyID: 0xef, HDPrivateKeyID: [4]byte{0x04, 0x35, 0x83, 0x94}, HDPublicKeyID: [4]byte{0x04, 0x35, 0x87, 0xcf}, HDCoinType: 1, }
TestNet3Params defines the network parameters for the test Bitcoin network (version 3). Not to be confused with the regression test network, this network is sometimes simply called "testnet".
Functions ¶
func HDPrivateKeyToPublicKeyID ¶
HDPrivateKeyToPublicKeyID accepts a private hierarchical deterministic extended key id and returns the associated public key id. When the provided id is not registered, the ErrUnknownHDKeyID error will be returned.
func IsPubKeyHashAddrID ¶
IsPubKeyHashAddrID returns whether the id is an identifier known to prefix a pay-to-pubkey-hash address on any default or registered network. This is used when decoding an address string into a specific address type. It is up to the caller to check both this and IsScriptHashAddrID and decide whether an address is a pubkey hash address, script hash address, neither, or undeterminable (if both return true).
func IsScriptHashAddrID ¶
IsScriptHashAddrID returns whether the id is an identifier known to prefix a pay-to-script-hash address on any default or registered network. This is used when decoding an address string into a specific address type. It is up to the caller to check both this and IsPubKeyHashAddrID and decide whether an address is a pubkey hash address, script hash address, neither, or undeterminable (if both return true).
func Register ¶
Register registers the network parameters for a Bitcoin network. This may error with ErrDuplicateNet if the network is already registered (either due to a previous Register call, or the network being one of the default networks).
Network parameters should be registered into this package by a main package as early as possible. Then, library packages may lookup networks or network parameters based on inputs and work regardless of the network being standard or not.
Types ¶
type Checkpoint ¶
Checkpoint identifies a known good point in the block chain. Using checkpoints allows a few optimizations for old blocks during initial download and also prevents forks from old blocks.
Each checkpoint is selected based upon several factors. See the documentation for blockchain.IsCheckpointCandidate for details on the selection criteria.
type Params ¶
type Params struct {
Name string
Net wire.BitcoinNet
DefaultPort string
// Chain parameters
// GenesisBlock *wire.MsgBlock
// GenesisHash *wire.ShaHash
PowLimit *big.Int
PowLimitBits uint32
SubsidyHalvingInterval int32
ResetMinDifficulty bool
// Checkpoints ordered from oldest to newest.
Checkpoints []Checkpoint
// Reject version 1 blocks once a majority of the network has upgraded.
// This is part of BIP0034.
BlockV1RejectNumRequired uint64
BlockV1RejectNumToCheck uint64
// Ensure coinbase starts with serialized block heights for version 2
// blocks or newer once a majority of the network has upgraded.
CoinbaseBlockHeightNumRequired uint64
CoinbaseBlockHeightNumToCheck uint64
// Mempool parameters
RelayNonStdTxs bool
// Address encoding magics
PubKeyHashAddrID byte // First byte of a P2PKH address
ScriptHashAddrID byte // First byte of a P2SH address
PrivateKeyID byte // First byte of a WIF private key
// BIP32 hierarchical deterministic extended key magics
HDPrivateKeyID [4]byte
HDPublicKeyID [4]byte
// BIP44 coin type used in the hierarchical deterministic path for
// address generation.
HDCoinType uint32
}
Params defines a Bitcoin network by its parameters. These parameters may be used by Bitcoin applications to differentiate networks as well as addresses and keys for one network from those intended for use on another network.
Source Files