refactor(orm): change chunk_proofs_ready to chunk_proofs_status (#626)

bridge/internal/orm/batch.go

@@ -33,12 +33,12 @@ type Batch struct {
 	BatchHeader     []byte `json:"batch_header" gorm:"column:batch_header"`
 
 	// proof
-	ChunkProofsReady int16      `json:"chunk_proofs_ready" gorm:"column:chunk_proofs_ready;default:0"`
-	ProvingStatus    int16      `json:"proving_status" gorm:"column:proving_status;default:1"`
-	Proof            []byte     `json:"proof" gorm:"column:proof;default:NULL"`
-	ProverAssignedAt *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
-	ProvedAt         *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
-	ProofTimeSec     int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
+	ChunkProofsStatus int16      `json:"chunk_proofs_status" gorm:"column:chunk_proofs_status"`
+	ProvingStatus     int16      `json:"proving_status" gorm:"column:proving_status;default:1"`
+	Proof             []byte     `json:"proof" gorm:"column:proof;default:NULL"`
+	ProverAssignedAt  *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
+	ProvedAt          *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
+	ProofTimeSec      int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
 
 	// rollup
 	RollupStatus   int16      `json:"rollup_status" gorm:"column:rollup_status;default:1"`
@@ -244,18 +244,18 @@ func (o *Batch) InsertBatch(ctx context.Context, startChunkIndex, endChunkIndex
 	lastChunkBlockNum := len(chunks[numChunks-1].Blocks)
 
 	newBatch := Batch{
-		Index:            batchIndex,
-		Hash:             batchHeader.Hash().Hex(),
-		StartChunkHash:   startChunkHash,
-		StartChunkIndex:  startChunkIndex,
-		EndChunkHash:     endChunkHash,
-		EndChunkIndex:    endChunkIndex,
-		StateRoot:        chunks[numChunks-1].Blocks[lastChunkBlockNum-1].Header.Root.Hex(),
-		WithdrawRoot:     chunks[numChunks-1].Blocks[lastChunkBlockNum-1].WithdrawTrieRoot.Hex(),
-		BatchHeader:      batchHeader.Encode(),
-		ProvingStatus:    int16(types.ProvingTaskUnassigned),
-		RollupStatus:     int16(types.RollupPending),
-		ChunkProofsReady: 0,
+		Index:             batchIndex,
+		Hash:              batchHeader.Hash().Hex(),
+		StartChunkHash:    startChunkHash,
+		StartChunkIndex:   startChunkIndex,
+		EndChunkHash:      endChunkHash,
+		EndChunkIndex:     endChunkIndex,
+		StateRoot:         chunks[numChunks-1].Blocks[lastChunkBlockNum-1].Header.Root.Hex(),
+		WithdrawRoot:      chunks[numChunks-1].Blocks[lastChunkBlockNum-1].WithdrawTrieRoot.Hex(),
+		BatchHeader:       batchHeader.Encode(),
+		ChunkProofsStatus: int16(types.ChunkProofsStatusPending),
+		ProvingStatus:     int16(types.ProvingTaskUnassigned),
+		RollupStatus:      int16(types.RollupPending),
 	}
 
 	if err := db.WithContext(ctx).Create(&newBatch).Error; err != nil {

common/types/db.go

@@ -195,6 +195,20 @@ func (ps ProvingStatus) String() string {
 	}
 }
 
+// ChunkProofsStatus describes the proving status of chunks that belong to a batch.
+type ChunkProofsStatus int
+
+const (
+	// ChunkProofsStatusUndefined represents an undefined chunk proofs status
+	ChunkProofsStatusUndefined ChunkProofsStatus = iota
+
+	// ChunkProofsStatusPending means that some chunks that belong to this batch have not been proven
+	ChunkProofsStatusPending
+
+	// ChunkProofsStatusReady means that all chunks that belong to this batch have been proven
+	ChunkProofsStatusReady
+)
+
 // RollupStatus block_batch rollup_status (pending, committing, committed, commit_failed, finalizing, finalized, finalize_skipped, finalize_failed)
 type RollupStatus int
 

common/version/version.go

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

coordinator/internal/orm/batch.go

@@ -32,12 +32,12 @@ type Batch struct {
 	BatchHeader     []byte `json:"batch_header" gorm:"column:batch_header"`
 
 	// proof
-	ChunkProofsReady int16      `json:"chunk_proofs_ready" gorm:"column:chunk_proofs_ready;default:0"`
-	ProvingStatus    int16      `json:"proving_status" gorm:"column:proving_status;default:1"`
-	Proof            []byte     `json:"proof" gorm:"column:proof;default:NULL"`
-	ProverAssignedAt *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
-	ProvedAt         *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
-	ProofTimeSec     int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
+	ChunkProofsStatus int16      `json:"chunk_proofs_status" gorm:"column:chunk_proofs_status"`
+	ProvingStatus     int16      `json:"proving_status" gorm:"column:proving_status;default:1"`
+	Proof             []byte     `json:"proof" gorm:"column:proof;default:NULL"`
+	ProverAssignedAt  *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
+	ProvedAt          *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
+	ProofTimeSec      int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
 
 	// rollup
 	RollupStatus   int16      `json:"rollup_status" gorm:"column:rollup_status;default:1"`
@@ -78,7 +78,7 @@ func (o *Batch) GetUnassignedBatches(ctx context.Context, limit int) ([]*Batch,
 
 	var batches []*Batch
 	db := o.db.WithContext(ctx)
-	db = db.Where("proving_status = ? AND chunk_proofs_ready = ?", types.ProvingTaskUnassigned, 1)
+	db = db.Where("proving_status = ? AND chunk_proofs_status = ?", types.ProvingTaskUnassigned, types.ChunkProofsStatusReady)
 	db = db.Order("index ASC")
 	db = db.Limit(limit)
 
@@ -176,18 +176,18 @@ func (o *Batch) InsertBatch(ctx context.Context, startChunkIndex, endChunkIndex
 	lastChunkBlockNum := len(chunks[numChunks-1].Blocks)
 
 	newBatch := Batch{
-		Index:            batchIndex,
-		Hash:             batchHeader.Hash().Hex(),
-		StartChunkHash:   startChunkHash,
-		StartChunkIndex:  startChunkIndex,
-		EndChunkHash:     endChunkHash,
-		EndChunkIndex:    endChunkIndex,
-		StateRoot:        chunks[numChunks-1].Blocks[lastChunkBlockNum-1].Header.Root.Hex(),
-		WithdrawRoot:     chunks[numChunks-1].Blocks[lastChunkBlockNum-1].WithdrawTrieRoot.Hex(),
-		BatchHeader:      batchHeader.Encode(),
-		ProvingStatus:    int16(types.ProvingTaskUnassigned),
-		RollupStatus:     int16(types.RollupPending),
-		ChunkProofsReady: 0,
+		Index:             batchIndex,
+		Hash:              batchHeader.Hash().Hex(),
+		StartChunkHash:    startChunkHash,
+		StartChunkIndex:   startChunkIndex,
+		EndChunkHash:      endChunkHash,
+		EndChunkIndex:     endChunkIndex,
+		StateRoot:         chunks[numChunks-1].Blocks[lastChunkBlockNum-1].Header.Root.Hex(),
+		WithdrawRoot:      chunks[numChunks-1].Blocks[lastChunkBlockNum-1].WithdrawTrieRoot.Hex(),
+		BatchHeader:       batchHeader.Encode(),
+		ChunkProofsStatus: int16(types.ChunkProofsStatusPending),
+		ProvingStatus:     int16(types.ProvingTaskUnassigned),
+		RollupStatus:      int16(types.RollupPending),
 	}
 
 	if err := db.WithContext(ctx).Create(&newBatch).Error; err != nil {
@@ -198,20 +198,13 @@ func (o *Batch) InsertBatch(ctx context.Context, startChunkIndex, endChunkIndex
 	return &newBatch, nil
 }
 
-// UpdateChunkProofsStatusByBatchHash updates the status of chunk_proofs_ready field for a given batch hash.
-// The function will set the chunk_proofs_ready to the status provided.
-func (o *Chunk) UpdateChunkProofsStatusByBatchHash(ctx context.Context, batchHash string, isReady bool) error {
-	var chunkProofsStatus int16
-	if isReady {
-		chunkProofsStatus = 1
-	} else {
-		chunkProofsStatus = 0
-	}
-
+// UpdateChunkProofsStatusByBatchHash updates the status of chunk_proofs_status field for a given batch hash.
+// The function will set the chunk_proofs_status to the status provided.
+func (o *Chunk) UpdateChunkProofsStatusByBatchHash(ctx context.Context, batchHash string, status types.ChunkProofsStatus) error {
 	db := o.db.WithContext(ctx)
 	db = db.Model(&Batch{})
 	db = db.Where("hash = ?", batchHash)
-	return db.Update("chunk_proofs_ready", chunkProofsStatus).Error
+	return db.Update("chunk_proofs_status", int(status)).Error
 }
 
 // UpdateProvingStatus updates the proving status of a batch.

coordinator/manager.go

@@ -434,7 +434,7 @@ func (m *Manager) checkAreAllChunkProofsReady(chunkHash string) error {
 		return err
 	}
 	if allReady {
-		err := m.chunkOrm.UpdateChunkProofsStatusByBatchHash(m.ctx, batchHash, true)
+		err := m.chunkOrm.UpdateChunkProofsStatusByBatchHash(m.ctx, batchHash, types.ChunkProofsStatusReady)
 		if err != nil {
 			return err
 		}

coordinator/manager_test.go

@@ -358,7 +358,7 @@ func testInvalidProof(t *testing.T) {
 	assert.NoError(t, err)
 	batch, err := batchOrm.InsertBatch(context.Background(), 0, 0, dbChunk.Hash, dbChunk.Hash, []*types.Chunk{chunk})
 	assert.NoError(t, err)
-	err = chunkOrm.UpdateChunkProofsStatusByBatchHash(context.Background(), batch.Hash, true)
+	err = chunkOrm.UpdateChunkProofsStatusByBatchHash(context.Background(), batch.Hash, types.ChunkProofsStatusReady)
 	assert.NoError(t, err)
 
 	// verify proof status
@@ -419,7 +419,7 @@ func testProofGeneratedFailed(t *testing.T) {
 	assert.NoError(t, err)
 	batch, err := batchOrm.InsertBatch(context.Background(), 0, 0, dbChunk.Hash, dbChunk.Hash, []*types.Chunk{chunk})
 	assert.NoError(t, err)
-	err = chunkOrm.UpdateChunkProofsStatusByBatchHash(context.Background(), batch.Hash, true)
+	err = chunkOrm.UpdateChunkProofsStatusByBatchHash(context.Background(), batch.Hash, types.ChunkProofsStatusReady)
 	assert.NoError(t, err)
 
 	// verify proof status
@@ -470,7 +470,7 @@ func testTimedoutProof(t *testing.T) {
 	assert.NoError(t, err)
 	batch, err := batchOrm.InsertBatch(context.Background(), 0, 0, dbChunk.Hash, dbChunk.Hash, []*types.Chunk{chunk})
 	assert.NoError(t, err)
-	err = chunkOrm.UpdateChunkProofsStatusByBatchHash(context.Background(), batch.Hash, true)
+	err = chunkOrm.UpdateChunkProofsStatusByBatchHash(context.Background(), batch.Hash, types.ChunkProofsStatusReady)
 	assert.NoError(t, err)
 
 	// verify proof status, it should be assigned, because roller didn't send any proof

database/migrate/migrations/00005_batch.sql

@@ -15,7 +15,7 @@ create table batch
     batch_header            BYTEA           NOT NULL,
 
 -- proof
-    chunk_proofs_ready      SMALLINT        NOT NULL DEFAULT 0,
+    chunk_proofs_status     SMALLINT        NOT NULL,
     proving_status          SMALLINT        NOT NULL DEFAULT 1,
     proof                   BYTEA           DEFAULT NULL,
     prover_assigned_at      TIMESTAMP(0)    DEFAULT NULL,