read_blocks.go

package storage

import (
	"context"
	"fmt"

	"github.com/onflow/flow-go/admin"
	"github.com/onflow/flow-go/admin/commands"
	"github.com/onflow/flow-go/model/flow"
	"github.com/onflow/flow-go/state/protocol"
	"github.com/onflow/flow-go/storage"
)

var _ commands.AdminCommand = (*ReadBlocksCommand)(nil)

type readBlocksRequest struct {
	blocksRequest    *blocksRequest
	numBlocksToQuery uint64
}

type ReadBlocksCommand struct {
	state  protocol.State
	blocks storage.Blocks
}

func (r *ReadBlocksCommand) Handler(ctx context.Context, req *admin.CommandRequest) (interface{}, error) {
	data := req.ValidatorData.(*readBlocksRequest)
	var result []*flow.Block
	var blockID flow.Identifier

	if header, err := getBlockHeader(r.state, data.blocksRequest); err != nil {
		return nil, fmt.Errorf("failed to get block header: %w", err)
	} else {
		blockID = header.ID()
	}

	for i := uint64(0); i < data.numBlocksToQuery; i++ {
		block, err := r.blocks.ByID(blockID)
		if err != nil {
			return nil, fmt.Errorf("failed to get block by ID: %w", err)
		}
		result = append(result, block)
		if block.Header.Height == 0 {
			break
		}
		blockID = block.Header.ParentID
	}

	return commands.ConvertToInterfaceList(result)
}

// Validator validates the request.
// Returns admin.InvalidAdminReqError for invalid/malformed requests.
func (r *ReadBlocksCommand) Validator(req *admin.CommandRequest) error {
	input, ok := req.Data.(map[string]interface{})
	if !ok {
		return admin.NewInvalidAdminReqFormatError("expected map[string]any")
	}

	block, ok := input["block"]
	if !ok {
		return admin.NewInvalidAdminReqErrorf("the \"block\" field is required")
	}

	data := &readBlocksRequest{}
	if blocksRequest, err := parseBlocksRequest(block); err != nil {
		return admin.NewInvalidAdminReqErrorf("invalid 'block' field: %w", err)
	} else {
		data.blocksRequest = blocksRequest
	}

	if n, ok := input["n"]; ok {
		if n, err := parseN(n); err != nil {
			return admin.NewInvalidAdminReqErrorf("invalid 'n' field: %w", err)
		} else {
			data.numBlocksToQuery = n
		}
	} else {
		data.numBlocksToQuery = 1
	}

	req.ValidatorData = data

	return nil

}

func NewReadBlocksCommand(state protocol.State, storage storage.Blocks) commands.AdminCommand {
	return &ReadBlocksCommand{
		state,
		storage,
	}
}