server

package

v0.7.4 Latest Latest Go to latest Published: Jul 14, 2022 License: MIT Imports: 23 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/flashbots/mev-boost

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ComputeDomain(domainType types.DomainType, forkVersionHex string, ...) (domain types.Domain, err error)
func SendHTTPRequest(ctx context.Context, client http.Client, method, url string, payload any, ...) (code int, err error)
type BoostService
- func NewBoostService(opts BoostServiceOpts) (*BoostService, error)
- func (m *BoostService) CheckRelays() bool
- func (m *BoostService) StartHTTPServer() error
type BoostServiceOpts
type RelayEntry
- func NewRelayEntry(relayURL string) (entry RelayEntry, err error)
- func (r *RelayEntry) GetURI(path string) string
- func (r *RelayEntry) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrMissingRelayPubkey is returned if a new RelayEntry URL has no public key
	ErrMissingRelayPubkey = fmt.Errorf("missing relay public key")
)

View Source

var Version = "dev"

Version is used to get the version of the backend. It is set by the cli

Functions ¶

func ComputeDomain ¶ added in v0.5.0

func ComputeDomain(domainType types.DomainType, forkVersionHex string, genesisValidatorsRootHex string) (domain types.Domain, err error)

ComputeDomain computes the signing domain

func SendHTTPRequest ¶ added in v0.5.0

func SendHTTPRequest(ctx context.Context, client http.Client, method, url string, payload any, dst any) (code int, err error)

SendHTTPRequest - prepare and send HTTP request, marshaling the payload if any, and decoding the response if dst is set

Types ¶

type BoostService ¶

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

BoostService TODO

func NewBoostService ¶

func NewBoostService(opts BoostServiceOpts) (*BoostService, error)

NewBoostService created a new BoostService

func (*BoostService) CheckRelays ¶ added in v0.5.0

func (m *BoostService) CheckRelays() bool

CheckRelays sends a request to each one of the relays previously registered to get their status

func (*BoostService) StartHTTPServer ¶ added in v0.4.0

func (m *BoostService) StartHTTPServer() error

StartHTTPServer starts the HTTP server for this boost service instance

type BoostServiceOpts ¶ added in v0.7.1

type BoostServiceOpts struct {
	Log                   *logrus.Entry
	ListenAddr            string
	Relays                []RelayEntry
	GenesisForkVersionHex string
	RelayRequestTimeout   time.Duration
	RelayCheck            bool
	MaxHeaderBytes        int
}

BoostServiceOpts provides all available options for use with NewBoostService

type RelayEntry ¶ added in v0.4.2

type RelayEntry struct {
	PublicKey types.PublicKey
	URL       *url.URL
}

RelayEntry represents a relay that mev-boost connects to.

func NewRelayEntry ¶ added in v0.4.5

func NewRelayEntry(relayURL string) (entry RelayEntry, err error)

NewRelayEntry creates a new instance based on an input string relayURL can be IP@PORT, PUBKEY@IP:PORT, https://IP, etc.

func (*RelayEntry) GetURI ¶ added in v0.7.4

func (r *RelayEntry) GetURI(path string) string

GetURI returns the full request URI with scheme, host, path and args.

func (*RelayEntry) String ¶ added in v0.4.5

func (r *RelayEntry) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL