feat(ci): add goimports sorting lint

.github/workflows/test.yml

@@ -23,6 +23,25 @@ jobs:
       - name: Lint
         run: make lint
 
+  sort-import-lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.21
+          cache: true
+
+      - name: Sort Import Lint
+        run: make sort-import
+
+      - name: Check for changes
+        run: |
+          git diff --exit-code || { echo "Go imports revisions detected. Please run make sort-import and commit changes."; exit 1; }
+
   integration_tests:
     name: Integration tests
     runs-on: ubuntu-latest

Makefile

@@ -32,9 +32,13 @@ gen_bindings:
 	TAIKO_GETH_DIR=${TAIKO_GETH_DIR} \
 		./scripts/gen_bindings.sh
 
+sort-import:
+	@./scripts/goimports-reviser.sh
+
 .PHONY: build \
 				clean \
 				lint \
 				test \
 				dev_net \
-				gen_bindings
+				gen_bindings \
+				sort-import

cmd/logger/logger.go

@@ -4,8 +4,9 @@ import (
 	"os"
 
 	"github.com/ethereum/go-ethereum/log"
-	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/urfave/cli/v2"
+
+	"github.com/taikoxyz/taiko-client/cmd/flags"
 )
 
 // InitLogger initializes the root logger with the command line flags.

driver/chain_syncer/calldata/syncer.go

@@ -16,17 +16,17 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/rlp"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
+	anchorTxConstructor "github.com/taikoxyz/taiko-client/driver/anchor_tx_constructor"
 	"github.com/taikoxyz/taiko-client/driver/chain_syncer/beaconsync"
 	"github.com/taikoxyz/taiko-client/driver/state"
+	txlistfetcher "github.com/taikoxyz/taiko-client/driver/txlist_fetcher"
 	"github.com/taikoxyz/taiko-client/internal/metrics"
 	"github.com/taikoxyz/taiko-client/internal/utils"
-	"github.com/taikoxyz/taiko-client/pkg/rpc"
-
-	anchorTxConstructor "github.com/taikoxyz/taiko-client/driver/anchor_tx_constructor"
-	txlistfetcher "github.com/taikoxyz/taiko-client/driver/txlist_fetcher"
 	eventIterator "github.com/taikoxyz/taiko-client/pkg/chain_iterator/event_iterator"
+	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	txListValidator "github.com/taikoxyz/taiko-client/pkg/txlist_validator"
 )
 

driver/chain_syncer/chain_syncer_test.go

@@ -3,7 +3,6 @@ package chainsyncer
 import (
 	"bytes"
 	"context"
-
 	"os"
 	"testing"
 	"time"

driver/driver.go

@@ -13,11 +13,11 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/event"
 	"github.com/ethereum/go-ethereum/log"
+	"github.com/urfave/cli/v2"
 
 	chainSyncer "github.com/taikoxyz/taiko-client/driver/chain_syncer"
 	"github.com/taikoxyz/taiko-client/driver/state"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
-	"github.com/urfave/cli/v2"
 )
 
 const (

driver/txlist_fetcher/calldata.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/ethereum/go-ethereum/core/types"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 	"github.com/taikoxyz/taiko-client/pkg"

driver/txlist_fetcher/interface.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/ethereum/go-ethereum/core/types"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 )
 

internal/utils/util_test.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/ethereum/go-ethereum/params"
 	"github.com/stretchr/testify/require"
+
 	"github.com/taikoxyz/taiko-client/internal/testutils"
 	"github.com/taikoxyz/taiko-client/internal/utils"
 )

internal/utils/utils.go

@@ -6,9 +6,8 @@ import (
 	"crypto/rand"
 	"errors"
 	"fmt"
-	"math"
-
 	"io"
+	"math"
 	"math/big"
 	"os"
 	"strings"

pkg/flags/config.go

@@ -6,8 +6,9 @@ import (
 	"github.com/ethereum-optimism/optimism/op-service/txmgr"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
-	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/urfave/cli/v2"
+
+	"github.com/taikoxyz/taiko-client/cmd/flags"
 )
 
 // InitTxmgrConfigsFromCli initializes the transaction manager configs from the command line flags.

pkg/rpc/blob_datasource.go

@@ -9,6 +9,7 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/go-resty/resty/v2"
 	"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/blob"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/pkg"
 )

