feat(proposer,prover): make context.Context part of `proposer.waitT…

…illSynced` && `ProofProducer.RequestProof`'s parameters (#169)
taikoxyz · Mar 5, 2023 · 4b11e29 · 4b11e29
1 parent 1c90a3d
commit 4b11e29
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 6 deletions.
diff --git a/proposer/proposer.go b/proposer/proposer.go
@@ -146,7 +146,7 @@ func (p *Proposer) ProposeOp(ctx context.Context) error {
 	}
 
 	// Wait until L2 execution engine is synced at first.
-	if err := p.waitTillSynced(); err != nil {
+	if err := p.waitTillSynced(ctx); err != nil {
 		return fmt.Errorf("failed to wait until L2 execution engine synced: %w", err)
 	}
 
@@ -311,9 +311,12 @@ func (p *Proposer) ProposeTxList(
 }
 
 // waitTillSynced keeps waiting until the L2 execution engine is fully synced.
-func (p *Proposer) waitTillSynced() error {
+func (p *Proposer) waitTillSynced(ctx context.Context) error {
 	return backoff.Retry(
 		func() error {
+			if ctx.Err() != nil {
+				return nil
+			}
 			progress, err := p.rpc.L2ExecutionEngineSyncProgress(p.ctx)
 			if err != nil {
 				log.Error("Fetch L2 execution engine sync progress error", "error", err)

diff --git a/prover/proof_producer/dummy_producer.go b/prover/proof_producer/dummy_producer.go
@@ -1,6 +1,7 @@
 package producer
 
 import (
+	"context"
 	"math/big"
 	"math/rand"
 	"time"
@@ -18,6 +19,7 @@ type DummyProofProducer struct {
 
 // RequestProof implements the ProofProducer interface.
 func (d *DummyProofProducer) RequestProof(
+	ctx context.Context,
 	opts *ProofRequestOptions,
 	blockID *big.Int,
 	meta *bindings.TaikoDataBlockMetadata,

diff --git a/prover/proof_producer/dummy_producer_test.go b/prover/proof_producer/dummy_producer_test.go
@@ -1,6 +1,7 @@
 package producer
 
 import (
+	"context"
 	"crypto/rand"
 	"testing"
 	"time"
@@ -35,6 +36,7 @@ func TestRequestProof(t *testing.T) {
 		Nonce:       types.BlockNonce{},
 	}
 	require.Nil(t, dummyProofProducer.RequestProof(
+		context.Background(),
 		&ProofRequestOptions{},
 		blockID,
 		&bindings.TaikoDataBlockMetadata{},

diff --git a/prover/proof_producer/proof_producer.go b/prover/proof_producer/proof_producer.go
@@ -1,6 +1,7 @@
 package producer
 
 import (
+	"context"
 	"fmt"
 	"math/big"
 
@@ -34,6 +35,7 @@ type ProofWithHeader struct {
 
 type ProofProducer interface {
 	RequestProof(
+		ctx context.Context,
 		opts *ProofRequestOptions,
 		blockID *big.Int,
 		meta *bindings.TaikoDataBlockMetadata,

diff --git a/prover/proof_producer/zkevm_cmd_producer.go b/prover/proof_producer/zkevm_cmd_producer.go
@@ -2,6 +2,7 @@ package producer
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"fmt"
 	"math/big"
@@ -34,6 +35,7 @@ func NewZkevmCmdProducer(
 
 // RequestProof implements the ProofProducer interface.
 func (d *ZkevmCmdProducer) RequestProof(
+	ctx context.Context,
 	opts *ProofRequestOptions,
 	blockID *big.Int,
 	meta *bindings.TaikoDataBlockMetadata,

diff --git a/prover/proof_producer/zkevm_rpcd_producer.go b/prover/proof_producer/zkevm_rpcd_producer.go
@@ -2,6 +2,7 @@ package producer
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -98,6 +99,7 @@ func NewZkevmRpcdProducer(
 
 // RequestProof implements the ProofProducer interface.
 func (d *ZkevmRpcdProducer) RequestProof(
+	ctx context.Context,
 	opts *ProofRequestOptions,
 	blockID *big.Int,
 	meta *bindings.TaikoDataBlockMetadata,
@@ -120,7 +122,7 @@ func (d *ZkevmRpcdProducer) RequestProof(
 	if d.CustomProofHook != nil {
 		proof, degree, err = d.CustomProofHook()
 	} else {
-		proof, degree, err = d.callProverDaemon(opts)
+		proof, degree, err = d.callProverDaemon(ctx, opts)
 	}
 	if err != nil {
 		return err
@@ -138,13 +140,16 @@ func (d *ZkevmRpcdProducer) RequestProof(
 }
 
 // callProverDaemon keeps polling the proverd service to get the requested proof.
-func (d *ZkevmRpcdProducer) callProverDaemon(opts *ProofRequestOptions) ([]byte, uint64, error) {
+func (d *ZkevmRpcdProducer) callProverDaemon(ctx context.Context, opts *ProofRequestOptions) ([]byte, uint64, error) {
 	var (
 		proof  []byte
 		degree uint64
 		start  = time.Now()
 	)
 	if err := backoff.Retry(func() error {
+		if ctx.Err() != nil {
+			return nil
+		}
 		output, err := d.requestProof(opts)
 		if err != nil {
 			log.Error("Failed to request proof", "height", opts.Height, "err", err, "endpoint", d.RpcdEndpoint)

diff --git a/prover/proof_producer/zkevm_rpcd_producer_test.go b/prover/proof_producer/zkevm_rpcd_producer_test.go
@@ -1,6 +1,7 @@
 package producer
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -41,6 +42,7 @@ func TestNewZkevmRpcdProducer(t *testing.T) {
 		Nonce:       types.BlockNonce{},
 	}
 	require.Nil(t, dummpyZkevmRpcdProducer.RequestProof(
+		context.Background(),
 		&ProofRequestOptions{},
 		blockID,
 		&bindings.TaikoDataBlockMetadata{},

diff --git a/prover/proof_submitter/invalid_proof_submitter.go b/prover/proof_submitter/invalid_proof_submitter.go
@@ -71,7 +71,7 @@ func (s *InvalidProofSubmitter) RequestProof(ctx context.Context, event *binding
 	}
 
 	if err := s.proofProducer.RequestProof(
-		proofOpts, event.Id, &event.Meta, throwAwayBlock.Header(), s.reusltCh,
+		ctx, proofOpts, event.Id, &event.Meta, throwAwayBlock.Header(), s.reusltCh,
 	); err != nil {
 		return err
 	}

diff --git a/prover/proof_submitter/valid_proof_submitter.go b/prover/proof_submitter/valid_proof_submitter.go
@@ -79,7 +79,7 @@ func (s *ValidProofSubmitter) RequestProof(ctx context.Context, event *bindings.
 		ProposeBlockTxHash: event.Raw.TxHash,
 	}
 
-	if err := s.proofProducer.RequestProof(opts, event.Id, &event.Meta, header, s.reusltCh); err != nil {
+	if err := s.proofProducer.RequestProof(ctx, opts, event.Id, &event.Meta, header, s.reusltCh); err != nil {
 		return err
 	}