feat(internal): add internal dir and format import order (#506)

bindings/encoding/input.go

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

bindings/encoding/input_test.go

@@ -8,11 +8,11 @@ import (
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
-
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/stretchr/testify/require"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 )
 

bindings/encoding/struct_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/stretchr/testify/require"
 
-	"github.com/taikoxyz/taiko-client/common/utils"
+	"github.com/taikoxyz/taiko-client/internal/utils"
 )
 
 var (

cmd/flags/proposer.go

@@ -1,8 +1,9 @@
 package flags
 
 import (
-	"github.com/taikoxyz/taiko-client/version"
 	"github.com/urfave/cli/v2"
+
+	"github.com/taikoxyz/taiko-client/internal/version"
 )
 
 // Required flags used by proposer.

cmd/main.go

@@ -4,13 +4,14 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/urfave/cli/v2"
+
 	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/taikoxyz/taiko-client/cmd/utils"
 	"github.com/taikoxyz/taiko-client/driver"
+	"github.com/taikoxyz/taiko-client/internal/version"
 	"github.com/taikoxyz/taiko-client/proposer"
 	"github.com/taikoxyz/taiko-client/prover"
-	"github.com/taikoxyz/taiko-client/version"
-	"github.com/urfave/cli/v2"
 )
 
 func main() {

cmd/utils/sub_command.go

@@ -7,9 +7,10 @@ import (
 	"syscall"
 
 	"github.com/ethereum/go-ethereum/log"
-	"github.com/taikoxyz/taiko-client/cmd/logger"
-	"github.com/taikoxyz/taiko-client/metrics"
 	"github.com/urfave/cli/v2"
+
+	"github.com/taikoxyz/taiko-client/cmd/logger"
+	"github.com/taikoxyz/taiko-client/internal/metrics"
 )
 
 type SubcommandApplication interface {

driver/anchor_tx_constructor/anchor_tx_constructor.go

@@ -10,6 +10,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/driver/signer"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 )

driver/anchor_tx_constructor/anchor_tx_constructor_test.go

@@ -10,7 +10,8 @@ import (
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/stretchr/testify/suite"
-	"github.com/taikoxyz/taiko-client/testutils"
+
+	"github.com/taikoxyz/taiko-client/internal/testutils"
 )
 
 type AnchorTxConstructorTestSuite struct {

driver/chain_syncer/beaconsync/progress_tracker.go

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

driver/chain_syncer/beaconsync/progress_tracker_test.go

@@ -8,7 +8,8 @@ import (
 	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stretchr/testify/suite"
-	"github.com/taikoxyz/taiko-client/testutils"
+
+	"github.com/taikoxyz/taiko-client/internal/testutils"
 )
 
 type BeaconSyncProgressTrackerTestSuite struct {

driver/chain_syncer/beaconsync/syncer.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/ethereum/go-ethereum/beacon/engine"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
 	"github.com/taikoxyz/taiko-client/driver/state"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"

driver/chain_syncer/calldata/syncer.go

@@ -14,12 +14,13 @@ 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"
-	"github.com/taikoxyz/taiko-client/metrics"
+	"github.com/taikoxyz/taiko-client/internal/metrics"
 	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/txlistvalidator"

driver/chain_syncer/calldata/syncer_test.go

@@ -11,13 +11,13 @@ import (
 	"github.com/ethereum/go-ethereum/core/rawdb"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/stretchr/testify/suite"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/driver/chain_syncer/beaconsync"
 	"github.com/taikoxyz/taiko-client/driver/state"
+	"github.com/taikoxyz/taiko-client/internal/testutils"
+	"github.com/taikoxyz/taiko-client/internal/utils"
 	"github.com/taikoxyz/taiko-client/proposer"
-	"github.com/taikoxyz/taiko-client/testutils"
-
-	"github.com/taikoxyz/taiko-client/common/utils"
 )
 
 type CalldataSyncerTestSuite struct {

driver/chain_syncer/chain_syncer.go

@@ -8,6 +8,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/driver/chain_syncer/beaconsync"
 	"github.com/taikoxyz/taiko-client/driver/chain_syncer/calldata"
 	"github.com/taikoxyz/taiko-client/driver/state"

driver/chain_syncer/chain_syncer_test.go

@@ -13,10 +13,11 @@ import (
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/stretchr/testify/suite"
+
 	"github.com/taikoxyz/taiko-client/driver/state"
+	"github.com/taikoxyz/taiko-client/internal/testutils"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 	"github.com/taikoxyz/taiko-client/proposer"
-	"github.com/taikoxyz/taiko-client/testutils"
 )
 
 type ChainSyncerTestSuite struct {

driver/config.go

@@ -6,9 +6,10 @@ import (
 	"time"
 
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/urfave/cli/v2"
+
 	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/taikoxyz/taiko-client/pkg/jwt"
-	"github.com/urfave/cli/v2"
 )
 
 // Config contains the configurations to initialize a Taiko driver.

driver/config_test.go

@@ -5,8 +5,9 @@ import (
 	"os"
 	"time"
 
-	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/urfave/cli/v2"
+
+	"github.com/taikoxyz/taiko-client/cmd/flags"
 )
 
 var (

driver/driver.go

@@ -13,6 +13,7 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/event"
 	"github.com/ethereum/go-ethereum/log"
+
 	chainSyncer "github.com/taikoxyz/taiko-client/driver/chain_syncer"
 	"github.com/taikoxyz/taiko-client/driver/state"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"

driver/driver_test.go

@@ -10,10 +10,11 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/stretchr/testify/suite"
+
 	"github.com/taikoxyz/taiko-client/bindings/encoding"
+	"github.com/taikoxyz/taiko-client/internal/testutils"
 	"github.com/taikoxyz/taiko-client/pkg/jwt"
 	"github.com/taikoxyz/taiko-client/proposer"
-	"github.com/taikoxyz/taiko-client/testutils"
 )
 
 type DriverTestSuite struct {
@@ -51,7 +52,7 @@ func (s *DriverTestSuite) SetupTest() {
 	s.Nil(err)
 
 	proposeInterval := 1024 * time.Hour // No need to periodically propose transactions list in unit tests
-	s.Nil(proposer.InitFromConfig(context.Background(), p, (&proposer.Config{
+	s.Nil(proposer.InitFromConfig(context.Background(), p, &proposer.Config{
 		L1Endpoint:                 os.Getenv("L1_NODE_WS_ENDPOINT"),
 		L2Endpoint:                 os.Getenv("L2_EXECUTION_ENGINE_WS_ENDPOINT"),
 		TaikoL1Address:             common.HexToAddress(os.Getenv("TAIKO_L1_ADDRESS")),
@@ -69,7 +70,7 @@ func (s *DriverTestSuite) SetupTest() {
 		SgxAndPseZkevmTierFee:      common.Big256,
 		MaxTierFeePriceBumps:       3,
 		TierFeePriceBump:           common.Big2,
-	})))
+	}))
 	s.p = p
 }
 

driver/signer/fixed_k_signer_test.go

@@ -7,7 +7,8 @@ import (
 	"github.com/decred/dcrd/dcrec/secp256k1/v4"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/stretchr/testify/require"
-	"github.com/taikoxyz/taiko-client/testutils"
+
+	"github.com/taikoxyz/taiko-client/internal/testutils"
 )
 
 func TestSignWithK(t *testing.T) {

driver/state/l1_current_test.go

@@ -5,7 +5,8 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
-	"github.com/taikoxyz/taiko-client/testutils"
+
+	"github.com/taikoxyz/taiko-client/internal/testutils"
 )
 
 func (s *DriverStateTestSuite) TestGetL1Current() {

driver/state/state.go

@@ -12,8 +12,9 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/event"
 	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/taikoxyz/taiko-client/bindings"
-	"github.com/taikoxyz/taiko-client/metrics"
+	"github.com/taikoxyz/taiko-client/internal/metrics"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"
 )
 

driver/state/state_test.go

@@ -8,9 +8,9 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/stretchr/testify/suite"
-	"github.com/taikoxyz/taiko-client/testutils"
 
-	"github.com/taikoxyz/taiko-client/common/utils"
+	"github.com/taikoxyz/taiko-client/internal/testutils"
+	"github.com/taikoxyz/taiko-client/internal/utils"
 )
 
 type DriverStateTestSuite struct {

integration_test/README.md

@@ -1,7 +1,7 @@
 # How to debug test cases?
 * start docker compose
 ```
-./docker/start.sh
+./internal/docker/start.sh
 ```
 
 * deploy L1 contracts
@@ -19,5 +19,5 @@ TAIKO_MONO_DIR=$taiko-mono ./integration_test/test_env.sh
 * copy the result of previous step and paste it into `Debug configurations`
 > after debugging, don't forget stop docker compose!
 ```
-./docker/stop.sh
+./internal/docker/stop.sh
 ```

integration_test/entrypoint.sh

@@ -11,8 +11,8 @@ check_command "forge"
 check_command "docker"
 
 # start and stop docker compose
-docker/start.sh
-trap "docker/stop.sh" EXIT INT KILL ERR
+internal/docker/start.sh
+trap "internal/docker/stop.sh" EXIT INT KILL ERR
 
 # deploy l1 contracts
 integration_test/deploy_l1_contract.sh

integration_test/l1_env.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-source docker/docker_env.sh
+source internal/docker/docker_env.sh
 
 export PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
 export TAIKO_L2_ADDRESS=0x1670010000000000000000000000000000010001

integration_test/test_env.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-source docker/docker_env.sh
+source internal/docker/docker_env.sh
 source scripts/common.sh
 
 # make sure environment variables are set.

docker/start.sh → internal/docker/start.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 source scripts/common.sh
-source docker/docker_env.sh
+source internal/docker/docker_env.sh
 
 # start docker compose service list
 echo "start docker compose service: ${DOCKER_SERVICE_LIST[*]}"

docker/stop.sh → internal/docker/stop.sh

@@ -2,7 +2,7 @@
 
 
 source scripts/common.sh
-source docker/docker_env.sh
+source internal/docker/docker_env.sh
 
 echo "stop docker compose service: ${DOCKER_SERVICE_LIST[*]}"
 

metrics/metrics.go → internal/metrics/metrics.go

@@ -10,8 +10,9 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/metrics"
 	"github.com/ethereum/go-ethereum/metrics/prometheus"
-	"github.com/taikoxyz/taiko-client/cmd/flags"
 	"github.com/urfave/cli/v2"
+
+	"github.com/taikoxyz/taiko-client/cmd/flags"
 )
 
 // Metrics

testutils/helper.go → internal/testutils/helper.go

@@ -20,6 +20,7 @@ import (
 	"github.com/ethereum/go-ethereum/rlp"
 	"github.com/go-resty/resty/v2"
 	"github.com/phayes/freeport"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/prover/server"
 )

testutils/interfaces.go → internal/testutils/interfaces.go

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

testutils/suite.go → internal/testutils/suite.go

@@ -13,6 +13,7 @@ import (
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/stretchr/testify/suite"
+
 	"github.com/taikoxyz/taiko-client/bindings"
 	"github.com/taikoxyz/taiko-client/pkg/jwt"
 	"github.com/taikoxyz/taiko-client/pkg/rpc"

common/utils/utils.go → internal/utils/utils.go

@@ -29,5 +29,5 @@ func RandUint32(max *big.Int) uint32 {
 
 // IsNil checks if the interface is empty.
 func IsNil(i interface{}) bool {
-	return i == nil || reflect2.IsNil(i)
+	return reflect2.IsNil(i)
 }

pkg/chain_iterator/block_batch_iterator.go

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

pkg/chain_iterator/block_batch_iterator_test.go

@@ -9,7 +9,8 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/stretchr/testify/suite"
-	"github.com/taikoxyz/taiko-client/testutils"
+
+	"github.com/taikoxyz/taiko-client/internal/testutils"
 )
 
 type BlockBatchIteratorTestSuite struct {