pkg/rpc/client.go

@@ -8,6 +8,7 @@ import (
 	"github.com/cenkalti/backoff/v4"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 )
 

pkg/rpc/methods_test.go

@@ -9,6 +9,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/stretchr/testify/require"
+
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 )
 

pkg/rpc/subscription_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/event"
 	"github.com/stretchr/testify/require"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 )
 

proposer/config.go

@@ -15,10 +15,9 @@ import (
 
 	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/taikoxyz/taiko-client/internal/utils"
+	pkgFlags "github.com/taikoxyz/taiko-client/pkg/flags"
 	"github.com/taikoxyz/taiko-client/pkg/jwt"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
-
-	pkgFlags "github.com/taikoxyz/taiko-client/pkg/flags"
 )
 
 // Config contains all configurations to initialize a Taiko proposer.

proposer/proposer.go

@@ -16,6 +16,7 @@ import (
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/rlp"
+	"github.com/urfave/cli/v2"
 
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
@@ -24,7 +25,6 @@ import (
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	selector "github.com/taikoxyz/taiko-client/proposer/prover_selector"
 	builder "github.com/taikoxyz/taiko-client/proposer/transaction_builder"
-	"github.com/urfave/cli/v2"
 )
 
 var (

proposer/transaction_builder/blob.go

@@ -11,6 +11,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/crypto/kzg4844"
+
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	selector "github.com/taikoxyz/taiko-client/proposer/prover_selector"

proposer/transaction_builder/calldata_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/ethereum/go-ethereum/common"
+
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 )
 

proposer/transaction_builder/common.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
+
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 )
 

proposer/transaction_builder/interface.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/ethereum-optimism/optimism/op-service/txmgr"
+
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 )
 

prover/config.go

@@ -15,7 +15,6 @@ import (
 
 	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/taikoxyz/taiko-client/internal/utils"
-
 	pkgFlags "github.com/taikoxyz/taiko-client/pkg/flags"
 )
 

prover/event_handler/assignment_expired.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"

prover/event_handler/block_proposed_test.go

@@ -4,11 +4,11 @@ import (
 	"context"
 	"time"
 
-	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
-	state "github.com/taikoxyz/taiko-client/prover/shared_state"
-
 	"github.com/ethereum/go-ethereum/common"
+
 	"github.com/taikoxyz/taiko-client/bindings"
+	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
+	state "github.com/taikoxyz/taiko-client/prover/shared_state"
 )
 
 func (s *EventHandlerTestSuite) TestBlockProposedHandle() {

prover/event_handler/block_verified.go

@@ -3,6 +3,7 @@ package handler
 import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/internal/metrics"
 )

prover/event_handler/block_verified_test.go

@@ -2,6 +2,7 @@ package handler
 
 import (
 	"github.com/ethereum/go-ethereum/core/types"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/internal/testutils"
 )

prover/event_handler/transition_contested.go

@@ -7,6 +7,7 @@ import (
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"

prover/event_handler/transition_proved.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/internal/metrics"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"

prover/event_handler/util_test.go

@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/suite"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 	"github.com/taikoxyz/taiko-client/internal/testutils"

prover/init_test.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/ethereum-optimism/optimism/op-service/txmgr"
 	"github.com/ethereum/go-ethereum/common"
+
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 )
 

prover/server/server_test.go

@@ -17,6 +17,7 @@ import (
 	"github.com/go-resty/resty/v2"
 	"github.com/phayes/freeport"
 	"github.com/stretchr/testify/suite"
+
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	proofProducer "github.com/taikoxyz/taiko-client/prover/proof_producer"
 )

prover/shared_state/state.go

@@ -4,6 +4,7 @@ import (
 	"sync/atomic"
 
 	"github.com/ethereum/go-ethereum/core/types"
+
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 )
 

prover/shared_state/state_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/stretchr/testify/suite"
+
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 )
 

scripts/goimports-reviser.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+
+go install github.com/incu6us/goimports-reviser/v3@latest
+
+PROJECT_NAME=github.com/taikoxyz/taiko-client
+
+find . -name '*.go' -print0 | while IFS= read -r -d '' file; do
+  goimports-reviser -project-name "$PROJECT_NAME" "$file"
+done