feat: add file-based transaction indexing

gno.land/cmd/gnoland/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"context"
+	"errors"
 	"flag"
 	"fmt"
 	"os"
@@ -16,6 +17,9 @@ import (
 	"github.com/gnolang/gno/tm2/pkg/bft/config"
 	"github.com/gnolang/gno/tm2/pkg/bft/node"
 	"github.com/gnolang/gno/tm2/pkg/bft/privval"
+	indexercfg "github.com/gnolang/gno/tm2/pkg/bft/state/txindex/config"
+	"github.com/gnolang/gno/tm2/pkg/bft/state/txindex/file"
+	"github.com/gnolang/gno/tm2/pkg/bft/state/txindex/null"
 	bft "github.com/gnolang/gno/tm2/pkg/bft/types"
 	"github.com/gnolang/gno/tm2/pkg/commands"
 	"github.com/gnolang/gno/tm2/pkg/crypto"
@@ -33,6 +37,9 @@ type gnolandCfg struct {
 	chainID               string
 	genesisRemote         string
 	rootDir               string
+
+	txIndexerType string
+	txIndexerPath string
 }
 
 func main() {
@@ -105,6 +112,20 @@ func (c *gnolandCfg) RegisterFlags(fs *flag.FlagSet) {
 		"localhost:26657",
 		"replacement for '%%REMOTE%%' in genesis",
 	)
+
+	fs.StringVar(
+		&c.txIndexerType,
+		"tx-indexer-type",
+		null.IndexerType,
+		fmt.Sprintf("type of transaction indexer [%s, %s]", null.IndexerType, file.IndexerType),
+	)
+
+	fs.StringVar(
+		&c.txIndexerPath,
+		"tx-indexer-path",
+		"",
+		fmt.Sprintf("path for the file tx-indexer (required if indexer if '%s')", file.IndexerType),
+	)
 }
 
 func exec(c *gnolandCfg) error {
@@ -134,6 +155,14 @@ func exec(c *gnolandCfg) error {
 		writeGenesisFile(genDoc, genesisFilePath)
 	}
 
+	// Initialize the indexer config
+	indexerCfg, err := getIndexerConfig(c)
+	if err != nil {
+		return fmt.Errorf("unable to parse indexer config, %w", err)
+	}
+
+	cfg.Indexer = indexerCfg
+
 	// create application and node.
 	gnoApp, err := gnoland.NewApp(rootDir, c.skipFailingGenesisTxs, logger)
 	if err != nil {
@@ -169,6 +198,30 @@ func exec(c *gnolandCfg) error {
 	select {} // run forever
 }
 
+// getIndexerConfig constructs an indexer config from provided user options
+func getIndexerConfig(c *gnolandCfg) (*indexercfg.Config, error) {
+	var cfg *indexercfg.Config
+
+	switch c.txIndexerType {
+	case file.IndexerType:
+		if c.txIndexerPath == "" {
+			return nil, errors.New("unspecified file transaction indexer path")
+		}
+
+		// Fill out the configuration
+		cfg = &indexercfg.Config{
+			IndexerType: file.IndexerType,
+			Params: map[string]any{
+				file.Path: c.txIndexerPath,
+			},
+		}
+	default:
+		cfg = indexercfg.DefaultIndexerConfig()
+	}
+
+	return cfg, nil
+}
+
 // Makes a local test genesis doc with local privValidator.
 func makeGenesisDoc(
 	pvPub crypto.PubKey,

tm2/pkg/autofile/group.go

@@ -136,11 +136,12 @@ func (g *Group) Wait() {
 
 // Close closes the head file. The group must be stopped by this moment.
 func (g *Group) Close() {
-	g.FlushAndSync()
+	_ = g.FlushAndSync()
 
 	g.mtx.Lock()
+	defer g.mtx.Unlock()
+
 	_ = g.Head.Close()
-	g.mtx.Unlock()
 }
 
 // HeadSizeLimit returns the current head size limit.

tm2/pkg/bft/config/config.go

@@ -9,6 +9,7 @@ import (
 	cns "github.com/gnolang/gno/tm2/pkg/bft/consensus/config"
 	mem "github.com/gnolang/gno/tm2/pkg/bft/mempool/config"
 	rpc "github.com/gnolang/gno/tm2/pkg/bft/rpc/config"
+	"github.com/gnolang/gno/tm2/pkg/bft/state/txindex/config"
 	"github.com/gnolang/gno/tm2/pkg/errors"
 	osm "github.com/gnolang/gno/tm2/pkg/os"
 	p2p "github.com/gnolang/gno/tm2/pkg/p2p/config"
@@ -24,6 +25,7 @@ type Config struct {
 	P2P       *p2p.P2PConfig       `toml:"p2p"`
 	Mempool   *mem.MempoolConfig   `toml:"mempool"`
 	Consensus *cns.ConsensusConfig `toml:"consensus"`
+	Indexer   *config.Config       `toml:"indexer"`
 }
 
 // DefaultConfig returns a default configuration for a Tendermint node
@@ -34,6 +36,7 @@ func DefaultConfig() *Config {
 		P2P:        p2p.DefaultP2PConfig(),
 		Mempool:    mem.DefaultMempoolConfig(),
 		Consensus:  cns.DefaultConsensusConfig(),
+		Indexer:    config.DefaultIndexerConfig(),
 	}
 }
 
@@ -73,6 +76,7 @@ func TestConfig() *Config {
 		P2P:        p2p.TestP2PConfig(),
 		Mempool:    mem.TestMempoolConfig(),
 		Consensus:  cns.TestConsensusConfig(),
+		Indexer:    config.DefaultIndexerConfig(),
 	}
 }
 
@@ -121,7 +125,7 @@ func (cfg *Config) ValidateBasic() error {
 	return nil
 }
 
-//-----------------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 // BaseConfig
 
 const (

tm2/pkg/bft/node/node.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/gnolang/cors"
+	"github.com/gnolang/gno/tm2/pkg/bft/state/txindex/file"
 
 	"github.com/gnolang/gno/tm2/pkg/amino"
 	abci "github.com/gnolang/gno/tm2/pkg/bft/abci/types"
@@ -41,7 +42,7 @@ import (
 	verset "github.com/gnolang/gno/tm2/pkg/versionset"
 )
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 // DBContext specifies config information for loading a new DB.
 type DBContext struct {
@@ -134,7 +135,7 @@ func CustomReactors(reactors map[string]p2p.Reactor) Option {
 	}
 }
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 // Node is the highest level interface to a full Tendermint node.
 // It includes all configuration information and running services.
@@ -193,35 +194,35 @@ func createAndStartProxyAppConns(clientCreator proxy.ClientCreator, logger log.L
 	return proxyApp, nil
 }
 
-func createAndStartIndexerService(config *cfg.Config, dbProvider DBProvider,
-	evsw events.EventSwitch, logger log.Logger,
+func createAndStartIndexerService(
+	cfg *cfg.Config,
+	evSwitch events.EventSwitch,
+	logger log.Logger,
 ) (*txindex.IndexerService, txindex.TxIndexer, error) {
-	var txIndexer txindex.TxIndexer = &null.TxIndex{}
-	/*
-		switch config.TxIndex.Indexer {
-		case "kv":
-			store, err := dbProvider(&DBContext{"tx_index", config})
-			if err != nil {
-				return nil, nil, err
-			}
-			switch {
-			case config.TxIndex.IndexTags != "":
-				txIndexer = kv.NewTxIndex(store, kv.IndexTags(splitAndTrimEmpty(config.TxIndex.IndexTags, ",", " ")))
-			case config.TxIndex.IndexAllTags:
-				txIndexer = kv.NewTxIndex(store, kv.IndexAllTags())
-			default:
-				txIndexer = kv.NewTxIndex(store)
-			}
-		default:
-			txIndexer = &null.TxIndex{}
+	var (
+		err       error
+		txIndexer txindex.TxIndexer
+	)
+
+	// Instantiate the indexer based on the configuration
+	switch cfg.Indexer.IndexerType {
+	case file.IndexerType:
+		// Transaction indexes should be logged to files
+		txIndexer, err = file.NewTxIndexer(cfg.Indexer)
+		if err != nil {
+			return nil, nil, fmt.Errorf("unable to create file tx indexer, %w", err)
 		}
-	*/
+	default:
+		// Transaction indexing should be omitted
+		txIndexer = null.NewNullIndexer()
+	}
 
-	indexerService := txindex.NewIndexerService(txIndexer, evsw)
+	indexerService := txindex.NewIndexerService(txIndexer, evSwitch)
 	indexerService.SetLogger(logger.With("module", "txindex"))
-	if err := indexerService.Start(); err != nil {
+	if err = indexerService.Start(); err != nil {
 		return nil, nil, err
 	}
+
 	return indexerService, txIndexer, nil
 }
 
@@ -438,7 +439,7 @@ func NewNode(config *cfg.Config,
 	evsw := events.NewEventSwitch()
 
 	// Transaction indexing
-	indexerService, txIndexer, err := createAndStartIndexerService(config, dbProvider, evsw, logger)
+	indexerService, txIndexer, err := createAndStartIndexerService(config, evsw, logger)
 	if err != nil {
 		return nil, err
 	}
@@ -819,7 +820,7 @@ func (n *Node) Config() *cfg.Config {
 	return n.config
 }
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 func (n *Node) Listeners() []string {
 	return []string{
@@ -843,11 +844,9 @@ func makeNodeInfo(
 	genDoc *types.GenesisDoc,
 	state sm.State,
 ) (p2p.NodeInfo, error) {
-	txIndexerStatus := "on"
-	if _, ok := txIndexer.(*null.TxIndex); ok {
-		txIndexerStatus = "off"
-	} else if txIndexer == nil {
-		txIndexerStatus = "none"
+	txIndexerStatus := "off"
+	if txIndexer.GetType() != null.IndexerType {
+		txIndexerStatus = "on"
 	}
 
 	bcChannel := bc.BlockchainChannel
@@ -887,7 +886,7 @@ func makeNodeInfo(
 	return nodeInfo, err
 }
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 var genesisDocKey = []byte("genesisDoc")
 

tm2/pkg/bft/state/txindex/config/config.go

@@ -0,0 +1,30 @@
+package config
+
+import "github.com/gnolang/gno/tm2/pkg/bft/state/txindex/null"
+
+// IndexerParams defines the arbitrary indexer config params
+type IndexerParams map[string]any
+
+// Config defines the specific transaction
+// indexer configuration
+type Config struct {
+	IndexerType string
+	Params      IndexerParams
+}
+
+// GetParam fetches the specific config param, if any.
+// Returns nil if the param is not present
+func (c *Config) GetParam(name string) any {
+	if c.Params != nil {
+		return c.Params[name]
+	}
+
+	return nil
+}
+
+// DefaultIndexerConfig returns the default indexer config
+func DefaultIndexerConfig() *Config {
+	return &Config{
+		IndexerType: null.IndexerType,
+	}
+}

tm2/pkg/bft/state/txindex/config/config_test.go

@@ -0,0 +1,45 @@
+package config
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestConfig_GetParam(t *testing.T) {
+	t.Parallel()
+
+	const paramName = "param"
+
+	testTable := []struct {
+		name string
+		cfg  *Config
+
+		expectedParam any
+	}{
+		{
+			"param not set",
+			&Config{},
+			nil,
+		},
+		{
+			"valid param set",
+			&Config{
+				Params: map[string]any{
+					paramName: 10,
+				},
+			},
+			10,
+		},
+	}
+
+	for _, testCase := range testTable {
+		testCase := testCase
+
+		t.Run(testCase.name, func(t *testing.T) {
+			t.Parallel()
+
+			assert.Equal(t, testCase.expectedParam, testCase.cfg.GetParam(paramName))
+		})
+	}
+}