bip32

Documentation

Overview

Copyright gotools (https://github.com/zerjioang/gotools) SPDX-License-Identifier: GNU GPL v3

Index

• Constants
• Variables
• func NewRandomSeed() ([]byte, error)
• type Key
  • func B58Deserialize(data string) (*Key, error)
  • func Deserialize(data []byte) (*Key, error)
  • func NewMasterKey(seed []byte, key string, h func() hash.Hash) (*Key, error)
  • func (key Key) B58Serialize() string
  • func (key Key) NewChildKey(childIdx uint32) (*Key, error)
  • func (key Key) PublicKey() *Key
  • func (key Key) Serialize() ([]byte, error)
  • func (key Key) String() string

Constants

const (
	// FirstHardenedChild is the index of the firxt "harded" child key as per the
	// bip32 spec
	FirstHardenedChild = uint32(0x80000000)

	// PublicKeyCompressedLength is the byte count of a compressed public key
	PublicKeyCompressedLength = 33
)

Variables

var (
	// PrivateWalletVersion is the version flag for serialized private keys
	PrivateWalletVersion, _ = hex.DecodeString("0488ADE4")

	// PublicWalletVersion is the version flag for serialized private keys
	PublicWalletVersion, _ = hex.DecodeString("0488B21E")

	// ErrSerializedKeyWrongSize is returned when trying to deserialize a key that
	// has an incorrect length
	ErrSerializedKeyWrongSize = errors.New("serialized keys should by exactly 82 bytes")

	// ErrHardnedChildPublicKey is returned when trying to create a harded child
	// of the public key
	ErrHardnedChildPublicKey = errors.New("can't create hardened child for public key")

	// ErrInvalidChecksum is returned when deserializing a key with an incorrect
	// checksum
	ErrInvalidChecksum = errors.New("checksum doesn't match")

	// ErrInvalidPrivateKey is returned when a derived private key is invalid
	ErrInvalidPrivateKey = errors.New("invalid private key")

	// ErrInvalidPublicKey is returned when a derived public key is invalid
	ErrInvalidPublicKey = errors.New("invalid public key")
)

Functions

func NewRandomSeed

func NewRandomSeed() ([]byte, error)

NewRandomSeed returns a cryptographically secure seed

Types

type Key

type Key struct {
	Key         []byte // 33 bytes
	Version     []byte // 4 bytes
	ChildNumber []byte // 4 bytes
	FingerPrint []byte // 4 bytes
	ChainCode   []byte // 32 bytes
	Depth       byte   // 1 bytes
	IsPrivate   bool   // unserialized
}

Key represents a bip32 extended key

func B58Deserialize

func B58Deserialize(data string) (*Key, error)

B58Deserialize deserializes a Key encoded in base58 encoding

func Deserialize

func Deserialize(data []byte) (*Key, error)

Deserialize a byte slice into a Key

func NewMasterKey

func NewMasterKey(seed []byte, key string, h func() hash.Hash) (*Key, error)

NewMasterKey creates a new master extended key from a seed

func (Key) B58Serialize

func (key Key) B58Serialize() string

B58Serialize encodes the Key in the standard Bitcoin base58 encoding

func (Key) NewChildKey

func (key Key) NewChildKey(childIdx uint32) (*Key, error)

NewChildKey derives a child key from a given parent as outlined by bip32

func (Key) PublicKey

func (key Key) PublicKey() *Key

PublicKey returns the public version of key or return a copy The 'Neuter' function from the bip32 spec

func (Key) Serialize

func (key Key) Serialize() ([]byte, error)

Serialize a Key to a 78 byte byte slice

func (Key) String

func (key Key) String() string

String encodes the Key in the standard Bitcoin base58 encoding