signers

Documentation

Overview

Package signers associates signers and their corresponding keys.

Index

• Constants
• Variables
• func GetBip0032Path(s *Signer, ks keySpace, itemIndexes ...uint64) [][]byte
• func IDGenerate() string
• func Path(s *Signer, ks keySpace, change bool, addrIndex uint64) ([][]byte, error)
• type Signer
  • func Create(signerType string, xpubs []chainkd.XPub, quorum int, keyIndex uint64, ...) (*Signer, error)
• type SortKeys
  • func (s SortKeys) Len() int
  • func (s SortKeys) Less(i, j int) bool
  • func (s SortKeys) Swap(i, j int)

Constants

const (
	AssetKeySpace   keySpace = 0
	AccountKeySpace keySpace = 1
)

const (
	//BIP0032 compatible previous derivation rule m/account/address_index
	BIP0032 uint8 = iota
	//BIP0032 path derivation rule m/purpose'/coin_type'/account'/change/address_index
	BIP0044
)

Variables

var (
	// ErrBadQuorum is returned by Create when the quorum
	// provided is less than 1 or greater than the number
	// of xpubs provided.
	ErrBadQuorum = errors.New("quorum must be greater than or equal to 1, and must be less than or equal to the length of xpubs")

	// ErrBadXPub is returned by Create when the xpub
	// provided isn't valid.
	ErrBadXPub = errors.New("invalid xpub format")

	// ErrNoXPubs is returned by create when the xpubs
	// slice provided is empty.
	ErrNoXPubs = errors.New("at least one xpub is required")

	// ErrDupeXPub is returned by create when the same xpub
	// appears twice in a single call.
	ErrDupeXPub   = errors.New("xpubs cannot contain the same key more than once")
	ErrDeriveRule = errors.New("invalid key derive rule")
)

var (
	// BIP44Purpose purpose field 0x0000002c little-endian mode.
	BIP44Purpose = []byte{0x2C, 0x00, 0x00, 0x00}
	// BTMCoinType coin type field 0x00000099 little-endian mode.
	BTMCoinType = []byte{0x99, 0x00, 0x00, 0x00}
)

Functions

func GetBip0032Path

func GetBip0032Path(s *Signer, ks keySpace, itemIndexes ...uint64) [][]byte

GetBip0032Path returns the complete path for bip0032 derived keys

func IDGenerate

func IDGenerate() string

IDGenerate generate signer unique id

func Path

func Path(s *Signer, ks keySpace, change bool, addrIndex uint64) ([][]byte, error)

Path returns the complete path for derived keys

Types

type Signer

type Signer struct {
	Type       string         `json:"type"`
	XPubs      []chainkd.XPub `json:"xpubs"`
	Quorum     int            `json:"quorum"`
	KeyIndex   uint64         `json:"key_index"`
	DeriveRule uint8          `json:"derive_rule"`
}

Signer is the abstract concept of a signer, which is composed of a set of keys as well as the amount of signatures needed for quorum.

func Create

func Create(signerType string, xpubs []chainkd.XPub, quorum int, keyIndex uint64, deriveRule uint8) (*Signer, error)

Create creates and stores a Signer in the database

type SortKeys

type SortKeys []chainkd.XPub

func (SortKeys) Len

func (s SortKeys) Len() int

func (SortKeys) Less

func (s SortKeys) Less(i, j int) bool

func (SortKeys) Swap

func (s SortKeys) Swap(i, j int)