refactor(API): refactor SubmitProof (scroll-tech#318)

Co-authored-by: colin <[email protected]>
Co-authored-by: Lawliet-Chan <[email protected]>
Co-authored-by: HAOYUatHZ <[email protected]>
Co-authored-by: Péter Garamvölgyi <[email protected]>
Co-authored-by: HAOYUatHZ <[email protected]>
Co-authored-by: Haichen Shen <[email protected]>

Jenkinsfile

@@ -96,4 +96,4 @@ pipeline {
             slackSend(message: "${JOB_BASE_NAME} ${GIT_COMMIT} #${BUILD_NUMBER} deploy ${currentBuild.result}")
         }
     }
-}
+}

common/version/version.go

@@ -5,7 +5,7 @@ import (
 	"runtime/debug"
 )
 
-var tag = "v3.0.17"
+var tag = "v3.0.18"
 
 var commit = func() string {
 	if info, ok := debug.ReadBuildInfo(); ok {

coordinator/api.go

@@ -22,7 +22,7 @@ var (
 type RollerAPI interface {
 	RequestToken(authMsg *message.AuthMsg) (string, error)
 	Register(ctx context.Context, authMsg *message.AuthMsg) (*rpc.Subscription, error)
-	SubmitProof(proof *message.ProofMsg) (bool, error)
+	SubmitProof(proof *message.ProofMsg) error
 }
 
 // RequestToken generates and sends back register token for roller
@@ -102,28 +102,28 @@ func (m *Manager) Register(ctx context.Context, authMsg *message.AuthMsg) (*rpc.
 }
 
 // SubmitProof roller pull proof
-func (m *Manager) SubmitProof(proof *message.ProofMsg) (bool, error) {
+func (m *Manager) SubmitProof(proof *message.ProofMsg) error {
 	// Verify the signature
 	if ok, err := proof.Verify(); !ok {
 		if err != nil {
 			log.Error("failed to verify proof message", "error", err)
 		}
-		return false, errors.New("auth signature verify fail")
+		return errors.New("auth signature verify fail")
 	}
 
 	pubkey, _ := proof.PublicKey()
 	// Only allow registered pub-key.
 	if !m.existTaskIDForRoller(pubkey, proof.ID) {
-		return false, fmt.Errorf("the roller or session id doesn't exist, pubkey: %s, ID: %s", pubkey, proof.ID)
+		return fmt.Errorf("the roller or session id doesn't exist, pubkey: %s, ID: %s", pubkey, proof.ID)
 	}
 
 	m.updateMetricRollerProofsLastFinishedTimestampGauge(pubkey)
 
 	err := m.handleZkProof(pubkey, proof.ProofDetail)
 	if err != nil {
-		return false, err
+		return err
 	}
 	defer m.freeTaskIDForRoller(pubkey, proof.ID)
 
-	return true, nil
+	return nil
 }

coordinator/api_test.go

@@ -160,8 +160,7 @@ func TestManager_SubmitProof(t *testing.T) {
 			return false, errors.New("proof verify error")
 		})
 		defer patchGuard.Reset()
-		isSuccess, err := rollerManager.SubmitProof(proof)
-		assert.False(t, isSuccess)
+		err := rollerManager.SubmitProof(proof)
 		assert.Error(t, err)
 	})
 
@@ -176,8 +175,7 @@ func TestManager_SubmitProof(t *testing.T) {
 		patchGuard.ApplyMethodFunc(pm, "Verify", func() (bool, error) {
 			return true, nil
 		})
-		isSuccess, err := rollerManager.SubmitProof(proof)
-		assert.False(t, isSuccess)
+		err := rollerManager.SubmitProof(proof)
 		assert.Error(t, err)
 	})
 
@@ -197,9 +195,8 @@ func TestManager_SubmitProof(t *testing.T) {
 			return errors.New("handle zk proof error")
 		})
 
-		isSuccess, err := rollerManager.SubmitProof(proof)
+		err := rollerManager.SubmitProof(proof)
 		assert.Error(t, err)
-		assert.False(t, isSuccess)
 	})
 
 	convey.Convey("SubmitProof success", t, func() {
@@ -218,8 +215,7 @@ func TestManager_SubmitProof(t *testing.T) {
 			return nil
 		})
 
-		isSuccess, err := rollerManager.SubmitProof(proof)
+		err := rollerManager.SubmitProof(proof)
 		assert.NoError(t, err)
-		assert.True(t, isSuccess)
 	})
 }

coordinator/client/client.go

@@ -46,7 +46,6 @@ func (c *Client) RegisterAndSubscribe(ctx context.Context, taskCh chan *message.
 }
 
 // SubmitProof get proof from roller.
-func (c *Client) SubmitProof(ctx context.Context, proof *message.ProofMsg) (bool, error) {
-	var ok bool
-	return ok, c.client.CallContext(ctx, &ok, "roller_submitProof", proof)
+func (c *Client) SubmitProof(ctx context.Context, proof *message.ProofMsg) error {
+	return c.client.CallContext(ctx, nil, "roller_submitProof", proof)
 }

coordinator/manager_test.go

@@ -811,9 +811,7 @@ func (r *mockRoller) loop(t *testing.T, client *client2.Client, proofTime time.D
 				proof.ProofDetail.Proof.Proof = []byte(verifier.InvalidTestProof)
 			}
 			assert.NoError(t, proof.Sign(r.privKey))
-			ok, err := client.SubmitProof(context.Background(), proof)
-			assert.NoError(t, err)
-			assert.Equal(t, true, ok)
+			assert.NoError(t, client.SubmitProof(context.Background(), proof))
 		case <-stopCh:
 			return
 		}

roller/roller.go

@@ -283,11 +283,7 @@ func (r *Roller) signAndSubmitProof(msg *message.ProofDetail) {
 		for atomic.LoadInt64(&r.isDisconnected) == 1 {
 			time.Sleep(retryWait)
 		}
-		ok, serr := r.client.SubmitProof(context.Background(), authZkProof)
-		if !ok {
-			log.Error("submit proof to coordinator failed", "task ID", msg.ID)
-			return
-		}
+		serr := r.client.SubmitProof(context.Background(), authZkProof)
 		if serr == nil {
 			return
 		}