Add Tx Indexer Extension

examples/morpheusvm/controller/action_handler.go

@@ -0,0 +1,28 @@
+// Copyright (C) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package controller
+
+import (
+	"context"
+
+	"github.com/ava-labs/hypersdk/chain"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/actions"
+	"github.com/ava-labs/hypersdk/extension/indexer"
+)
+
+var _ indexer.SuccessfulTxSubscriber = (*actionHandler)(nil)
+
+type actionHandler struct {
+	c *Controller
+}
+
+func (a *actionHandler) Accepted(_ context.Context, tx *chain.Transaction, _ *chain.Result) error {
+	for _, action := range tx.Actions {
+		switch action.(type) { //nolint:gocritic
+		case *actions.Transfer:
+			a.c.metrics.transfer.Inc()
+		}
+	}
+	return nil
+}

examples/morpheusvm/controller/controller.go

@@ -15,13 +15,13 @@ import (
 	"github.com/ava-labs/hypersdk/auth"
 	"github.com/ava-labs/hypersdk/builder"
 	"github.com/ava-labs/hypersdk/chain"
-	"github.com/ava-labs/hypersdk/examples/morpheusvm/actions"
 	"github.com/ava-labs/hypersdk/examples/morpheusvm/config"
 	"github.com/ava-labs/hypersdk/examples/morpheusvm/consts"
 	"github.com/ava-labs/hypersdk/examples/morpheusvm/genesis"
 	"github.com/ava-labs/hypersdk/examples/morpheusvm/rpc"
 	"github.com/ava-labs/hypersdk/examples/morpheusvm/storage"
 	"github.com/ava-labs/hypersdk/examples/morpheusvm/version"
+	"github.com/ava-labs/hypersdk/extension/indexer"
 	"github.com/ava-labs/hypersdk/gossiper"
 	"github.com/ava-labs/hypersdk/pebble"
 	"github.com/ava-labs/hypersdk/vm"
@@ -43,7 +43,9 @@ type Controller struct {
 
 	metrics *metrics
 
-	db database.Database
+	txDB               database.Database
+	txIndexer          indexer.TxIndexer
+	acceptedSubscriber indexer.AcceptedSubscriber
 }
 
 func New() *vm.VM {
@@ -96,10 +98,20 @@ func (c *Controller) Initialize(
 	}
 	snowCtx.Log.Info("loaded genesis", zap.Any("genesis", c.genesis))
 
-	c.db, err = hstorage.New(pebble.NewDefaultConfig(), snowCtx.ChainDataDir, "db", gatherer)
+	c.txDB, err = hstorage.New(pebble.NewDefaultConfig(), snowCtx.ChainDataDir, "db", gatherer)
 	if err != nil {
 		return nil, nil, nil, nil, nil, nil, nil, err
 	}
+	acceptedSubscribers := []indexer.AcceptedSubscriber{
+		indexer.NewSuccessfulTxSubscriber(&actionHandler{c: c}),
+	}
+	if c.config.StoreTransactions {
+		c.txIndexer = indexer.NewTxDBIndexer(c.txDB)
+		acceptedSubscribers = append(acceptedSubscribers, c.txIndexer)
+	} else {
+		c.txIndexer = indexer.NewNoOpTxIndexer()
+	}
+	c.acceptedSubscriber = indexer.NewAcceptedSubscribers(acceptedSubscribers...)
 
 	// Create handlers
 	//
@@ -145,40 +157,10 @@ func (c *Controller) StateManager() chain.StateManager {
 }
 
 func (c *Controller) Accepted(ctx context.Context, blk *chain.StatelessBlock) error {
-	batch := c.db.NewBatch()
-	defer batch.Reset()
-
-	results := blk.Results()
-	for i, tx := range blk.Txs {
-		result := results[i]
-		if c.config.StoreTransactions {
-			err := storage.StoreTransaction(
-				ctx,
-				batch,
-				tx.ID(),
-				blk.GetTimestamp(),
-				result.Success,
-				result.Units,
-				result.Fee,
-			)
-			if err != nil {
-				return err
-			}
-		}
-		if result.Success {
-			for _, action := range tx.Actions {
-				switch action.(type) { //nolint:gocritic
-				case *actions.Transfer:
-					c.metrics.transfer.Inc()
-				}
-			}
-		}
-	}
-	return batch.Write()
+	return c.acceptedSubscriber.Accepted(ctx, blk)
 }
 
-func (*Controller) Shutdown(context.Context) error {
-	// Do not close any databases provided during initialization. The VM will
-	// close any databases your provided.
-	return nil
+func (c *Controller) Shutdown(context.Context) error {
+	// Close any databases created during initialization
+	return c.txDB.Close()
 }

examples/morpheusvm/controller/resolutions.go

@@ -28,11 +28,8 @@ func (c *Controller) Tracer() trace.Tracer {
 	return c.inner.Tracer()
 }
 
-func (c *Controller) GetTransaction(
-	ctx context.Context,
-	txID ids.ID,
-) (bool, int64, bool, fees.Dimensions, uint64, error) {
-	return storage.GetTransaction(ctx, c.db, txID)
+func (c *Controller) GetTransaction(txID ids.ID) (bool, int64, bool, fees.Dimensions, uint64, error) {
+	return c.txIndexer.GetTransaction(txID)
 }
 
 func (c *Controller) GetBalanceFromState(

examples/morpheusvm/rpc/dependencies.go

@@ -17,6 +17,6 @@ import (
 type Controller interface {
 	Genesis() *genesis.Genesis
 	Tracer() trace.Tracer
-	GetTransaction(context.Context, ids.ID) (bool, int64, bool, fees.Dimensions, uint64, error)
+	GetTransaction(ids.ID) (bool, int64, bool, fees.Dimensions, uint64, error)
 	GetBalanceFromState(context.Context, codec.Address) (uint64, error)
 }

examples/morpheusvm/rpc/jsonrpc_server.go

@@ -43,10 +43,10 @@ type TxReply struct {
 }
 
 func (j *JSONRPCServer) Tx(req *http.Request, args *TxArgs, reply *TxReply) error {
-	ctx, span := j.c.Tracer().Start(req.Context(), "Server.Tx")
+	_, span := j.c.Tracer().Start(req.Context(), "Server.Tx")
 	defer span.End()
 
-	found, t, success, units, fee, err := j.c.GetTransaction(ctx, args.TxID)
+	found, t, success, units, fee, err := j.c.GetTransaction(args.TxID)
 	if err != nil {
 		return err
 	}

examples/morpheusvm/storage/storage.go

@@ -10,11 +10,9 @@ import (
 	"fmt"
 
 	"github.com/ava-labs/avalanchego/database"
-	"github.com/ava-labs/avalanchego/ids"
 
 	"github.com/ava-labs/hypersdk/codec"
 	"github.com/ava-labs/hypersdk/consts"
-	"github.com/ava-labs/hypersdk/fees"
 	"github.com/ava-labs/hypersdk/state"
 
 	smath "github.com/ava-labs/avalanchego/utils/math"
@@ -23,10 +21,6 @@ import (
 
 type ReadState func(context.Context, [][]byte) ([][]byte, []error)
 
-// Metadata
-// 0x0/ (tx)
-//   -> [txID] => timestamp
-//
 // State
 // / (height) => store in root
 //   -> [heightPrefix] => height
@@ -37,9 +31,6 @@ type ReadState func(context.Context, [][]byte) ([][]byte, []error)
 // 0x3/ (hypersdk-fee)
 
 const (
-	// Indexes
-	txPrefix = 0x0
-
 	// Active state
 	balancePrefix   = 0x0
 	heightPrefix    = 0x1
@@ -50,69 +41,11 @@ const (
 const BalanceChunks uint16 = 1
 
 var (
-	failureByte  = byte(0x0)
-	successByte  = byte(0x1)
 	heightKey    = []byte{heightPrefix}
 	timestampKey = []byte{timestampPrefix}
 	feeKey       = []byte{feePrefix}
 )
 
-// [txPrefix] + [txID]
-func TxKey(id ids.ID) (k []byte) {
-	k = make([]byte, 1+ids.IDLen)
-	k[0] = txPrefix
-	copy(k[1:], id[:])
-	return
-}
-
-func StoreTransaction(
-	_ context.Context,
-	db database.KeyValueWriter,
-	id ids.ID,
-	t int64,
-	success bool,
-	units fees.Dimensions,
-	fee uint64,
-) error {
-	k := TxKey(id)
-	v := make([]byte, consts.Uint64Len+1+fees.DimensionsLen+consts.Uint64Len)
-	binary.BigEndian.PutUint64(v, uint64(t))
-	if success {
-		v[consts.Uint64Len] = successByte
-	} else {
-		v[consts.Uint64Len] = failureByte
-	}
-	copy(v[consts.Uint64Len+1:], units.Bytes())
-	binary.BigEndian.PutUint64(v[consts.Uint64Len+1+fees.DimensionsLen:], fee)
-	return db.Put(k, v)
-}
-
-func GetTransaction(
-	_ context.Context,
-	db database.KeyValueReader,
-	id ids.ID,
-) (bool, int64, bool, fees.Dimensions, uint64, error) {
-	k := TxKey(id)
-	v, err := db.Get(k)
-	if errors.Is(err, database.ErrNotFound) {
-		return false, 0, false, fees.Dimensions{}, 0, nil
-	}
-	if err != nil {
-		return false, 0, false, fees.Dimensions{}, 0, err
-	}
-	t := int64(binary.BigEndian.Uint64(v))
-	success := true
-	if v[consts.Uint64Len] == failureByte {
-		success = false
-	}
-	d, err := fees.UnpackDimensions(v[consts.Uint64Len+1 : consts.Uint64Len+1+fees.DimensionsLen])
-	if err != nil {
-		return false, 0, false, fees.Dimensions{}, 0, err
-	}
-	fee := binary.BigEndian.Uint64(v[consts.Uint64Len+1+fees.DimensionsLen:])
-	return true, t, success, d, fee, nil
-}
-
 // [balancePrefix] + [address]
 func BalanceKey(addr codec.Address) (k []byte) {
 	k = make([]byte, 1+codec.AddressLen+consts.Uint16Len)

examples/tokenvm/controller/action_handler.go

@@ -0,0 +1,56 @@
+// Copyright (C) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package controller
+
+import (
+	"context"
+
+	"github.com/ava-labs/hypersdk/chain"
+	"github.com/ava-labs/hypersdk/examples/tokenvm/actions"
+	"github.com/ava-labs/hypersdk/extension/indexer"
+)
+
+var _ indexer.SuccessfulTxSubscriber = (*actionHandler)(nil)
+
+type actionHandler struct {
+	c *Controller
+}
+
+func (a *actionHandler) Accepted(_ context.Context, tx *chain.Transaction, result *chain.Result) error {
+	for i, act := range tx.Actions {
+		switch action := act.(type) {
+		case *actions.CreateAsset:
+			a.c.metrics.createAsset.Inc()
+		case *actions.MintAsset:
+			a.c.metrics.mintAsset.Inc()
+		case *actions.BurnAsset:
+			a.c.metrics.burnAsset.Inc()
+		case *actions.Transfer:
+			a.c.metrics.transfer.Inc()
+		case *actions.CreateOrder:
+			a.c.metrics.createOrder.Inc()
+			a.c.orderBook.Add(chain.CreateActionID(tx.ID(), uint8(i)), tx.Auth.Actor(), action)
+		case *actions.FillOrder:
+			a.c.metrics.fillOrder.Inc()
+			outputs := result.Outputs[i]
+			for _, output := range outputs {
+				orderResult, err := actions.UnmarshalOrderResult(output)
+				if err != nil {
+					// This should never happen
+					return err
+				}
+				if orderResult.Remaining == 0 {
+					a.c.orderBook.Remove(action.Order)
+					continue
+				}
+				a.c.orderBook.UpdateRemaining(action.Order, orderResult.Remaining)
+			}
+		case *actions.CloseOrder:
+			a.c.metrics.closeOrder.Inc()
+			a.c.orderBook.Remove(action.Order)
+		}
+	}
+
+	return nil
+}