Merge branch 'ryan/repo-standards' into 'main'

ryanc-flare · ryanc-flare · commit a22fd8015f65 · 2025-12-04T12:18:24.000Z
Add informational files and update linter settings

See merge request flarenetwork/FSP/flare-system-c-chain-indexer!75
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @ryanc-flare @tilenflare
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -2,8 +2,8 @@ variables:
   GOPATH: /go
   MYSQL_ROOT_PASSWORD: root
   MYSQL_DATABASE: flare_ftso_indexer_indexer_test
-  GOLANG_VERSION: "1.24-trixie@sha256:73860edd0febb45d37a5220ba39a6675d67f72163c79a4cebd9d0e6985609140"
-  GOLINT_VERSION: "v2.1.6"
+  GOLANG_VERSION: "1.25-trixie@sha256:4f9d98ebaa759f776496d850e0439c48948d587b191fc3949b5f5e4667abef90"
+  GOLINT_VERSION: "v2.7.0"
 
 .gocache:
   key: ${CI_COMMIT_REF_SLUG}
diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS
@@ -0,0 +1 @@
+* @ryancollingham @tilen.marc 
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,47 @@
+version: "2"
+run:
+  go: "1.25.1"
+  modules-download-mode: readonly
+linters:
+  default: standard
+  enable:
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - containedctx
+    - copyloopvar
+    - decorder
+    - errchkjson
+    - errname
+    - exhaustive
+    - exptostd
+    - forcetypeassert
+    - misspell
+    - nolintlint
+    - unconvert
+    - whitespace
+
+  settings:
+    exhaustive:
+      default-signifies-exhaustive: true
+    nolintlint:
+      require-specific: true
+exclusions:
+  generated: lax
+  paths:
+    - third_party$
+    - builtin$
+    - examples$
+formatters:
+  enable:
+    - gofmt
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+
+issues:
+  max-same-issues: 3
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## \[[v1.1.2](https://github.com/flare-foundation/flare-system-c-chain-indexer/tree/v1.1.2)\] - 2025-11-03
+
+### Added
+
+- simplify calculation of starting index within indexer
+- add extra env var overrides for DB configuration
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,73 @@
+# Contributing
+
+This document describes the process of contributing to this project. It is
+intended for anyone considering opening an issue or pull request.
+
+## AI Assistance
+
+> [!IMPORTANT]
+>
+> If you are using **any kind of AI assistance** to contribute to this project,
+> it must be disclosed in the pull request.
+
+If you are using any kind of AI assistance while contributing to this project,
+**this must be disclosed in the pull request**, along with the extent to which
+AI assistance was used. Trivial tab-completion doesn't need to be disclosed, as
+long as it is limited to single keywords or short phrases.
+
+An example disclosure:
+
+> This PR was written primarily by Claude Code.
+
+Or a more detailed disclosure:
+
+> I consulted ChatGPT to understand the codebase but the solution was fully
+> authored manually by myself.
+
+## Quick start
+
+If you'd like to contribute, report a bug, suggest a feature or you've
+implemented a feature you should open an issue or pull request.
+
+Any contribution to the project is expected to contain code that is formatted,
+linted and that the existing tests still pass. Adding unit tests for new code is
+also welcome.
+
+## Dev environment
+
+The indexer is implemented using Go - it is recommended to use version 1.24 or later. An RPC connection URL and a MySQL database are required in order to run the main indexer. Configuration should be provided via a `config.toml` file - you can copy
+`config.example.toml` and modify to connect to your specific RPC provider and database instance as well as set other
+parameters.
+
+## Linting and formatting
+
+`golangci-lint` is used for linting - install instructions may be found
+\[[here](https://golangci-lint.run/docs/welcome/install/#local-installation)\]. Once installed you can run with:
+
+```
+$ golangci-lint run
+```
+
+For formatting use the standard `go fmt` command:
+
+```
+$ go fmt ./...
+```
+
+It is recommended to set up your editor to run both of these automatically. 
+
+## Testing
+
+Run the tests with:
+
+```
+$ go test ./...
+```
+
+Note that the `main_test.go` is an integration test which requires an RPC connection and MySQL database - 
+you can edit the test config file at `testing/config_test.toml`. Environment variable overrides are also
+supported for convenience.
+
+## Release process (if applicable)
+
+Releases are made by creating a tag. The CHANGELOG.md should also be updated with the release details.
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # build executable
-FROM golang:1.24-trixie@sha256:73860edd0febb45d37a5220ba39a6675d67f72163c79a4cebd9d0e6985609140 AS builder
+FROM golang:1.25-trixie@sha256:4f9d98ebaa759f776496d850e0439c48948d587b191fc3949b5f5e4667abef90 AS builder
 
 WORKDIR /build
 
diff --git a/README.md b/README.md
@@ -1,11 +1,29 @@
+<!-- LOGO -->
+
+<div align="center">
+  <a href="https://flare.network/" target="blank">
+    <img src="https://content.flare.network/Flare-2.svg" width="300" alt="Flare Logo" />
+  </a>
+  <br />
+  Flare C-Chain Indexer
+  <br />
+  <a href="#PROJECT_NAME">About</a>
+  ·
+  <a href="CONTRIBUTING.md">Contributing</a>
+  ·
+  <a href="SECURITY.md">Security</a>
+  ·
+  <a href="CHANGELOG.md">Changelog</a>
+</div>
+
 # Flare FTSO indexer
 
 This code implements a fast and parallelized indexer of C-chain that fetches data needed for
 various Flare protocols. It saves the data in a MySQL database.
 
 ### Prerequisites
 
-The indexer is implemented in Go (tested with version 1.21). A running MySQL database to save the data is needed (we provide a
+The indexer is implemented in Go (tested with version 1.24). A running MySQL database to save the data is needed (we provide a
 docker-compose.yaml file for automatic deployment of a database).
 
 ### Configuration
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,22 @@
+# Security policy
+
+## Reporting a vulnerability
+
+If you have found a possible vulnerability, please email
+`security@flare.network`.
+
+## Bug bounties
+
+We sincerely appreciate and encourage reports of suspected security
+vulnerabilities. We currently run a bug bounty program through Immunefi, where
+eligible researchers can earn rewards for responsibly disclosing valid security
+issues. Please refer to our
+[Immunefi](https://immunefi.com/bug-bounty/flarenetwork/information/) page for
+scope, rules, and submission guidelines.
+
+## Vulnerability disclosures
+
+Critical vulnerabilities will be disclosed via GitHub's
+[security advisory](https://github.com/flare-foundation/fassets/security)
+system.
+
diff --git a/main_test.go b/main_test.go
@@ -41,7 +41,6 @@ type testConfig struct {
 
 type IntegrationIndex struct {
 	suite.Suite
-	ctx     context.Context
 	cfg     config.Config
 	indexer *indexer.BlockIndexer
 	db      *gorm.DB
@@ -73,20 +72,20 @@ func TestIntegrationIndexHistory(t *testing.T) {
 	suite.Run(t, testSuite)
 }
 
-func (suite *IntegrationIndexContinuousSuite) SetupSuite() {
-	err := suite.indexer.IndexContinuous(suite.ctx, startBlock)
+func (suite *IntegrationIndexContinuousSuite) SetupSuite(ctx context.Context) {
+	err := suite.indexer.IndexContinuous(ctx, startBlock)
 	require.NoError(suite.T(), err, "Could not run the indexer")
 }
 
-func (suite *IntegrationIndexHistorySuite) SetupSuite() {
-	lastIndex, err := suite.indexer.IndexHistory(suite.ctx)
+func (suite *IntegrationIndexHistorySuite) SetupSuite(ctx context.Context) {
+	lastIndex, err := suite.indexer.IndexHistory(ctx)
 	require.NoError(suite.T(), err, "Could not run the indexer")
 	require.Equal(suite.T(), uint64(endBlockHistory), lastIndex, "Last indexed block does not match expected value")
 }
 
-func (suite *IntegrationIndex) TestCheckBlocks() {
+func (suite *IntegrationIndex) TestCheckBlocks(ctx context.Context) {
 	var blocks []database.Block
-	result := suite.db.WithContext(suite.ctx).Order("hash ASC").Find(&blocks)
+	result := suite.db.WithContext(ctx).Order("hash ASC").Find(&blocks)
 	require.NoError(suite.T(), result.Error, "Could not find blocks")
 
 	suite.T().Logf("Found %d blocks", len(blocks))
@@ -97,9 +96,9 @@ func (suite *IntegrationIndex) TestCheckBlocks() {
 	cupaloy.SnapshotT(suite.T(), blocks)
 }
 
-func (suite *IntegrationIndex) TestCheckTransactions() {
+func (suite *IntegrationIndex) TestCheckTransactions(ctx context.Context) {
 	var transactions []database.Transaction
-	result := suite.db.WithContext(suite.ctx).Order("hash ASC").Find(&transactions)
+	result := suite.db.WithContext(ctx).Order("hash ASC").Find(&transactions)
 	require.NoError(suite.T(), result.Error, "Could not find transactions")
 
 	suite.T().Logf("Found %d transactions", len(transactions))
@@ -110,9 +109,9 @@ func (suite *IntegrationIndex) TestCheckTransactions() {
 	cupaloy.SnapshotT(suite.T(), transactions)
 }
 
-func (suite *IntegrationIndex) TestCheckLogs() {
+func (suite *IntegrationIndex) TestCheckLogs(ctx context.Context) {
 	var logs []database.Log
-	result := suite.db.WithContext(suite.ctx).
+	result := suite.db.WithContext(ctx).
 		Preload("Transaction").
 		Order("transaction_hash ASC, log_index ASC").
 		Find(&logs)
@@ -127,7 +126,7 @@ func (suite *IntegrationIndex) TestCheckLogs() {
 }
 
 func (suite *IntegrationIndex) prepareSuite(isHistory bool) error {
-	suite.ctx = context.Background()
+	ctx := context.Background()
 	tCfg := testConfig{}
 
 	_, err := toml.DecodeFile("testing/config_test.toml", &tCfg)
@@ -139,7 +138,7 @@ func (suite *IntegrationIndex) prepareSuite(isHistory bool) error {
 
 	suite.cfg = initConfig(tCfg, isHistory)
 
-	suite.db, err = database.ConnectAndInitialize(suite.ctx, &suite.cfg.DB)
+	suite.db, err = database.ConnectAndInitialize(ctx, &suite.cfg.DB)
 	if err != nil {
 		return errors.Wrap(err, "Could not connect to the database")
 	}
@@ -263,8 +262,8 @@ func checkBlocks(t *testing.T, blocks []database.Block, cfg *config.Config) {
 
 func checkBlock(t *testing.T, block *database.Block, cfg *config.Config) {
 	require.NotEmpty(t, block.Hash, "Block hash should not be empty")
-	require.GreaterOrEqual(t, block.Number, uint64(cfg.Indexer.StartIndex))
-	require.LessOrEqual(t, block.Number, uint64(cfg.Indexer.StopIndex))
+	require.GreaterOrEqual(t, block.Number, cfg.Indexer.StartIndex)
+	require.LessOrEqual(t, block.Number, cfg.Indexer.StopIndex)
 	require.NotZero(t, block.Timestamp, "Timestamp should not be zero")
 }
 
@@ -279,8 +278,8 @@ func checkTransaction(t *testing.T, tx *database.Transaction, cfg *config.Config
 	require.NotEmpty(t, tx.Hash, "Transaction hash should not be empty")
 	require.NotEmpty(t, tx.FunctionSig, "Function signature should not be empty")
 	require.NotEmpty(t, tx.Input, "Input should not be empty")
-	require.GreaterOrEqual(t, tx.BlockNumber, uint64(cfg.Indexer.StartIndex))
-	require.LessOrEqual(t, tx.BlockNumber, uint64(cfg.Indexer.StopIndex))
+	require.GreaterOrEqual(t, tx.BlockNumber, cfg.Indexer.StartIndex)
+	require.LessOrEqual(t, tx.BlockNumber, cfg.Indexer.StopIndex)
 	require.NotEmpty(t, tx.BlockHash, "Block hash should not be empty")
 	require.NotEmpty(t, tx.FromAddress, "From address should not be empty")
 	require.True(t, compareAddrStrs(tx.ToAddress, contractAddress), "To address should be the contract address")
