builder

Documentation

Overview

Package builder implements a module for bundlers to act as MEV searchers and send batches to the AiMiddleware via a Block Builder API that supports eth_sendBundle.

Index

• Variables
• type BuilderClient
  • func New(eoa *signer.EOA, eth *ethclient.Client, fb *flashbotsrpc.BuilderBroadcastRPC, ...) *BuilderClient
  • func (b *BuilderClient) SendAiOperation() modules.BatchHandlerFunc
  • func (b *BuilderClient) SetWaitTimeout(timeout time.Duration)

Variables

var (
	// CompatibleChainIDs is a set of chainIDs that support the Block Builder API.
	CompatibleChainIDs = mapset.NewSet(
		config.EthereumChainID.Uint64(),
		config.GoerliChainID.Uint64(),
		config.SepoliaChainID.Uint64(),
	)

	DefaultWaitTimeout = 72 * time.Second

	ErrFlashbotsBroadcastBundle = errors.New("flashbots broadcast bundle error")
)

Types

type BuilderClient

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

BuilderClient provides a connection to a block builder API to enable AiOperations to be sent through the mev-boost process.

func New

func New(
	eoa *signer.EOA,
	eth *ethclient.Client,
	fb *flashbotsrpc.BuilderBroadcastRPC,
	beneficiary common.Address,
	blocksInTheFuture int,
) *BuilderClient

New returns an instance of a BuilderClient with modules to send AiOperation bundles via the mev-boost process.

func (*BuilderClient) SendAiOperation

func (b *BuilderClient) SendAiOperation() modules.BatchHandlerFunc

SendAiOperation returns a BatchHandler that is used by the Bundler to send batches to a block builder that supports eth_sendBundle.

func (*BuilderClient) SetWaitTimeout

func (b *BuilderClient) SetWaitTimeout(timeout time.Duration)

SetWaitTimeout sets the total time to wait for a transaction to be included. When a timeout is reached, the BatchHandler will throw an error if the transaction has not been included or has been included but with a failed status.

The default value is 72 seconds. Setting the value to 0 will skip waiting for a transaction to be included.