Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

builderapi

package

Go to main page

Versions in this module

v0

v0.0.3

Aug 12, 2026

Changes in this version

type Server

+ func (s *Server) SetOnDemandBuilder(builder epbsapi.OnDemandPayloadBuilder)

+ func (s *Server) SetResultRecorder(rec SlotResultRecorder)

+ type SlotResultRecorder interface

+ RecordBlockSubmission func(slot phase0.Slot, dialect string, status string, errMsg string)

+ RecordBuilderAPIBid func(slot phase0.Slot, forkName string, signedBid any, ...)

v0.0.2

Jul 8, 2026

Changes in this version

type Server

+ func (s *Server) SetProposerPreferencesStore(store *memstore.Store[phase0.Slot, *gloasspec.SignedProposerPreferences])

+ func (s *Server) SetRevealService(rs *payload_bidder.RevealService)

v0.0.1

Jun 24, 2026

Changes in this version

+ type BidWonEntry struct

+ BlockHash string

+ NumBlobs int

+ NumTransactions int

+ Slot uint64

+ Timestamp int64

+ ValueETH string

+ ValueWei string

+ type BidsWonStore struct

+ func NewBidsWonStore(maxSize int) *BidsWonStore

+ func (s *BidsWonStore) Add(entry BidWonEntry)

+ func (s *BidsWonStore) Count() int

+ func (s *BidsWonStore) GetPage(offset, limit int) ([]BidWonEntry, int)

+ type BuilderPreferencesStore struct

+ func NewBuilderPreferencesStore() *BuilderPreferencesStore

+ func (s *BuilderPreferencesStore) Get(pubkey phase0.BLSPubKey) (phase0.Gwei, bool)

+ func (s *BuilderPreferencesStore) GetAll() map[phase0.BLSPubKey]phase0.Gwei

+ func (s *BuilderPreferencesStore) GetOrDefault(pubkey phase0.BLSPubKey) phase0.Gwei

+ func (s *BuilderPreferencesStore) Set(pubkey phase0.BLSPubKey, maxExecutionPayment phase0.Gwei)

+ type EventBroadcaster interface

+ BroadcastBidWon func(slot uint64, blockHash string, numTxs, numBlobs int, valueETH string, ...)

+ BroadcastBuilderAPIGetBidDelivered func(slot uint64, blockHash, blockValue string)

+ BroadcastBuilderAPIGetBidReceived func(slot uint64, parentHash, pubkey string)

+ BroadcastBuilderAPIGetHeaderDelivered func(slot uint64, blockHash, blockValue string)

+ BroadcastBuilderAPIGetHeaderReceived func(slot uint64, parentHash, pubkey string)

+ BroadcastBuilderAPISubmitBlindedDelivered func(slot uint64, blockHash string)

+ BroadcastBuilderAPISubmitBlindedReceived func(slot uint64, blockHash string)

+ BroadcastBuilderAPISubmitBlockDelivered func(slot uint64, blockHash string)

+ BroadcastBuilderAPISubmitBlockReceived func(slot uint64, blockHash string)

+ type FuluBlockPublisher interface

+ SubmitFuluBlock func(ctx context.Context, contents *apiv1fulu.SignedBlockContents) error

+ type GetExecutionPayloadBidResponse struct

+ Data *eth2all.SignedExecutionPayloadBid

+ Version string

+ type PayloadBySlotResponse struct

+ BlobsBundle json.RawMessage

+ BlockHash string

+ BlockValue string

+ FeeRecipient string

+ GasLimit uint64

+ ParentBlockHash string

+ ParentBlockRoot string

+ Payload json.RawMessage

+ ReadyAt time.Time

+ Slot uint64

+ Timestamp uint64

+ type PayloadCacheProvider interface

+ GetPayloadCache func() *payload_builder.PayloadCache

+ type RequestStats struct

+ BlocksPublished uint64

+ HeadersRequested uint64

+ ValidatorCount int

+ type Server struct

+ func NewServer(cfg *config.BuilderAPIConfig, log *logrus.Logger, chainSvc chain.Service, ...) *Server

+ func (s *Server) GetBidsWonStore() *BidsWonStore

+ func (s *Server) GetBuilderPreferencesStore() *BuilderPreferencesStore

+ func (s *Server) GetRequestStats() RequestStats

+ func (s *Server) Handler() http.Handler

+ func (s *Server) IsEnabled() bool

+ func (s *Server) RegisterRoutes(router *mux.Router)

+ func (s *Server) SetBuilderIndex(index uint64)

+ func (s *Server) SetCLClient(c *beacon.Client)

+ func (s *Server) SetChainService(c chain.Service)

+ func (s *Server) SetEnabled(enabled bool)

+ func (s *Server) SetEventBroadcaster(b EventBroadcaster)

+ func (s *Server) SetFuluPublisher(p FuluBlockPublisher)

+ func (s *Server) SetProposerPreferencesCache(cache *proposerpreferences.Cache)

+ func (s *Server) SetStateDB(stateDB *db.Database)