feat(prover): update server APIs (#618)

Author: davidtaikocha

internal/testutils/helper.go

@@ -171,17 +171,16 @@ func (s *ClientTestSuite) NewTestProverServer(
 	s.Nil(err)
 
 	srv, err := server.New(&server.NewProverServerOpts{
-		ProverPrivateKey:        proverPrivKey,
-		MinOptimisticTierFee:    common.Big1,
-		MinSgxTierFee:           common.Big1,
-		MinSgxAndZkVMTierFee:    common.Big1,
-		MaxExpiry:               24 * time.Hour,
-		TaikoL1Address:          common.HexToAddress(os.Getenv("TAIKO_L1_ADDRESS")),
-		AssignmentHookAddress:   common.HexToAddress(os.Getenv("ASSIGNMENT_HOOK_ADDRESS")),
-		ProposeConcurrencyGuard: make(chan struct{}, 1024),
-		RPC:                     s.RPCClient,
-		ProtocolConfigs:         &protocolConfig,
-		LivenessBond:            protocolConfig.LivenessBond,
+		ProverPrivateKey:      proverPrivKey,
+		MinOptimisticTierFee:  common.Big1,
+		MinSgxTierFee:         common.Big1,
+		MinSgxAndZkVMTierFee:  common.Big1,
+		MaxExpiry:             24 * time.Hour,
+		TaikoL1Address:        common.HexToAddress(os.Getenv("TAIKO_L1_ADDRESS")),
+		AssignmentHookAddress: common.HexToAddress(os.Getenv("ASSIGNMENT_HOOK_ADDRESS")),
+		RPC:                   s.RPCClient,
+		ProtocolConfigs:       &protocolConfig,
+		LivenessBond:          protocolConfig.LivenessBond,
 	})
 	s.Nil(err)
 

prover/event_handler/assignment_expired.go

@@ -8,24 +8,24 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
-	proofSubmitter "github.com/taikoxyz/taiko-client/prover/proof_submitter"
+	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
 )
 
 // AssignmentExpiredEventHandler is responsible for handling the expiration of proof assignments.
 type AssignmentExpiredEventHandler struct {
 	rpc               *rpc.Client
 	proverAddress     common.Address
-	proofSubmissionCh chan<- *proofSubmitter.ProofRequestBody
-	proofContestCh    chan<- *proofSubmitter.ContestRequestBody
+	proofSubmissionCh chan<- *proofProducer.ProofRequestBody
+	proofContestCh    chan<- *proofProducer.ContestRequestBody
 	contesterMode     bool
 }
 
 // NewAssignmentExpiredEventHandler creates a new AssignmentExpiredEventHandler instance.
 func NewAssignmentExpiredEventHandler(
 	rpc *rpc.Client,
 	proverAddress common.Address,
-	proofSubmissionCh chan *proofSubmitter.ProofRequestBody,
-	proofContestCh chan *proofSubmitter.ContestRequestBody,
+	proofSubmissionCh chan *proofProducer.ProofRequestBody,
+	proofContestCh chan *proofProducer.ContestRequestBody,
 	contesterMode bool,
 ) *AssignmentExpiredEventHandler {
 	return &AssignmentExpiredEventHandler{rpc, proverAddress, proofSubmissionCh, proofContestCh, contesterMode}
@@ -60,7 +60,7 @@ func (h *AssignmentExpiredEventHandler) Handle(
 
 		// If there is no contester, we submit a contest to protocol.
 		if proofStatus.CurrentTransitionState.Contester == rpc.ZeroAddress {
-			h.proofContestCh <- &proofSubmitter.ContestRequestBody{
+			h.proofContestCh <- &proofProducer.ContestRequestBody{
 				BlockID:    e.BlockId,
 				ProposedIn: new(big.Int).SetUint64(e.Raw.BlockNumber),
 				ParentHash: proofStatus.ParentHeader.Hash(),
@@ -72,7 +72,7 @@ func (h *AssignmentExpiredEventHandler) Handle(
 		}
 
 		go func() {
-			h.proofSubmissionCh <- &proofSubmitter.ProofRequestBody{
+			h.proofSubmissionCh <- &proofProducer.ProofRequestBody{
 				Tier:  proofStatus.CurrentTransitionState.Tier + 1,
 				Event: e,
 			}
@@ -82,7 +82,7 @@ func (h *AssignmentExpiredEventHandler) Handle(
 	}
 
 	go func() {
-		h.proofSubmissionCh <- &proofSubmitter.ProofRequestBody{Tier: e.Meta.MinTier, Event: e}
+		h.proofSubmissionCh <- &proofProducer.ProofRequestBody{Tier: e.Meta.MinTier, Event: e}
 	}()
 	return nil
 }

prover/event_handler/block_proposed.go

@@ -18,7 +18,6 @@ import (
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	guardianProverHeartbeater "github.com/taikoxyz/taiko-client/prover/guardian_prover_heartbeater"
 	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
-	proofSubmitter "github.com/taikoxyz/taiko-client/prover/proof_submitter"
 	state "github.com/taikoxyz/taiko-client/prover/shared_state"
 )
 
@@ -35,8 +34,8 @@ type BlockProposedEventHandler struct {
 	rpc                   *rpc.Client
 	proofGenerationCh     chan<- *proofProducer.ProofWithHeader
 	assignmentExpiredCh   chan<- *bindings.TaikoL1ClientBlockProposed
-	proofSubmissionCh     chan<- *proofSubmitter.ProofRequestBody
-	proofContestCh        chan<- *proofSubmitter.ContestRequestBody
+	proofSubmissionCh     chan<- *proofProducer.ProofRequestBody
+	proofContestCh        chan<- *proofProducer.ContestRequestBody
 	backOffRetryInterval  time.Duration
 	backOffMaxRetrys      uint64
 	contesterMode         bool
@@ -52,8 +51,8 @@ type NewBlockProposedEventHandlerOps struct {
 	RPC                   *rpc.Client
 	ProofGenerationCh     chan *proofProducer.ProofWithHeader
 	AssignmentExpiredCh   chan *bindings.TaikoL1ClientBlockProposed
-	ProofSubmissionCh     chan *proofSubmitter.ProofRequestBody
-	ProofContestCh        chan *proofSubmitter.ContestRequestBody
+	ProofSubmissionCh     chan *proofProducer.ProofRequestBody
+	ProofContestCh        chan *proofProducer.ContestRequestBody
 	BackOffRetryInterval  time.Duration
 	BackOffMaxRetrys      uint64
 	ContesterMode         bool
@@ -265,7 +264,7 @@ func (h *BlockProposedEventHandler) checkExpirationAndSubmitProof(
 		}
 
 		// The proof submitted to protocol is invalid.
-		h.proofContestCh <- &proofSubmitter.ContestRequestBody{
+		h.proofContestCh <- &proofProducer.ContestRequestBody{
 			BlockID:    e.BlockId,
 			ProposedIn: new(big.Int).SetUint64(e.Raw.BlockNumber),
 			ParentHash: proofStatus.ParentHeader.Hash(),
@@ -352,7 +351,7 @@ func (h *BlockProposedEventHandler) checkExpirationAndSubmitProof(
 
 	metrics.ProverProofsAssigned.Inc(1)
 
-	h.proofSubmissionCh <- &proofSubmitter.ProofRequestBody{Tier: tier, Event: e}
+	h.proofSubmissionCh <- &proofProducer.ProofRequestBody{Tier: tier, Event: e}
 
 	return nil
 }

prover/event_handler/transition_contested.go

@@ -9,20 +9,20 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
-	proofSubmitter "github.com/taikoxyz/taiko-client/prover/proof_submitter"
+	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
 )
 
 // TransitionContestedEventHandler is responsible for handling the TransitionContested event.
 type TransitionContestedEventHandler struct {
 	rpc               *rpc.Client
-	proofSubmissionCh chan<- *proofSubmitter.ProofRequestBody
+	proofSubmissionCh chan<- *proofProducer.ProofRequestBody
 	contesterMode     bool
 }
 
 // NewTransitionContestedEventHandler creates a new TransitionContestedEventHandler instance.
 func NewTransitionContestedEventHandler(
 	rpc *rpc.Client,
-	proofSubmissionCh chan *proofSubmitter.ProofRequestBody,
+	proofSubmissionCh chan *proofProducer.ProofRequestBody,
 	contesterMode bool,
 ) *TransitionContestedEventHandler {
 	return &TransitionContestedEventHandler{rpc, proofSubmissionCh, contesterMode}
@@ -99,7 +99,7 @@ func (h *TransitionContestedEventHandler) Handle(
 	}
 
 	go func() {
-		h.proofSubmissionCh <- &proofSubmitter.ProofRequestBody{
+		h.proofSubmissionCh <- &proofProducer.ProofRequestBody{
 			Tier:  e.Tier + 1, // We need to send a higher tier proof to resolve the current contest.
 			Event: blockProposedEvent,
 		}

prover/event_handler/transition_proved.go

@@ -10,20 +10,20 @@ import (
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/internal/metrics"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
-	proofSubmitter "github.com/taikoxyz/taiko-client/prover/proof_submitter"
+	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
 )
 
 // TransitionProvedEventHandler is responsible for handling the TransitionProved event.
 type TransitionProvedEventHandler struct {
 	rpc            *rpc.Client
-	proofContestCh chan<- *proofSubmitter.ContestRequestBody
+	proofContestCh chan<- *proofProducer.ContestRequestBody
 	contesterMode  bool
 }
 
 // NewTransitionProvedEventHandler creates a new TransitionProvedEventHandler instance.
 func NewTransitionProvedEventHandler(
 	rpc *rpc.Client,
-	proofContestCh chan *proofSubmitter.ContestRequestBody,
+	proofContestCh chan *proofProducer.ContestRequestBody,
 	contesterMode bool,
 ) *TransitionProvedEventHandler {
 	return &TransitionProvedEventHandler{rpc, proofContestCh, contesterMode}
@@ -80,7 +80,7 @@ func (h *TransitionProvedEventHandler) Handle(
 	)
 
 	go func() {
-		h.proofContestCh <- &proofSubmitter.ContestRequestBody{
+		h.proofContestCh <- &proofProducer.ContestRequestBody{
 			BlockID:    e.BlockId,
 			ProposedIn: new(big.Int).SetUint64(blockInfo.Blk.ProposedIn),
 			ParentHash: e.Tran.ParentHash,

prover/proof_producer/proof_producer.go

@@ -17,6 +17,21 @@ var (
 	errProofGenerating   = errors.New("proof is generating")
 )
 
+// ProofRequestBody represents a request body to generate a proof.
+type ProofRequestBody struct {
+	Tier  uint16
+	Event *bindings.TaikoL1ClientBlockProposed
+}
+
+// ContestRequestBody represents a request body to generate a proof for contesting.
+type ContestRequestBody struct {
+	BlockID    *big.Int
+	ProposedIn *big.Int
+	ParentHash common.Hash
+	Meta       *bindings.TaikoDataBlockMetadata
+	Tier       uint16
+}
+
 // ProofRequestOptions contains all options that need to be passed to a backend proof producer service.
 type ProofRequestOptions struct {
 	BlockID            *big.Int

prover/proof_submitter/interface.go

@@ -10,21 +10,6 @@ import (
 	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
 )
 
-// ProofRequestBody represents a request body to generate a proof.
-type ProofRequestBody struct {
-	Tier  uint16
-	Event *bindings.TaikoL1ClientBlockProposed
-}
-
-// ContestRequestBody represents a request body to generate a proof for contesting.
-type ContestRequestBody struct {
-	BlockID    *big.Int
-	ProposedIn *big.Int
-	ParentHash common.Hash
-	Meta       *bindings.TaikoDataBlockMetadata
-	Tier       uint16
-}
-
 // Submitter is the interface for submitting proofs of the L2 blocks.
 type Submitter interface {
 	RequestProof(ctx context.Context, event *bindings.TaikoL1ClientBlockProposed) error

prover/prover.go

@@ -65,8 +65,8 @@ type Prover struct {
 	proveNotify         chan struct{}
 
 	// Proof related channels
-	proofSubmissionCh chan *proofSubmitter.ProofRequestBody
-	proofContestCh    chan *proofSubmitter.ContestRequestBody
+	proofSubmissionCh chan *proofProducer.ProofRequestBody
+	proofContestCh    chan *proofProducer.ContestRequestBody
 	proofGenerationCh chan *proofProducer.ProofWithHeader
 
 	ctx context.Context
@@ -121,8 +121,8 @@ func InitFromConfig(ctx context.Context, p *Prover, cfg *Config) (err error) {
 	chBufferSize := p.protocolConfigs.BlockMaxProposals
 	p.proofGenerationCh = make(chan *proofProducer.ProofWithHeader, chBufferSize)
 	p.assignmentExpiredCh = make(chan *bindings.TaikoL1ClientBlockProposed, chBufferSize)
-	p.proofSubmissionCh = make(chan *proofSubmitter.ProofRequestBody, p.cfg.Capacity)
-	p.proofContestCh = make(chan *proofSubmitter.ContestRequestBody, p.cfg.Capacity)
+	p.proofSubmissionCh = make(chan *proofProducer.ProofRequestBody, p.cfg.Capacity)
+	p.proofContestCh = make(chan *proofProducer.ContestRequestBody, p.cfg.Capacity)
 	p.proveNotify = make(chan struct{}, 1)
 
 	if err := p.initL1Current(cfg.StartingBlockID); err != nil {
@@ -361,7 +361,7 @@ func (p *Prover) proveOp() error {
 }
 
 // contestProofOp performs a proof contest operation.
-func (p *Prover) contestProofOp(req *proofSubmitter.ContestRequestBody) error {
+func (p *Prover) contestProofOp(req *proofProducer.ContestRequestBody) error {
 	if err := p.proofContester.SubmitContest(
 		p.ctx,
 		req.BlockID,