wormhole-explorer/fly-event-processor/processor/processor.go

package processor

import (
	"errors"
	"time"

	"github.com/wormhole-foundation/wormhole-explorer/common/client/guardian"
	"github.com/wormhole-foundation/wormhole-explorer/common/pool"
	"github.com/wormhole-foundation/wormhole-explorer/fly-event-processor/internal/metrics"
	"github.com/wormhole-foundation/wormhole-explorer/fly-event-processor/storage"
	sdk "github.com/wormhole-foundation/wormhole/sdk/vaa"
	"go.uber.org/zap"
	"golang.org/x/net/context"
)

type Processor struct {
	guardianPool *pool.Pool
	repository   *storage.Repository
	logger       *zap.Logger
	metrics      metrics.Metrics
}

func NewProcessor(
	guardianPool *pool.Pool,
	repository *storage.Repository,
	logger *zap.Logger,
	metrics metrics.Metrics,
) *Processor {
	return &Processor{
		guardianPool: guardianPool,
		repository:   repository,
		logger:       logger,
		metrics:      metrics,
	}
}

func (p *Processor) Process(ctx context.Context, params *Params) error {
	logger := p.logger.With(
		zap.String("trackId", params.TrackID),
		zap.String("vaaId", params.VaaID))

	// 1. check if the vaa stored in the VAA collections is the correct one.

	// 1.1 get vaa from Vaas collection
	vaaDoc, err := p.repository.FindVAAById(ctx, params.VaaID)
	if err != nil {
		logger.Error("error getting vaa from collection", zap.Error(err))
		return err
	}

	// 1.2 if the event time has not reached the finality time, the event fail and
	// will be reprocesed on the next retry.
	finalityTime := getFinalityTimeByChainID(params.ChainID)
	if vaaDoc.Timestamp == nil {
		logger.Error("vaa timestamp is nil")
		return errors.New("vaa timestamp is nil")
	}

	vaaTimestamp := *vaaDoc.Timestamp
	reachedFinalityTime := time.Now().After(vaaTimestamp.Add(finalityTime))
	if !reachedFinalityTime {
		logger.Debug("event time has not reached the finality time",
			zap.Time("finalityTime", vaaTimestamp.Add(finalityTime)))
		return errors.New("event time has not reached the finality time")
	}

	// 1.3 call guardian api to get signed_vaa.
	guardians := p.guardianPool.GetItems()
	var signedVaa *guardian.SignedVaa
	for _, g := range guardians {
		g.Wait(ctx)
		guardianAPIClient, err := guardian.NewGuardianAPIClient(
			guardian.DefaultTimeout,
			g.Id,
			logger)
		if err != nil {
			logger.Error("error creating guardian api client", zap.Error(err))
			continue
		}
		signedVaa, err = guardianAPIClient.GetSignedVAA(params.VaaID)
		if err != nil {
			logger.Error("error getting signed vaa from guardian api", zap.Error(err))
			continue
		}
		break
	}

	if signedVaa == nil {
		logger.Error("error getting signed vaa from guardian api")
		return errors.New("error getting signed vaa from guardian api")
	}

	// 1.4 compare digest from vaa and signedVaa
	guardianVAA, err := sdk.Unmarshal(signedVaa.VaaBytes)
	if err != nil {
		logger.Error("error unmarshalling guardian signed vaa", zap.Error(err))
		return err
	}

	vaa, err := sdk.Unmarshal(vaaDoc.Vaa)
	if err != nil {
		logger.Error("error unmarshalling vaa", zap.Error(err))
		return err
	}

	// If the guardian digest is the same that the vaa digest,
	// the stored vaa in the vaas collection is the correct one.
	if guardianVAA.HexDigest() == vaa.HexDigest() {
		logger.Debug("vaa stored in Vaas collections is the correct")
		return nil
	}

	// 2. Check for each duplicate VAAs to detect which is the correct one.

	// 2.1 This check is necessary to avoid race conditions when the vaa is processed
	if vaaDoc.TxHash == "" {
		logger.Error("vaa txHash is empty")
		return errors.New("vaa txHash is empty")
	}

	// 2.2 Get all duplicate vaas by vaaId
	duplicateVaaDocs, err := p.repository.FindDuplicateVAAs(ctx, params.VaaID)
	if err != nil {
		logger.Error("error getting duplicate vaas from collection", zap.Error(err))
		return err
	}

	// 2.3 Check each duplicate VAA to detect which is the correct one.
	for _, duplicateVaaDoc := range duplicateVaaDocs {
		duplicateVaa, err := sdk.Unmarshal(duplicateVaaDoc.Vaa)
		if err != nil {
			logger.Error("error unmarshalling vaa", zap.Error(err))
			return err
		}

		if guardianVAA.HexDigest() == duplicateVaa.HexDigest() {
			err := p.repository.FixVAA(ctx, params.VaaID, duplicateVaaDoc.ID)
			if err != nil {
				logger.Error("error fixing vaa", zap.Error(err))
				return err
			}
			logger.Debug("vaa fixed")
			return nil
		}
	}

	logger.Debug("can't fix duplicate vaa")
	p.metrics.IncDuplicatedVaaCanNotFixed(params.ChainID)
	return errors.New("can't fix duplicate vaa")
}

func getFinalityTimeByChainID(chainID sdk.ChainID) time.Duration {
	// Time to finalize for each chain.
	// ref: https://docs.wormhole.com/wormhole/reference/constants
	switch chainID {
	case sdk.ChainIDSolana:
		return 14 * time.Second
	case sdk.ChainIDEthereum:
		return 975 * time.Second
	case sdk.ChainIDTerra:
		return 6 * time.Second
	case sdk.ChainIDBSC:
		return 48 * time.Second
	case sdk.ChainIDPolygon:
		return 66 * time.Second
	case sdk.ChainIDAvalanche:
		return 2 * time.Second
	case sdk.ChainIDOasis:
		return 12 * time.Second
	case sdk.ChainIDAlgorand:
		return 4 * time.Second
	case sdk.ChainIDFantom:
		return 5 * time.Second
	case sdk.ChainIDKarura:
		return 24 * time.Second
	case sdk.ChainIDAcala:
		return 24 * time.Second
	case sdk.ChainIDKlaytn:
		return 1 * time.Second
	case sdk.ChainIDCelo:
		return 10 * time.Second
	case sdk.ChainIDNear:
		return 2 * time.Second
	case sdk.ChainIDMoonbeam:
		return 24 * time.Second
	case sdk.ChainIDTerra2:
		return 6 * time.Second
	case sdk.ChainIDInjective:
		return 3 * time.Second
	case sdk.ChainIDSui:
		return 3 * time.Second
	case sdk.ChainIDAptos:
		return 4 * time.Second
	case sdk.ChainIDArbitrum:
		return 1066 * time.Second
	case sdk.ChainIDOptimism:
		return 1026 * time.Second
	case sdk.ChainIDXpla:
		return 5 * time.Second
	case sdk.ChainIDBase:
		return 1026 * time.Second
	case sdk.ChainIDSei:
		return 1 * time.Second
	case sdk.ChainIDWormchain:
		return 5 * time.Second
	case sdk.ChainIDSepolia:
		return 975 * time.Second
	case sdk.ChainIDArbitrumSepolia:
		return 1066 * time.Second
	case sdk.ChainIDBaseSepolia:
		return 1026 * time.Second
	case sdk.ChainIDOptimismSepolia:
		return 1026 * time.Second
	case sdk.ChainIDHolesky:
		return 975 * time.Second
	default:
		// The default value is the max finality time.
		return 1066 * time.Second
	}
}