tx_job.go

// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.

package bootstrap

import (
	"context"
	"errors"
	"fmt"

	"github.com/prometheus/client_golang/prometheus"
	"go.uber.org/zap"

	"github.com/MetalBlockchain/metalgo/ids"
	"github.com/MetalBlockchain/metalgo/snow/choices"
	"github.com/MetalBlockchain/metalgo/snow/consensus/snowstorm"
	"github.com/MetalBlockchain/metalgo/snow/engine/avalanche/vertex"
	"github.com/MetalBlockchain/metalgo/snow/engine/common/queue"
	"github.com/MetalBlockchain/metalgo/utils/logging"
	"github.com/MetalBlockchain/metalgo/utils/set"
)

var errMissingTxDependenciesOnAccept = errors.New("attempting to accept a transaction with missing dependencies")

type txParser struct {
	log         logging.Logger
	numAccepted prometheus.Counter
	vm          vertex.LinearizableVM
}

func (p *txParser) Parse(ctx context.Context, txBytes []byte) (queue.Job, error) {
	tx, err := p.vm.ParseTx(ctx, txBytes)
	if err != nil {
		return nil, err
	}
	return &txJob{
		log:         p.log,
		numAccepted: p.numAccepted,
		tx:          tx,
	}, nil
}

type txJob struct {
	log         logging.Logger
	numAccepted prometheus.Counter
	tx          snowstorm.Tx
}

func (t *txJob) ID() ids.ID {
	return t.tx.ID()
}

func (t *txJob) MissingDependencies(context.Context) (set.Set[ids.ID], error) {
	return t.tx.MissingDependencies()
}

// Returns true if this tx job has at least 1 missing dependency
func (t *txJob) HasMissingDependencies(context.Context) (bool, error) {
	deps, err := t.tx.MissingDependencies()
	return deps.Len() > 0, err
}

func (t *txJob) Execute(ctx context.Context) error {
	hasMissingDeps, err := t.HasMissingDependencies(ctx)
	if err != nil {
		return err
	}
	if hasMissingDeps {
		return errMissingTxDependenciesOnAccept
	}

	status := t.tx.Status()
	switch status {
	case choices.Unknown, choices.Rejected:
		return fmt.Errorf("attempting to execute transaction with status %s", status)
	case choices.Processing:
		txID := t.tx.ID()
		if err := t.tx.Verify(ctx); err != nil {
			t.log.Error("transaction failed verification during bootstrapping",
				zap.Stringer("txID", txID),
				zap.Error(err),
			)
			return fmt.Errorf("failed to verify transaction in bootstrapping: %w", err)
		}

		t.numAccepted.Inc()
		t.log.Trace("accepting transaction in bootstrapping",
			zap.Stringer("txID", txID),
		)
		if err := t.tx.Accept(ctx); err != nil {
			t.log.Error("transaction failed to accept during bootstrapping",
				zap.Stringer("txID", txID),
				zap.Error(err),
			)
			return fmt.Errorf("failed to accept transaction in bootstrapping: %w", err)
		}
	}
	return nil
}

func (t *txJob) Bytes() []byte {
	return t.tx.Bytes()
}