beacon repository refactorings and cleanup (#2204)

.dockerignore

@@ -11,3 +11,6 @@ testing/
 .git/
 .vscode/
 *.md
+contracts/
+docs/
+scripts/

.gitignore

@@ -30,7 +30,7 @@ tmp/
 *.out
 
 # Dependency directories (remove the comment below to include it)
-go.work.sum 
+go.work.sum
 
 ##########
 # Linux  #

.mockery.yaml

@@ -30,7 +30,7 @@ outpkg: "mocks"
 resolve-type-alias: False # see https://vektra.github.io/mockery/latest/deprecations/#resolve-type-alias
 issue-845-fix: True # see https://vektra.github.io/mockery/latest/deprecations/#issue-845-fix
 packages:
-  github.com/berachain/beacon-kit/mod/execution/pkg/client/ethclient:
+  github.com/berachain/beacon-kit/mod/execution/client/ethclient:
     config:
       recursive: True
       with-expecter: true
@@ -40,37 +40,37 @@ packages:
       recursive: True
       with-expecter: true
       all: True
-  github.com/berachain/beacon-kit/mod/node-core/pkg/services/registry:
+  github.com/berachain/beacon-kit/mod/node-core/services/registry:
     config:
       recursive: True
       with-expecter: true
       all: True
-  github.com/berachain/beacon-kit/mod/storage/pkg/interfaces:
+  github.com/berachain/beacon-kit/mod/storage/interfaces:
     config:
       recursive: False
       with-expecter: true
       all: True
-  github.com/berachain/beacon-kit/mod/consensus-types/pkg/types:
+  github.com/berachain/beacon-kit/mod/consensus-types/types:
     config:
       recursive: False
       with-expecter: true
       all: True
-  github.com/berachain/beacon-kit/mod/storage/pkg/pruner:
+  github.com/berachain/beacon-kit/mod/storage/pruner:
     config:
       recursive: False
       with-expecter: true
       all: True
-  github.com/berachain/beacon-kit/mod/primitives/pkg/crypto:
+  github.com/berachain/beacon-kit/mod/primitives/crypto:
     config:
       recursive: False
       with-expecter: true
       all: True
-  github.com/berachain/beacon-kit/mod/engine-primitives/pkg/engine-primitives:
+  github.com/berachain/beacon-kit/mod/engine-primitives/engine-primitives:
     config:
       recursive: False
       with-expecter: true
       all: True
-  github.com/berachain/beacon-kit/mod/state-transition/pkg/core:
+  github.com/berachain/beacon-kit/mod/state-transition/core:
     config:
       recursive: False
       with-expecter: true

Dockerfile

@@ -24,7 +24,7 @@ ARG BUILD_TAGS="netgo,muslc,blst,bls12381,pebbledb"
 ARG NAME=beacond
 ARG APP_NAME=beacond
 ARG DB_BACKEND=pebbledb
-ARG CMD_PATH=./beacond/cmd
+ARG CMD_PATH=./cmd/beacond
 
 #######################################################
 ###         Stage 1 - Cache Go Modules              ###
@@ -63,10 +63,8 @@ RUN apk add --no-cache --update \
 # Copy the dependencies from the cache stage
 COPY --from=mod-cache /go/pkg /go/pkg
 
-# Copy the rest of the source code
-COPY ./go.mod ./go.sum ./
-COPY ./mod ./mod
-COPY ./beacond ./beacond
+# Copy all the source code (this will ignore files/dirs in .dockerignore)
+COPY ./ ./
 
 # Build args
 ARG NAME

Makefile

@@ -1,16 +1,16 @@
 #!/usr/bin/make -f
 
-include build/scripts/build.mk
-include build/scripts/codegen.mk
-include build/scripts/constants.mk
-include build/scripts/devtools.mk
-include build/scripts/linting.mk
-include build/scripts/protobuf.mk
-include build/scripts/release.mk
-include build/scripts/testing.mk
+include scripts/build/build.mk
+include scripts/build/codegen.mk
+include scripts/build/constants.mk
+include scripts/build/devtools.mk
+include scripts/build/linting.mk
+include scripts/build/protobuf.mk
+include scripts/build/release.mk
+include scripts/build/testing.mk
 include contracts/Makefile
 include kurtosis/Makefile
-include build/scripts/help.mk
+include scripts/build/help.mk
 include testing/forge-script/Makefile
 
 # Specify the default target if none is provided

mod/async/pkg/broker/broker.go → async/broker/broker.go

@@ -24,7 +24,7 @@ import (
 	"context"
 	"time"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
+	"github.com/berachain/beacon-kit/primitives/async"
 )
 
 // Broker is the unique publisher for broadcasting all events corresponding

mod/async/pkg/broker/errors.go → async/broker/errors.go

@@ -21,7 +21,7 @@
 package broker
 
 import (
-	"github.com/berachain/beacon-kit/mod/errors"
+	"github.com/berachain/beacon-kit/errors"
 )
 
 // errTimeout is the error returned when a dispatch operation timed out.

mod/async/pkg/dispatcher/dispatcher.go → async/dispatcher/dispatcher.go

@@ -23,9 +23,9 @@ package dispatcher
 import (
 	"context"
 
-	"github.com/berachain/beacon-kit/mod/async/pkg/types"
-	"github.com/berachain/beacon-kit/mod/log"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
+	"github.com/berachain/beacon-kit/async/types"
+	"github.com/berachain/beacon-kit/log"
+	"github.com/berachain/beacon-kit/primitives/async"
 )
 
 var _ types.Dispatcher = (*Dispatcher)(nil)

mod/async/pkg/dispatcher/errors.go → async/dispatcher/errors.go

@@ -21,8 +21,8 @@
 package dispatcher
 
 import (
-	"github.com/berachain/beacon-kit/mod/errors"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
+	"github.com/berachain/beacon-kit/errors"
+	"github.com/berachain/beacon-kit/primitives/async"
 )
 
 //nolint:gochecknoglobals // errors

mod/async/pkg/dispatcher/options.go → async/dispatcher/options.go

@@ -21,9 +21,9 @@
 package dispatcher
 
 import (
-	"github.com/berachain/beacon-kit/mod/async/pkg/broker"
-	"github.com/berachain/beacon-kit/mod/async/pkg/types"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
+	"github.com/berachain/beacon-kit/async/broker"
+	"github.com/berachain/beacon-kit/async/types"
+	"github.com/berachain/beacon-kit/primitives/async"
 )
 
 // Opt is a type that defines a function that modifies NodeBuilder.

mod/async/pkg/types/broker.go → async/types/broker.go

@@ -23,7 +23,7 @@ package types
 import (
 	"context"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
+	"github.com/berachain/beacon-kit/primitives/async"
 )
 
 // Broker is the unique publisher for broadcasting all events corresponding

mod/async/pkg/types/dispatcher.go → async/types/dispatcher.go

@@ -23,7 +23,7 @@ package types
 import (
 	"context"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
+	"github.com/berachain/beacon-kit/primitives/async"
 )
 
 // Dispatcher is the maximal interface for a dispatcher that facilitates the

mod/beacon/blockchain/errors.go → beacon/blockchain/errors.go

@@ -20,7 +20,7 @@
 
 package blockchain
 
-import "github.com/berachain/beacon-kit/mod/errors"
+import "github.com/berachain/beacon-kit/errors"
 
 var (
 	// ErrNilBlk is an error for when the beacon block is nil.

mod/beacon/blockchain/execution_engine.go → beacon/blockchain/execution_engine.go

@@ -24,9 +24,9 @@ import (
 	"context"
 	"time"
 
-	payloadtime "github.com/berachain/beacon-kit/mod/beacon/payload-time"
-	"github.com/berachain/beacon-kit/mod/config/pkg/spec"
-	engineprimitives "github.com/berachain/beacon-kit/mod/engine-primitives/pkg/engine-primitives"
+	payloadtime "github.com/berachain/beacon-kit/beacon/payload-time"
+	"github.com/berachain/beacon-kit/config/spec"
+	engineprimitives "github.com/berachain/beacon-kit/engine-primitives/engine-primitives"
 )
 
 // sendPostBlockFCU sends a forkchoice update to the execution client.

mod/beacon/blockchain/metrics.go → beacon/blockchain/metrics.go

@@ -23,7 +23,7 @@ package blockchain
 import (
 	"time"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
+	"github.com/berachain/beacon-kit/primitives/math"
 )
 
 // chainMetrics is a struct that contains metrics for the chain.

mod/beacon/blockchain/payload.go → beacon/blockchain/payload.go

@@ -23,7 +23,7 @@ package blockchain
 import (
 	"context"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
+	"github.com/berachain/beacon-kit/primitives/math"
 )
 
 // forceStartupHead sends a force head FCU to the execution client.

mod/beacon/blockchain/process.go → beacon/blockchain/process.go

@@ -24,8 +24,8 @@ import (
 	"context"
 	"time"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
+	"github.com/berachain/beacon-kit/primitives/async"
+	"github.com/berachain/beacon-kit/primitives/transition"
 )
 
 // ProcessGenesisData processes the genesis state and initializes the beacon

mod/beacon/blockchain/receive.go → beacon/blockchain/receive.go

@@ -24,10 +24,10 @@ import (
 	"context"
 	"time"
 
-	payloadtime "github.com/berachain/beacon-kit/mod/beacon/payload-time"
-	engineerrors "github.com/berachain/beacon-kit/mod/engine-primitives/pkg/errors"
-	"github.com/berachain/beacon-kit/mod/errors"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
+	payloadtime "github.com/berachain/beacon-kit/beacon/payload-time"
+	engineerrors "github.com/berachain/beacon-kit/engine-primitives/errors"
+	"github.com/berachain/beacon-kit/errors"
+	"github.com/berachain/beacon-kit/primitives/transition"
 )
 
 // VerifyIncomingBlock verifies the state root of an incoming block

mod/beacon/blockchain/service.go → beacon/blockchain/service.go

@@ -24,11 +24,11 @@ import (
 	"context"
 	"sync"
 
-	asynctypes "github.com/berachain/beacon-kit/mod/async/pkg/types"
-	"github.com/berachain/beacon-kit/mod/log"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
+	asynctypes "github.com/berachain/beacon-kit/async/types"
+	"github.com/berachain/beacon-kit/log"
+	"github.com/berachain/beacon-kit/primitives/async"
+	"github.com/berachain/beacon-kit/primitives/common"
+	"github.com/berachain/beacon-kit/primitives/transition"
 )
 
 // Service is the blockchain service.

mod/beacon/blockchain/types.go → beacon/blockchain/types.go

@@ -24,11 +24,11 @@ import (
 	"context"
 	"time"
 
-	engineprimitives "github.com/berachain/beacon-kit/mod/engine-primitives/pkg/engine-primitives"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/constraints"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
+	engineprimitives "github.com/berachain/beacon-kit/engine-primitives/engine-primitives"
+	"github.com/berachain/beacon-kit/primitives/common"
+	"github.com/berachain/beacon-kit/primitives/constraints"
+	"github.com/berachain/beacon-kit/primitives/math"
+	"github.com/berachain/beacon-kit/primitives/transition"
 )
 
 // AvailabilityStore interface is responsible for validating and storing

mod/beacon/payload-time/time.go → beacon/payload-time/time.go

@@ -24,7 +24,7 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
+	"github.com/berachain/beacon-kit/primitives/math"
 )
 
 // ErrTooFarInTheFuture is returned when the payload timestamp

mod/beacon/payload-time/time_test.go → beacon/payload-time/time_test.go

@@ -24,8 +24,8 @@ import (
 	"testing"
 	"time"
 
-	payloadtime "github.com/berachain/beacon-kit/mod/beacon/payload-time"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
+	payloadtime "github.com/berachain/beacon-kit/beacon/payload-time"
+	"github.com/berachain/beacon-kit/primitives/math"
 	"github.com/stretchr/testify/require"
 )
 

mod/beacon/validator/block_builder.go → beacon/validator/block_builder.go

@@ -25,15 +25,15 @@ import (
 	"fmt"
 	"time"
 
-	payloadtime "github.com/berachain/beacon-kit/mod/beacon/payload-time"
-	"github.com/berachain/beacon-kit/mod/config/pkg/spec"
-	engineprimitives "github.com/berachain/beacon-kit/mod/engine-primitives/pkg/engine-primitives"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/bytes"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/crypto"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/version"
+	payloadtime "github.com/berachain/beacon-kit/beacon/payload-time"
+	"github.com/berachain/beacon-kit/config/spec"
+	engineprimitives "github.com/berachain/beacon-kit/engine-primitives/engine-primitives"
+	"github.com/berachain/beacon-kit/primitives/bytes"
+	"github.com/berachain/beacon-kit/primitives/common"
+	"github.com/berachain/beacon-kit/primitives/crypto"
+	"github.com/berachain/beacon-kit/primitives/math"
+	"github.com/berachain/beacon-kit/primitives/transition"
+	"github.com/berachain/beacon-kit/primitives/version"
 	"golang.org/x/sync/errgroup"
 )
 

mod/beacon/validator/errors.go → beacon/validator/errors.go

@@ -20,7 +20,7 @@
 
 package validator
 
-import "github.com/berachain/beacon-kit/mod/errors"
+import "github.com/berachain/beacon-kit/errors"
 
 var (
 

mod/beacon/validator/metrics.go → beacon/validator/metrics.go

@@ -23,7 +23,7 @@ package validator
 import (
 	"time"
 
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
+	"github.com/berachain/beacon-kit/primitives/math"
 )
 
 // validatorMetrics is a struct that contains metrics for the chain.

mod/beacon/validator/service.go → beacon/validator/service.go

@@ -23,12 +23,12 @@ package validator
 import (
 	"context"
 
-	asynctypes "github.com/berachain/beacon-kit/mod/async/pkg/types"
-	"github.com/berachain/beacon-kit/mod/log"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/crypto"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
+	asynctypes "github.com/berachain/beacon-kit/async/types"
+	"github.com/berachain/beacon-kit/log"
+	"github.com/berachain/beacon-kit/primitives/async"
+	"github.com/berachain/beacon-kit/primitives/common"
+	"github.com/berachain/beacon-kit/primitives/crypto"
+	"github.com/berachain/beacon-kit/primitives/transition"
 )
 
 // Service is responsible for building beacon blocks and sidecars.

mod/beacon/validator/types.go → beacon/validator/types.go

@@ -24,13 +24,13 @@ import (
 	"context"
 	"time"
 
-	engineprimitives "github.com/berachain/beacon-kit/mod/engine-primitives/pkg/engine-primitives"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/constraints"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/crypto"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/eip4844"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
-	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
+	engineprimitives "github.com/berachain/beacon-kit/engine-primitives/engine-primitives"
+	"github.com/berachain/beacon-kit/primitives/common"
+	"github.com/berachain/beacon-kit/primitives/constraints"
+	"github.com/berachain/beacon-kit/primitives/crypto"
+	"github.com/berachain/beacon-kit/primitives/eip4844"
+	"github.com/berachain/beacon-kit/primitives/math"
+	"github.com/berachain/beacon-kit/primitives/transition"
 )
 
 // BeaconBlock represents a beacon block interface.