signature

Documentation

Overview

Package signature provides functionality for interacting with the X-Flashbots-Signature header.

Index

• Constants
• Variables
• func Verify(header string, body []byte) (common.Address, error)
• type Signer
  • func NewRandomSigner() (*Signer, error)
  • func NewSigner(privateKey *ecdsa.PrivateKey) Signer
  • func NewSignerFromHexPrivateKey(hexPrivateKey string) (*Signer, error)
  • func (s *Signer) Address() common.Address
  • func (s *Signer) Create(body []byte) (string, error)

Constants

const HTTPHeader = "X-Flashbots-Signature"

HTTPHeader is the name of the X-Flashbots-Signature header.

Variables

var (
	ErrNoSignature      = errors.New("no signature provided")
	ErrInvalidSignature = errors.New("invalid signature provided")
)

Functions

func Verify

func Verify(header string, body []byte) (common.Address, error)

Verify takes a X-Flashbots-Signature header and a body and verifies that the signature is valid for the body. It returns the signing address if the signature is valid or an error if the signature is invalid.

Types

type Signer

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

func NewRandomSigner

func NewRandomSigner() (*Signer, error)

func NewSigner

func NewSigner(privateKey *ecdsa.PrivateKey) Signer

func NewSignerFromHexPrivateKey

func NewSignerFromHexPrivateKey(hexPrivateKey string) (*Signer, error)

NewSignerFromHexPrivateKey creates new signer from 0x-prefixed hex-encoded private key

func (*Signer) Address

func (s *Signer) Address() common.Address

func (*Signer) Create

func (s *Signer) Create(body []byte) (string, error)

Create takes a body and a private key and returns a X-Flashbots-Signature header value. The header value can be included in a HTTP request to sign the body.