ecc

README

ROXE Elliptic Curve Cryptography Wrapper

This is a simple wrapper for btcec, that handles the specificities of the format for keys in ROXE.

It was crafted in reference to roxejs-ecc, roxejs-keygen and the C++ codebase of ROXE.IO Software.

This handles the ROXE prefix on public keys, manages the version and checksums in public and private keys.

Documentation

Index

• Constants
• Variables
• type CurveID
  • func (c CurveID) String() string
  • func (c CurveID) StringPrefix() string
• type PrivateKey
  • func NewDeterministicPrivateKey(randSource io.Reader) (*PrivateKey, error)
  • func NewPrivateKey(wif string) (*PrivateKey, error)
  • func NewPrivateKeyFromSeed(seed string) (*PrivateKey, error)
  • func NewRandomPrivateKey() (*PrivateKey, error)
  • func (p *PrivateKey) MarshalJSON() ([]byte, error)
  • func (p *PrivateKey) PublicKey() PublicKey
  • func (p *PrivateKey) Sign(hash []byte) (out Signature, err error)
  • func (p *PrivateKey) String() string
  • func (p *PrivateKey) UnmarshalJSON(v []byte) (err error)
• type PublicKey
  • func MustNewPublicKey(pubKey string) PublicKey
  • func MustNewPublicKeyFromData(data []byte) PublicKey
  • func NewPublicKey(pubKey string) (out PublicKey, err error)
  • func NewPublicKeyFromData(data []byte) (out PublicKey, err error)
  • func (p PublicKey) IsEmpty() bool
  • func (p PublicKey) Key() (*btcec.PublicKey, error)
  • func (p PublicKey) KeyMaterialSize() int
  • func (p PublicKey) MarshalJSON() ([]byte, error)
  • func (p PublicKey) String() string
  • func (p *PublicKey) UnmarshalJSON(data []byte) error
  • func (p PublicKey) Validate() error
• type Signature
  • func MustNewSignature(fromText string) Signature
  • func MustNewSignatureFromData(data []byte) Signature
  • func NewSignature(signature string) (out Signature, err error)
  • func NewSignatureFromData(data []byte) (Signature, error)
  • func (s Signature) MarshalJSON() ([]byte, error)
  • func (s Signature) PublicKey(hash []byte) (out PublicKey, err error)
  • func (s Signature) String() string
  • func (s *Signature) UnmarshalJSON(data []byte) (err error)
  • func (s Signature) Validate() error
  • func (s Signature) Verify(hash []byte, pubKey PublicKey) bool

Constants

const (
	CurveK1 = CurveID(iota)
	CurveR1
	CurveWA
)

const PrivateKeyPrefix = "PVT_"

const SignatureK1Prefix = "SIG_K1_"

const SignatureR1Prefix = "SIG_R1_"

const SignatureWAPrefix = "SIG_WA_"

Variables

var B3 = big.NewInt(3)

We use 3 a couple of times in the decompress algorithm below

var PublicKeyK1Prefix = "PUB_K1_"

var PublicKeyPrefix = "PUB_"

var PublicKeyPrefixCompat = "ROXE"

var PublicKeyR1Prefix = "PUB_R1_"

var PublicKeyWAPrefix = "PUB_WA_"

Types

type CurveID

type CurveID uint8

func (CurveID) String

func (c CurveID) String() string

func (CurveID) StringPrefix

func (c CurveID) StringPrefix() string

type PrivateKey

type PrivateKey struct {
	Curve CurveID
	// contains filtered or unexported fields
}

func NewDeterministicPrivateKey

func NewDeterministicPrivateKey(randSource io.Reader) (*PrivateKey, error)

func NewPrivateKey

func NewPrivateKey(wif string) (*PrivateKey, error)

func NewPrivateKeyFromSeed

func NewPrivateKeyFromSeed(seed string) (*PrivateKey, error)

func NewRandomPrivateKey

func NewRandomPrivateKey() (*PrivateKey, error)

func (*PrivateKey) MarshalJSON

func (p *PrivateKey) MarshalJSON() ([]byte, error)

func (*PrivateKey) PublicKey

func (p *PrivateKey) PublicKey() PublicKey

func (*PrivateKey) Sign

func (p *PrivateKey) Sign(hash []byte) (out Signature, err error)

Sign signs a 32 bytes SHA256 hash..

func (*PrivateKey) String

func (p *PrivateKey) String() string

func (*PrivateKey) UnmarshalJSON

func (p *PrivateKey) UnmarshalJSON(v []byte) (err error)

type PublicKey

type PublicKey struct {
	Curve   CurveID
	Content []byte
	// contains filtered or unexported fields
}

func MustNewPublicKey

func MustNewPublicKey(pubKey string) PublicKey

func MustNewPublicKeyFromData

func MustNewPublicKeyFromData(data []byte) PublicKey

func NewPublicKey

func NewPublicKey(pubKey string) (out PublicKey, err error)

func NewPublicKeyFromData

func NewPublicKeyFromData(data []byte) (out PublicKey, err error)

func (PublicKey) IsEmpty

func (p PublicKey) IsEmpty() bool

func (PublicKey) Key

func (p PublicKey) Key() (*btcec.PublicKey, error)

func (PublicKey) KeyMaterialSize

func (p PublicKey) KeyMaterialSize() int

func (PublicKey) MarshalJSON

func (p PublicKey) MarshalJSON() ([]byte, error)

func (PublicKey) String

func (p PublicKey) String() string

func (*PublicKey) UnmarshalJSON

func (p *PublicKey) UnmarshalJSON(data []byte) error

func (PublicKey) Validate

func (p PublicKey) Validate() error

type Signature

type Signature struct {
	Curve   CurveID
	Content []byte // the Compact signature as bytes
	// contains filtered or unexported fields
}

Signature represents a signature for some hash

func MustNewSignature

func MustNewSignature(fromText string) Signature

func MustNewSignatureFromData

func MustNewSignatureFromData(data []byte) Signature

func NewSignature

func NewSignature(signature string) (out Signature, err error)

func NewSignatureFromData

func NewSignatureFromData(data []byte) (Signature, error)

func (Signature) MarshalJSON

func (s Signature) MarshalJSON() ([]byte, error)

func (Signature) PublicKey

func (s Signature) PublicKey(hash []byte) (out PublicKey, err error)

func (Signature) String

func (s Signature) String() string

func (*Signature) UnmarshalJSON

func (s *Signature) UnmarshalJSON(data []byte) (err error)

func (Signature) Validate

func (s Signature) Validate() error

func (Signature) Verify

func (s Signature) Verify(hash []byte, pubKey PublicKey) bool