hdaddy

README

hdaddy

Derive Decred addresses from extended keys using dcrutil/hdkeychain

hdaddy is a golang package with functions for deriving Decred P2PKH addresses from extended keys. A command line utility is in the cmd/keyaddresses folder. To build the keyaddresses app:

1. Clone the repository
2. Open a command prompt in the cmd/keyaddresses subdirectory.
3. go build
4. Run ./keyaddresses -h and read the help.

Documentation

Index

• Constants
• func AddressAtBranchAndIndex(xkey *hdkeychain.ExtendedKey, index uint32, branch uint32, ...) (dcrutil.Address, error)
• func AddressRangeExtendedKey(xkey *hdkeychain.ExtendedKey, start, count uint32, params *chaincfg.Params) ([]dcrutil.Address, uint32, error)
• func AddressRangeExtendedKeyStr(xkey string, start, count uint32, params *chaincfg.Params) ([]dcrutil.Address, uint32, error)
• func AddressRangeFromAccountKey(xkey *hdkeychain.ExtendedKey, start, count, branch uint32, ...) ([]dcrutil.Address, uint32, error)
• func AddressRangeFromAccountKeyString(xkey string, start, count, branch uint32, params *chaincfg.Params) ([]dcrutil.Address, uint32, error)

Constants

const (
	// ExternalBranch indicates the derivation path for addresses intended for receiving payments
	ExternalBranch uint32 = udb.ExternalBranch
	// InternalBranch indicates the derivation path for change addresses
	InternalBranch uint32 = udb.InternalBranch
)

Functions

func AddressAtBranchAndIndex

func AddressAtBranchAndIndex(xkey *hdkeychain.ExtendedKey, index uint32,
	branch uint32, params *chaincfg.Params) (dcrutil.Address, error)

AddressAtBranchAndIndex computes the address derived from an extended key on given branch and index.

func AddressRangeExtendedKey

func AddressRangeExtendedKey(xkey *hdkeychain.ExtendedKey, start, count uint32,
	params *chaincfg.Params) ([]dcrutil.Address, uint32, error)

AddressRangeExtendedKey computes a range of addresses derived from an extended key according to BIP0032.

func AddressRangeExtendedKeyStr

func AddressRangeExtendedKeyStr(xkey string, start, count uint32,
	params *chaincfg.Params) ([]dcrutil.Address, uint32, error)

AddressRangeExtendedKeyStr is the same as AddressRangeExtendedKey, but accepts a string representation of the extended key.

func AddressRangeFromAccountKey

func AddressRangeFromAccountKey(xkey *hdkeychain.ExtendedKey, start, count, branch uint32,
	params *chaincfg.Params) ([]dcrutil.Address, uint32, error)

AddressRangeFromAccountKey treats the input key as the non-hardened extended key for a wallet account, deriving addresses for the specified branch (e.g. internal or external) and index range [start, start+count).

func AddressRangeFromAccountKeyString

func AddressRangeFromAccountKeyString(xkey string, start, count, branch uint32,
	params *chaincfg.Params) ([]dcrutil.Address, uint32, error)

AddressRangeFromAccountKeyString is the same as AddressRangeFromAccountKey except that the extended key is a string.