core

Documentation

Index

• Variables
• func EntropyFromMnemonic(mnemonic string) (entropy []byte, err error)
• func NewEntropy(bits int) (entropy []byte, err error)
• func NewMnemonic(entropy []byte) (mnemonic string, err error)
• func NewSeed() (b []byte, err error)
• func NewSeedFromMnemonic(mnemonic, password string) ([]byte, error)
• func PaddedAppend(size uint, dst, src []byte) []byte
• type Coin
• type CoinInfo
• type HasParentChain
• type MetadataProvider

Variables

var (
	ErrThisFeatureIsNotSupported = errors.New("this feature is not supported by this coin")
)

var ParentChainCofnig = map[string]string{
	"OMNI": "BTC",
}

Functions

func EntropyFromMnemonic

func EntropyFromMnemonic(mnemonic string) (entropy []byte, err error)

EntropyFromMnemonic returns the input entropy used to generate the given mnemonic

func NewEntropy

func NewEntropy(bits int) (entropy []byte, err error)

NewEntropy will create random entropy bytes

func NewMnemonic

func NewMnemonic(entropy []byte) (mnemonic string, err error)

NewMnemonic returns a randomly generated BIP-39 mnemonic using 128-256 bits of entropy.

func NewSeed

func NewSeed() (b []byte, err error)

NewSeed returns a randomly generated BIP-39 seed.

func NewSeedFromMnemonic

func NewSeedFromMnemonic(mnemonic, password string) ([]byte, error)

NewSeedFromMnemonic returns a BIP-39 seed based on a BIP-39 mnemonic.

func PaddedAppend

func PaddedAppend(size uint, dst, src []byte) []byte

Types

type Coin

type Coin interface {
	// DeriveAddress derives the account address of the derivation path.
	DeriveAddress() (address string, err error)
	// DerivePublicKey derives the public key of the derivation path.
	DerivePublicKey() (publicKey string, err error)
	// DerivePrivateKey derives the private key of the derivation path.
	DerivePrivateKey() (privateKey string, err error)
	// DecodeTx decodes raw tx to human readable format
	DecodeTx(msg string) (tx string, err error)
	// Sign signs raw tx with privateKey
	Sign(msg, privateKey string) (sig string, err error)
	// VerifySignature verifies rawTx's signature is intact
	VerifySignature(pubKey, msg, signature string) error
	// RawKey return raw private key, public key
	RawKey() ([]byte, error)
}

Coin 定义了某种货币常用的可以提供的方法

type CoinInfo

type CoinInfo struct {
	Symbol         string
	DerivationPath accounts.DerivationPath
	MasterKey      *hdkeychain.ExtendedKey
	ChainCfg       *chaincfg.Params
}

type HasParentChain

type HasParentChain interface {
	// GetParentChainName get the symbol name of the parent chain
	GetParentChainName() string
}

type MetadataProvider

type MetadataProvider interface {
	GetChainID() int //获取链id
	GetPath() string //含%d的路径
	IsTestNet() bool
	GetSeed() []byte             //bip39 seed,受助记词和密码影响
	GetDerivationPath() []uint32 //推导出的bip44路径，受path, symbol影响
	HasFlag(string) bool         //是否存在flag
}

MetadataProvider we need a configuration data container per-symbol.