world_recovery.go

package cardinal

import (
	"context"

	"github.com/rotisserie/eris"
	"github.com/rs/zerolog/log"

	"pkg.world.dev/world-engine/cardinal/router/iterator"
)

// recoverFromChain will attempt to recover the state of the engine based on historical transaction data.
// The function puts the World in a recovery state, and will then query all transaction batches under the World's
// namespace. The function will continuously ask the EVM base shard for batches, and run ticks for each batch returned.
func (w *World) recoverFromChain(ctx context.Context) error {
	if w.router == nil {
		return eris.Errorf(
			"chain router is nil. " +
				"be sure to use the `WithAdapter` option when creating the world",
		)
	}

	log.Info().Msgf("Synchronizing state from base shard starting from tick %d", w.CurrentTick())

	start := w.CurrentTick()
	err := w.router.TransactionIterator().Each(func(batches []*iterator.TxBatch, tick, timestamp uint64) error {
		select {
		case <-ctx.Done():
			return eris.New("context cancelled, terminating recovery")

		default:
			log.Info().Msgf("Found transactions for tick %d", tick)

			if w.CurrentTick() != tick {
				log.Info().Msgf("Fast forwarding to tick %d from %d", tick, w.CurrentTick())
			}
			for w.CurrentTick() != tick {
				if err := w.doTick(context.Background(), timestamp); err != nil {
					return eris.Wrap(err, "failed to tick world")
				}
			}
			log.Info().Msgf("Successfully fast forwarded to tick %d", tick)

			for _, batch := range batches {
				w.AddTransaction(batch.MsgID, batch.MsgValue, batch.Tx)
			}

			log.Info().Msgf("Executing tick %d in recovery mode", tick)
			if err := w.doTick(context.Background(), timestamp); err != nil {
				return eris.Wrap(err, "failed to tick world")
			}
			return nil
		}
	}, start)
	if err != nil {
		return eris.Wrap(err, "encountered an error while recovering from chain")
	}

	log.Info().Msgf("Successfully synchronized state from base shard")
	return nil
}