stark

Documentation

Overview

Package stark implements utilities for generating imx.L2Signer

Index

• Constants
• func GenerateKey() (string, error)
• func GenerateLegacyKey(signer imx.L1Signer) (string, error)
• type Signer
  • func NewSigner(privateKeyInHex string) (*Signer, error)
  • func (base *Signer) GetPublicKey() string
  • func (base *Signer) PublicKey() *big.Int
  • func (base *Signer) SignMessage(message string) (string, error)
  • func (base *Signer) VerifySignature(hash *big.Int, signature, signersPublicKey string) error

Constants

const (
	DefaultSeedMessage = "Only sign this request if you’ve initiated an action with Immutable X."
	ApplicationName    = "immutablex"
	LayerName          = "starkex"
	Index              = "1"
)

Functions

func GenerateKey

func GenerateKey() (string, error)

GenerateKey generates a random key that can be used to create StarkSigner. On creation save this key for future usage as this key will be required to reuse your stark signer. @return Randomly generated private key.

func GenerateLegacyKey

func GenerateLegacyKey(signer imx.L1Signer) (string, error)

GenerateLegacyKey Generates a deterministic Stark private key from the provided signer. @return Deterministically generated private key in hex.

Types

type Signer

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

StarkSigner implements L2Signer interface.

func NewSigner

func NewSigner(privateKeyInHex string) (*Signer, error)

NewSigner created a new stark signer with the given private stark key.

func (*Signer) GetPublicKey

func (base *Signer) GetPublicKey() string

GetPublicKey returns the stark public key of the StarkSigner as a 64 digit hex string prefixed with 0x.

func (*Signer) PublicKey

func (base *Signer) PublicKey() *big.Int

PublicKey returns the stark public key of the StarkSigner as a big.Int.

func (*Signer) SignMessage

func (base *Signer) SignMessage(message string) (string, error)

func (*Signer) VerifySignature

func (base *Signer) VerifySignature(hash *big.Int, signature, signersPublicKey string) error

VerifySignature validates the given signature is signed by the requiredSigner or not.