bip32

Documentation

Index

• Variables
• func GenerateSeed() ([]byte, error)
• type ExtendedKey
  • func DeserializeExtendedKey(extKeyString string) (*ExtendedKey, error)
  • func NewMaster(seed []byte, version [4]byte) (*ExtendedKey, error)
  • func NewMasterWithPath(seed []byte, version [4]byte, pathString string) (*ExtendedKey, error)
  • func NewPublicMasterWithPath(seed []byte, version [4]byte, pathString string) (*ExtendedKey, error)
  • func (extKey *ExtendedKey) Child(i uint32) (*ExtendedKey, error)
  • func (extKey *ExtendedKey) DeriveFromPath(pathString string) (*ExtendedKey, error)
  • func (extKey *ExtendedKey) IsPrivate() bool
  • func (extKey *ExtendedKey) PrivateKey() *secp256k1.ECDSAPrivateKey
  • func (extKey *ExtendedKey) Public() (*ExtendedKey, error)
  • func (extKey *ExtendedKey) PublicKey() (*secp256k1.ECDSAPublicKey, error)
  • func (extKey *ExtendedKey) String() string

Variables

var BitcoinMainnetPrivate = [4]byte{
	0x04,
	0x88,
	0xad,
	0xe4,
}

BitcoinMainnetPrivate is the version that is used for bitcoin mainnet bip32 private extended keys. Ecnodes to xprv in base58.

var BitcoinMainnetPublic = [4]byte{
	0x04,
	0x88,
	0xb2,
	0x1e,
}

BitcoinMainnetPublic is the version that is used for bitcoin mainnet bip32 public extended keys. Ecnodes to xpub in base58.

var ConsensusDevnetPrivate = [4]byte{
	0x03,
	0x8b,
	0x3d,
	0x80,
}

ConsensusDevnetPrivate is the version that is used for consensus devnet bip32 public extended keys. Ecnodes to kdrv in base58.

var ConsensusDevnetPublic = [4]byte{
	0x03,
	0x8b,
	0x41,
	0xba,
}

ConsensusDevnetPublic is the version that is used for consensus devnet bip32 public extended keys. Ecnodes to xdub in base58.

var ConsensusMainnetPrivate = [4]byte{
	0x03,
	0x8f,
	0x2e,
	0xf4,
}

ConsensusMainnetPrivate is the version that is used for consensus mainnet bip32 private extended keys. Ecnodes to xprv in base58.

var ConsensusMainnetPublic = [4]byte{
	0x03,
	0x8f,
	0x33,
	0x2e,
}

ConsensusMainnetPublic is the version that is used for consensus mainnet bip32 public extended keys. Ecnodes to kpub in base58.

var ConsensusSimnetPrivate = [4]byte{
	0x03,
	0x90,
	0x42,
	0x42,
}

ConsensusSimnetPrivate is the version that is used for consensus simnet bip32 public extended keys. Ecnodes to ksrv in base58.

var ConsensusSimnetPublic = [4]byte{
	0x03,
	0x90,
	0x46,
	0x7d,
}

ConsensusSimnetPublic is the version that is used for consensus simnet bip32 public extended keys. Ecnodes to xsub in base58.

var ConsensusTestnetPrivate = [4]byte{
	0x03,
	0x90,
	0x9e,
	0x07,
}

ConsensusTestnetPrivate is the version that is used for consensus testnet bip32 public extended keys. Ecnodes to ktrv in base58.

var ConsensusTestnetPublic = [4]byte{
	0x03,
	0x90,
	0xa2,
	0x41,
}

ConsensusTestnetPublic is the version that is used for consensus testnet bip32 public extended keys. Ecnodes to ktub in base58.

Functions

func GenerateSeed

func GenerateSeed() ([]byte, error)

GenerateSeed generates seed that can be used to initialize a master key.

Types

type ExtendedKey

type ExtendedKey struct {
	Version           [4]byte
	Depth             uint8
	ParentFingerprint [4]byte
	ChildNumber       uint32
	ChainCode         [32]byte
	// contains filtered or unexported fields
}

ExtendedKey is a bip32 extended key

func DeserializeExtendedKey

func DeserializeExtendedKey(extKeyString string) (*ExtendedKey, error)

DeserializeExtendedKey deserialized the given base58 string and returns an extended key

func NewMaster

func NewMaster(seed []byte, version [4]byte) (*ExtendedKey, error)

NewMaster returns a new extended private key based on the given seed and version

func NewMasterWithPath

func NewMasterWithPath(seed []byte, version [4]byte, pathString string) (*ExtendedKey, error)

NewMasterWithPath returns a new master key based on the given seed and version, with a derivation to the given path.

func NewPublicMasterWithPath

func NewPublicMasterWithPath(seed []byte, version [4]byte, pathString string) (*ExtendedKey, error)

NewPublicMasterWithPath returns a new public master key based on the given seed and version, with a derivation to the given path.

func (*ExtendedKey) Child

func (extKey *ExtendedKey) Child(i uint32) (*ExtendedKey, error)

Child return the i'th derived child of extKey.

func (*ExtendedKey) DeriveFromPath

func (extKey *ExtendedKey) DeriveFromPath(pathString string) (*ExtendedKey, error)

DeriveFromPath returns the extended key derived from the given path

func (*ExtendedKey) IsPrivate

func (extKey *ExtendedKey) IsPrivate() bool

IsPrivate returns whether the extended key is private

func (*ExtendedKey) PrivateKey

func (extKey *ExtendedKey) PrivateKey() *secp256k1.ECDSAPrivateKey

PrivateKey returns the ECDSA private key associated with the extended key

func (*ExtendedKey) Public

func (extKey *ExtendedKey) Public() (*ExtendedKey, error)

Public returns public version of the extended key

func (*ExtendedKey) PublicKey

func (extKey *ExtendedKey) PublicKey() (*secp256k1.ECDSAPublicKey, error)

PublicKey returns the ECDSA public key associated with the extended key

func (*ExtendedKey) String

func (extKey *ExtendedKey) String() string