scroll/database/orm/interface.go

package orm

import (
	"context"
	"database/sql"
	"math/big"

	"github.com/islishude/bigint"
	"github.com/jmoiron/sqlx"
	"github.com/scroll-tech/go-ethereum/common"
	"github.com/scroll-tech/go-ethereum/core/types"
)

// MsgStatus represents current layer1 transaction processing status
type MsgStatus int

const (
	// MsgUndefined : undefined msg status
	MsgUndefined MsgStatus = iota

	// MsgPending represents the from_layer message status is pending
	MsgPending

	// MsgSubmitted represents the from_layer message status is submitted
	MsgSubmitted

	// MsgConfirmed represents the from_layer message status is confirmed
	MsgConfirmed
)

// L1Message is structure of stored layer1 bridge message
type L1Message struct {
	Nonce      uint64     `json:"nonce" db:"nonce"`
	Height     bigint.Int `json:"height" db:"height"`
	Sender     string     `json:"sender" db:"sender"`
	Value      string     `json:"value" db:"value"`
	Fee        string     `json:"fee" db:"fee"`
	GasLimit   uint64     `json:"gas_limit" db:"gas_limit"`
	Deadline   uint64     `json:"deadline" db:"deadline"`
	Target     string     `json:"target" db:"target"`
	Calldata   string     `json:"calldata" db:"calldata"`
	Layer1Hash string     `json:"layer1_hash" db:"layer1_hash"`
	Status     MsgStatus  `json:"status" db:"status"`
}

// L2Message is structure of stored layer2 bridge message
type L2Message struct {
	Nonce      uint64     `json:"nonce" db:"nonce"`
	Height     bigint.Int `json:"height" db:"height"`
	Sender     string     `json:"sender" db:"sender"`
	Value      string     `json:"value" db:"value"`
	Fee        string     `json:"fee" db:"fee"`
	GasLimit   uint64     `json:"gas_limit" db:"gas_limit"`
	Deadline   uint64     `json:"deadline" db:"deadline"`
	Target     string     `json:"target" db:"target"`
	Calldata   string     `json:"calldata" db:"calldata"`
	Layer2Hash string     `json:"layer2_hash" db:"layer2_hash"`
	Status     MsgStatus  `json:"status" db:"status"`
}

// BlockInfo is structure of stored `block_trace` without `trace`
type BlockInfo struct {
	Number         bigint.Int     `json:"number" db:"number"`
	Hash           string         `json:"hash" db:"hash"`
	ParentHash     string         `json:"parent_hash" db:"parent_hash"`
	BatchID        sql.NullString `json:"batch_id" db:"batch_id"`
	TxNum          uint64         `json:"tx_num" db:"tx_num"`
	GasUsed        uint64         `json:"gas_used" db:"gas_used"`
	BlockTimestamp uint64         `json:"block_timestamp" db:"block_timestamp"`
}

// BlockTraceOrm block_trace operation interface
type BlockTraceOrm interface {
	Exist(number *big.Int) (bool, error)
	GetBlockTracesLatestHeight() (*big.Int, error)
	GetBlockTraces(fields map[string]interface{}, args ...string) ([]*types.BlockTrace, error)
	GetBlockInfos(fields map[string]interface{}, args ...string) ([]*BlockInfo, error)
	// add `GetUnbatchedBlocks` because `GetBlockInfos` cannot support query "batch_id is NULL"
	GetUnbatchedBlocks(fields map[string]interface{}, args ...string) ([]*BlockInfo, error)
	GetHashByNumber(number *big.Int) (*common.Hash, error)
	DeleteTracesByBatchID(batchID string) error
	InsertBlockTraces(ctx context.Context, blockTraces []*types.BlockTrace) error
	SetBatchIDForBlocksInDBTx(dbTx *sqlx.Tx, numbers []*big.Int, batchID string) error
}

// BlockBatchOrm block_batch operation interface
type BlockBatchOrm interface {
	GetBlockBatches(fields map[string]interface{}, args ...string) ([]*BlockBatch, error)
	GetProvingStatusByID(id string) (ProvingStatus, error)
	GetVerifiedProofAndInstanceByID(id string) ([]byte, []byte, error)
	UpdateProofByID(ctx context.Context, id string, proof, instance_commitments []byte, proofTimeSec uint64) error
	UpdateProvingStatus(id string, status ProvingStatus) error
	ResetProvingStatusFor(before ProvingStatus) error
	NewBatchInDBTx(dbTx *sqlx.Tx, startBlock *BlockInfo, endBlock *BlockInfo, parentHash string, totalTxNum uint64, gasUsed uint64) (string, error)
	BatchRecordExist(id string) (bool, error)
	GetPendingBatches() ([]string, error)
	GetCommittedBatches() ([]string, error)
	GetRollupStatus(id string) (RollupStatus, error)
	GetLatestFinalizedBatch() (*BlockBatch, error)
	UpdateRollupStatus(ctx context.Context, id string, status RollupStatus) error
	UpdateCommitTxHashAndRollupStatus(ctx context.Context, id string, commit_tx_hash string, status RollupStatus) error
	UpdateFinalizeTxHashAndRollupStatus(ctx context.Context, id string, finalize_tx_hash string, status RollupStatus) error
}

// L1MessageOrm is layer1 message db interface
type L1MessageOrm interface {
	GetL1MessageByNonce(nonce uint64) (*L1Message, error)
	GetL1UnprocessedMessages() ([]*L1Message, error)
	GetL1ProcessedNonce() (int64, error)
	SaveL1Messages(ctx context.Context, messages []*L1Message) error
	UpdateLayer2Hash(ctx context.Context, layer1Hash string, layer2Hash string) error
	UpdateLayer1Status(ctx context.Context, layer1Hash string, status MsgStatus) error
	UpdateLayer1StatusAndLayer2Hash(ctx context.Context, layer1Hash, layer2Hash string, status MsgStatus) error
	GetLayer1LatestWatchedHeight() (*big.Int, error)
	GetL1MessageByLayer1Hash(layer1Hash string) (*L1Message, error)
}

// L2MessageOrm is layer2 message db interface
type L2MessageOrm interface {
	GetL2MessageByNonce(nonce uint64) (*L2Message, error)
	MessageProofExist(nonce uint64) (bool, error)
	GetMessageProofByNonce(nonce uint64) (string, error)
	GetL2UnprocessedMessages() ([]*L2Message, error)
	GetL2ProcessedNonce() (int64, error)
	SaveL2Messages(ctx context.Context, messages []*L2Message) error
	UpdateLayer1Hash(ctx context.Context, layer2Hash string, layer1Hash string) error
	UpdateLayer2Status(ctx context.Context, layer2Hash string, status MsgStatus) error
	GetL2MessageByLayer2Hash(layer2Hash string) (*L2Message, error)
	UpdateMessageProof(ctx context.Context, layer2Hash, proof string) error
	GetLayer2LatestWatchedHeight() (*big.Int, error)
	GetMessageProofByLayer2Hash(layer2Hash string) (string, error)
	MessageProofExistByLayer2Hash(layer2Hash string) (bool, error)
	UpdateLayer2StatusAndLayer1Hash(ctx context.Context, layer2Hash string, layer1Hash string, status MsgStatus) error
}