addresspath

Documentation

Index

• Variables
• func Harden[T constraints.Integer](i T) uint32
• func UnHarden[T constraints.Integer](i T) uint32
• type CoinType
• type Path
  • func FromString(str string) (Path, error)
  • func NewPath(indexes ...uint32) Path
  • func (p Path) AddressIndex() uint32
  • func (p Path) AddressType() crypto.AddressType
  • func (p Path) CoinType() CoinType
  • func (p Path) Purpose() Purpose
  • func (p Path) String() string
• type Purpose

Variables

var ErrInvalidPath = errors.New("the key path is invalid")

ErrInvalidPath describes an error in which the key path is invalid.

Functions

func Harden

func Harden[T constraints.Integer](i T) uint32

Harden hardens the integer value 'i' by adding 0x80000000 (2^31) to it. This function does not check if 'i' is already hardened.

func UnHarden

func UnHarden[T constraints.Integer](i T) uint32

UnHarden unhardens the integer value 'i' by subtracting 0x80000000 (2^31) from it. This function does not check if 'i' is already non-hardened.

Types

type CoinType

type CoinType uint32

const (
	CoinTypePactusMainnet CoinType = 21888
	CoinTypePactusTestnet CoinType = 21777
)

type Path

type Path []uint32

func FromString

func FromString(str string) (Path, error)

func NewPath

func NewPath(indexes ...uint32) Path

func (Path) AddressIndex

func (p Path) AddressIndex() uint32

func (Path) AddressType

func (p Path) AddressType() crypto.AddressType

func (Path) CoinType

func (p Path) CoinType() CoinType

func (Path) Purpose

func (p Path) Purpose() Purpose

func (Path) String

func (p Path) String() string

type Purpose

type Purpose uint32

const (
	PurposeBLS12381         Purpose = 12381
	PurposeBIP44            Purpose = 44
	PurposeImportPrivateKey Purpose = 65535
)