refactor(bank): add go module (cosmos#18279)

notional-labs · Oct 27, 2023 · 21e69ba · 21e69ba
1 parent ab2a725
commit 21e69ba
Show file tree

Hide file tree

Showing 214 changed files with 2,367 additions and 828 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1129,3 +1129,34 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         with:
           projectBaseDir: x/authz/
+
+  test-x-bank:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: "1.21"
+          check-latest: true
+          cache: true
+          cache-dependency-path: x/bank/go.sum
+      - uses: technote-space/[email protected]
+        id: git_diff
+        with:
+          PATTERNS: |
+            x/bank/**/*.go
+            x/bank/go.mod
+            x/bank/go.sum
+      - name: tests
+        if: env.GIT_DIFF
+        run: |
+          cd x/bank
+          go test -mod=readonly -timeout 30m -coverprofile=coverage.out -covermode=atomic -tags='norace ledger test_ledger_mock rocksdb_build' ./...
+      - name: sonarcloud
+        if: ${{ env.GIT_DIFF && !github.event.pull_request.draft && env.SONAR_TOKEN != null }}
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: x/bank/
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -58,20 +58,29 @@ Most of Cosmos SDK modules have migrated to [collections](https://docs.cosmos.ne
 Many functions have been removed due to this changes as the API can be smaller thanks to collections.
 For modules that have migrated, verify you are checking against `collections.ErrNotFound` when applicable.
 
-#### `x/group`
+#### `x/authz`
 
-Group was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/group`
+Authz was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/authz`
 
-#### `x/gov`
+#### `x/bank`
 
-Gov was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/gov`
+Bank was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/bank`
 
 #### `x/distribution`
 
 Distribution was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/distribution`
 
 The existing chains using x/distribution module needs to add the new x/protocolpool module.
 
+#### `x/group`
+
+Group was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/group`
+
+#### `x/gov`
+
+Gov was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/gov`
+
+
 #### `x/slashing`
 
 Slashing was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/slashing`
@@ -80,9 +89,6 @@ Slashing was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/sl
 
 Staking was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/staking`
 
-#### `x/authz`
-
-Authz was spun out into its own `go.mod`. To import it use `cosmossdk.io/x/authz`
 
 #### `x/params`
 

diff --git a/api/cosmos/bank/module/v1/module.pulsar.go b/api/cosmos/bank/module/v1/module.pulsar.go
diff --git a/baseapp/block_gas_test.go b/baseapp/block_gas_test.go
@@ -14,6 +14,8 @@ import (
 	"cosmossdk.io/log"
 	sdkmath "cosmossdk.io/math"
 	store "cosmossdk.io/store/types"
+	bankkeeper "cosmossdk.io/x/bank/keeper"
+	banktypes "cosmossdk.io/x/bank/types"
 
 	baseapptestutil "github.com/cosmos/cosmos-sdk/baseapp/testutil"
 	"github.com/cosmos/cosmos-sdk/client"
@@ -31,8 +33,6 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/tx/signing"
 	authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
 	xauthsigning "github.com/cosmos/cosmos-sdk/x/auth/signing"
-	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	minttypes "github.com/cosmos/cosmos-sdk/x/mint/types"
 )
 

diff --git a/baseapp/utils_test.go b/baseapp/utils_test.go
@@ -26,6 +26,8 @@ import (
 	errorsmod "cosmossdk.io/errors"
 	"cosmossdk.io/math"
 	storetypes "cosmossdk.io/store/types"
+	_ "cosmossdk.io/x/bank"
+	banktypes "cosmossdk.io/x/bank/types"
 	_ "cosmossdk.io/x/staking"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
@@ -46,8 +48,6 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/auth/signing"
 	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
-	_ "github.com/cosmos/cosmos-sdk/x/bank"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	_ "github.com/cosmos/cosmos-sdk/x/consensus"
 	_ "github.com/cosmos/cosmos-sdk/x/mint"
 )

diff --git a/client/fuzz_test.go b/client/fuzz_test.go
@@ -7,9 +7,10 @@ import (
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/metadata"
 
+	"cosmossdk.io/x/bank/types"
+
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 type fuzzSuite struct {

diff --git a/client/grpc_query_test.go b/client/grpc_query_test.go
@@ -14,6 +14,8 @@ import (
 	"cosmossdk.io/depinject"
 	"cosmossdk.io/log"
 	"cosmossdk.io/math"
+	bankkeeper "cosmossdk.io/x/bank/keeper"
+	"cosmossdk.io/x/bank/types"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/codec"
@@ -25,8 +27,6 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth/testutil"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
-	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
-	"github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 type IntegrationTestSuite struct {

diff --git a/client/rpc/rpc_test.go b/client/rpc/rpc_test.go
@@ -11,11 +11,12 @@ import (
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/metadata"
 
+	banktypes "cosmossdk.io/x/bank/types"
+
 	"github.com/cosmos/cosmos-sdk/testutil/network"
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	"github.com/cosmos/cosmos-sdk/types/address"
 	grpctypes "github.com/cosmos/cosmos-sdk/types/grpc"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 type IntegrationTestSuite struct {

diff --git a/client/tx/aux_builder_test.go b/client/tx/aux_builder_test.go
@@ -5,6 +5,8 @@ import (
 
 	"github.com/stretchr/testify/require"
 
+	"cosmossdk.io/x/bank"
+
 	"github.com/cosmos/cosmos-sdk/client/tx"
 	"github.com/cosmos/cosmos-sdk/codec"
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
@@ -14,7 +16,6 @@ import (
 	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
 	typestx "github.com/cosmos/cosmos-sdk/types/tx"
 	"github.com/cosmos/cosmos-sdk/types/tx/signing"
-	"github.com/cosmos/cosmos-sdk/x/bank"
 )
 
 func TestAuxTxBuilder(t *testing.T) {

diff --git a/client/tx/legacy_test.go b/client/tx/legacy_test.go
@@ -1,9 +1,10 @@
 package tx_test
 
 import (
+	banktypes "cosmossdk.io/x/bank/types"
+
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	"github.com/cosmos/cosmos-sdk/types"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 const (

diff --git a/client/tx/tx_test.go b/client/tx/tx_test.go
@@ -9,6 +9,8 @@ import (
 	"github.com/stretchr/testify/require"
 	"google.golang.org/grpc"
 
+	banktypes "cosmossdk.io/x/bank/types"
+
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/tx"
 	"github.com/cosmos/cosmos-sdk/codec"
@@ -24,7 +26,6 @@ import (
 	ante "github.com/cosmos/cosmos-sdk/x/auth/ante"
 	"github.com/cosmos/cosmos-sdk/x/auth/signing"
 	authtx "github.com/cosmos/cosmos-sdk/x/auth/tx"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 func newTestTxConfig() (client.TxConfig, codec.Codec) {

diff --git a/client/v2/autocli/common_test.go b/client/v2/autocli/common_test.go
@@ -16,15 +16,15 @@ import (
 	reflectionv2alpha1 "cosmossdk.io/api/cosmos/base/reflection/v2alpha1"
 	"cosmossdk.io/client/v2/autocli/flag"
 	"cosmossdk.io/client/v2/internal/testpb"
+	"cosmossdk.io/x/bank"
+	banktypes "cosmossdk.io/x/bank/types"
 
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	addresscodec "github.com/cosmos/cosmos-sdk/codec/address"
 	sdkkeyring "github.com/cosmos/cosmos-sdk/crypto/keyring"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
-	"github.com/cosmos/cosmos-sdk/x/bank"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 type fixture struct {

diff --git a/client/v2/go.mod b/client/v2/go.mod
@@ -6,6 +6,7 @@ require (
 	cosmossdk.io/api v0.7.2
 	cosmossdk.io/core v0.12.0
 	cosmossdk.io/depinject v1.0.0-alpha.4
+	cosmossdk.io/x/bank v0.0.0-00010101000000-000000000000
 	cosmossdk.io/x/tx v0.11.0
 	github.com/cockroachdb/errors v1.11.1
 	github.com/cosmos/cosmos-proto v1.0.0-beta.3
@@ -158,10 +159,10 @@ require (
 
 replace github.com/cosmos/cosmos-sdk => ./../../
 
-replace cosmossdk.io/x/gov => ./../../x/gov
-
-replace cosmossdk.io/x/distribution => ./../../x/distribution
-
-replace cosmossdk.io/x/slashing => ./../../x/slashing
-
-replace cosmossdk.io/x/staking => ./../../x/staking
+replace (
+	cosmossdk.io/x/bank => ./../../x/bank
+	cosmossdk.io/x/distribution => ./../../x/distribution
+	cosmossdk.io/x/gov => ./../../x/gov
+	cosmossdk.io/x/slashing => ./../../x/slashing
+	cosmossdk.io/x/staking => ./../../x/staking
+)
diff --git a/codec/bench_test.go b/codec/bench_test.go
@@ -8,12 +8,12 @@ import (
 	"google.golang.org/protobuf/types/dynamicpb"
 
 	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
+	banktypes "cosmossdk.io/x/bank/types"
 
 	codectestutil "github.com/cosmos/cosmos-sdk/codec/testutil"
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 type bankSendWrapper struct {

diff --git a/codec/proto_codec_test.go b/codec/proto_codec_test.go
@@ -16,13 +16,13 @@ import (
 	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
 	basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
 	sdkmath "cosmossdk.io/math"
+	banktypes "cosmossdk.io/x/bank/types"
 	"cosmossdk.io/x/tx/signing"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/codec/types"
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
 func createTestInterfaceRegistry() types.InterfaceRegistry {

diff --git a/contrib/images/simd-env/Dockerfile b/contrib/images/simd-env/Dockerfile
@@ -19,6 +19,7 @@ COPY x/distribution/go.mod x/distribution/go.sum /work/x/distribution/
 COPY x/slashing/go.mod x/slashing/go.sum /work/x/slashing/
 COPY x/staking/go.mod x/staking/go.sum /work/x/staking/
 COPY x/authz/go.mod x/authz/go.sum /work/x/authz/
+COPY x/bank/go.mod x/bank/go.sum /work/x/bank/
 RUN go mod download
 
 COPY ./ /work

diff --git a/depinject/README.md b/depinject/README.md
@@ -75,7 +75,7 @@ Provider functions serve as the basis for the dependency tree. They are analysed
 
 `depinject` supports the use of interface types as inputs to provider functions, which helps decouple dependencies between modules. This approach is particularly useful for managing complex systems with multiple modules, such as the Cosmos SDK, where dependencies need to be flexible and maintainable.
 
-For example, `x/bank` expects an [AccountKeeper](https://pkg.go.dev/github.com/cosmos/cosmos-sdk/x/bank/types#AccountKeeper) interface as [input to ProvideModule](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/bank/module.go#L208-L260). `SimApp` uses the implementation in `x/auth`, but the modular design allows for easy changes to the implementation if needed.
+For example, `x/bank` expects an [AccountKeeper](https://pkg.go.dev/cosmossdk.io/x/bank/types#AccountKeeper) interface as [input to ProvideModule](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/bank/module.go#L208-L260). `SimApp` uses the implementation in `x/auth`, but the modular design allows for easy changes to the implementation if needed.
 
 Consider the following example:
 

diff --git a/docs/architecture/adr-057-app-wiring.md b/docs/architecture/adr-057-app-wiring.md
@@ -229,7 +229,7 @@ import (
 	// Each go package which registers a module must be imported just for side-effects
 	// so that module implementations are registered.
 	_ "github.com/cosmos/cosmos-sdk/x/auth/module"
-	_ "github.com/cosmos/cosmos-sdk/x/bank/module"
+	_ "cosmossdk.io/x/bank/module"
 	_ "cosmossdk.io/x/staking/module"
 	"github.com/cosmos/cosmos-sdk/core/app"
 )

diff --git a/docs/user/run-node/02-interact-node.md b/docs/user/run-node/02-interact-node.md
@@ -131,7 +131,7 @@ import (
 
     "github.com/cosmos/cosmos-sdk/codec"
     sdk "github.com/cosmos/cosmos-sdk/types"
-    banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+    banktypes "cosmossdk.io/x/bank/types"
 )
 
 func queryState() error {
@@ -194,7 +194,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	grpctypes "github.com/cosmos/cosmos-sdk/types/grpc"
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	banktypes "cosmossdk.io/x/bank/types"
 )
 
 func queryState() error {

diff --git a/docs/user/run-node/03-txs.md b/docs/user/run-node/03-txs.md
@@ -152,7 +152,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/client/tx_config.go#L3
 
 ```go
 import (
-	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	banktypes "cosmossdk.io/x/bank/types"
 )
 
 func sendTx() error {

diff --git a/go.mod b/go.mod
@@ -11,6 +11,7 @@ require (
 	cosmossdk.io/log v1.2.1
 	cosmossdk.io/math v1.1.3-rc.1
 	cosmossdk.io/store v1.0.0-rc.0
+	cosmossdk.io/x/bank v0.0.0-00010101000000-000000000000
 	cosmossdk.io/x/distribution v0.0.0-20230925135524-a1bc045b3190
 	cosmossdk.io/x/gov v0.0.0-20230925135524-a1bc045b3190
 	cosmossdk.io/x/staking v0.0.0-00010101000000-000000000000
@@ -169,15 +170,14 @@ require (
 // )
 // TODO remove after all modules have their own go.mods
 replace (
+	cosmossdk.io/x/bank => ./x/bank
+	cosmossdk.io/x/distribution => ./x/distribution
+	cosmossdk.io/x/gov => ./x/gov
 	cosmossdk.io/x/protocolpool => ./x/protocolpool
 	cosmossdk.io/x/slashing => ./x/slashing
 	cosmossdk.io/x/staking => ./x/staking
 )
 
-replace cosmossdk.io/x/gov => ./x/gov
-
-replace cosmossdk.io/x/distribution => ./x/distribution
-
 // Below are the long-lived replace of the Cosmos SDK
 replace (
 	// use cosmos fork of keyring

diff --git a/go.work.example b/go.work.example
@@ -22,6 +22,7 @@ use (
 	./tools/hubl
 	./x/accounts
 	./x/authz
+	./x/bank
 	./x/circuit
 	./x/distribution
 	./x/evidence