starkkey

Documentation

Index

• func PubKeyToStarkKey(pubkey PublicKey) []byte
• func ReportToSigData(reportCtx types.ReportContext, report types.Report) (*big.Int, error)
• func ToEncryptedJSON(key Key, password string, scryptParams utils.ScryptParams) (export []byte, err error)
• type Key
  • func FromEncryptedJSON(keyJSON []byte, password string) (Key, error)
  • func GenerateKey(material io.Reader) (k Key, err error)
  • func MustNewInsecure(reader io.Reader) Key
  • func New() (Key, error)
  • func (key Key) GoString() string
  • func (key Key) ID() string
  • func (key Key) PublicKey() PublicKey
  • func (key Key) Raw() Raw
  • func (key Key) StarkKeyStr() string
  • func (key Key) String() string
  • func (key Key) ToPrivKey() *big.Int
• type OCR2Key
  • func NewOCR2Key(material io.Reader) (*OCR2Key, error)
  • func (sk *OCR2Key) Marshal() ([]byte, error)
  • func (sk *OCR2Key) MaxSignatureLength() int
  • func (sk *OCR2Key) PublicKey() types.OnchainPublicKey
  • func (sk *OCR2Key) Sign(reportCtx types.ReportContext, report types.Report) ([]byte, error)
  • func (sk *OCR2Key) Unmarshal(in []byte) error
  • func (sk *OCR2Key) Verify(publicKey types.OnchainPublicKey, reportCtx types.ReportContext, ...) bool
• type PublicKey
• type Raw
  • func (raw Raw) GoString() string
  • func (raw Raw) Key() Key
  • func (raw Raw) String() string

Functions

func PubKeyToStarkKey

func PubKeyToStarkKey(pubkey PublicKey) []byte

PubToStarkKey implements the pubkey to starkkey functionality: https://github.com/0xs34n/starknet.js/blob/cd61356974d355aa42f07a3d63f7ccefecbd913c/src/utils/ellipticCurve.ts#L49

func ReportToSigData

func ReportToSigData(reportCtx types.ReportContext, report types.Report) (*big.Int, error)

func ToEncryptedJSON

func ToEncryptedJSON(key Key, password string, scryptParams utils.ScryptParams) (export []byte, err error)

ToEncryptedJSON returns encrypted JSON representing key

Types

type Key

type Key struct {
	// contains filtered or unexported fields
}

Key represents Starknet key

func FromEncryptedJSON

func FromEncryptedJSON(keyJSON []byte, password string) (Key, error)

FromEncryptedJSON gets key from json and password

func GenerateKey

func GenerateKey(material io.Reader) (k Key, err error)

reimplements parts of https://github.com/smartcontractkit/caigo/blob/main/utils.go#L85 generate the PK as a pseudo-random number in the interval [1, CurveOrder - 1] using io.Reader, and Key struct

func MustNewInsecure

func MustNewInsecure(reader io.Reader) Key

MustNewInsecure return Key if no error

func New

func New() (Key, error)

New creates new Key

func (Key) GoString

func (key Key) GoString() string

GoString wraps String()

func (Key) ID

func (key Key) ID() string

ID gets Key ID

func (Key) PublicKey

func (key Key) PublicKey() PublicKey

PublicKey copies public key object

func (Key) Raw

func (key Key) Raw() Raw

Raw from private key

func (Key) StarkKeyStr

func (key Key) StarkKeyStr() string

StarkKeyStr is the starknet public key associated to the private key it is the X component of the ECDSA pubkey and used in the deployment of the account contract this func is used in exporting it via CLI and API

func (Key) String

func (key Key) String() string

String is the print-friendly format of the Key

func (Key) ToPrivKey

func (key Key) ToPrivKey() *big.Int

ToPrivKey returns the key usable for signing.

type OCR2Key

type OCR2Key struct {
	Key
}

func NewOCR2Key

func NewOCR2Key(material io.Reader) (*OCR2Key, error)

func (*OCR2Key) Marshal

func (sk *OCR2Key) Marshal() ([]byte, error)

func (*OCR2Key) MaxSignatureLength

func (sk *OCR2Key) MaxSignatureLength() int

func (*OCR2Key) PublicKey

func (sk *OCR2Key) PublicKey() types.OnchainPublicKey

func (*OCR2Key) Sign

func (sk *OCR2Key) Sign(reportCtx types.ReportContext, report types.Report) ([]byte, error)

func (*OCR2Key) Unmarshal

func (sk *OCR2Key) Unmarshal(in []byte) error

func (*OCR2Key) Verify

func (sk *OCR2Key) Verify(publicKey types.OnchainPublicKey, reportCtx types.ReportContext, report types.Report, signature []byte) bool

type PublicKey

type PublicKey struct {
	X, Y *big.Int
}

type Raw

type Raw []byte

Raw represents the Stark private key

func (Raw) GoString

func (raw Raw) GoString() string

GoString wraps String()

func (Raw) Key

func (raw Raw) Key() Key

Key gets the Key

func (Raw) String

func (raw Raw) String() string

String returns description