style!: Refactor codebase to use proper Interface prefixes

CHANGELOG.md

@@ -37,6 +37,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+* (improvement) [#13254](https://github.com/cosmos/cosmos-sdk/pull/13268) Change `I` suffix to prefix in the relevant Golang interfaces
+
 ### Features
 
 * (cli) [#13207](https://github.com/cosmos/cosmos-sdk/pull/13207) Reduce user's password prompts when calling keyring `List()` function
@@ -135,7 +137,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (x/genutil)[#12956](https://github.com/cosmos/cosmos-sdk/pull/12956) `genutil.AppModuleBasic` has a new attribute: genesis transaction validation function. The existing validation logic is implemented in `genutiltypes.DefaultMessageValidator`. Use `genutil.NewAppModuleBasic` to create a new genutil Module Basic.
 * (codec) [#12964](https://github.com/cosmos/cosmos-sdk/pull/12964) `ProtoCodec.MarshalInterface` now returns an error when serializing unregistered types and a subsequent `ProtoCodec.UnmarshalInterface` would fail.
 * (x/staking) [#12973](https://github.com/cosmos/cosmos-sdk/pull/12973) Removed `stakingkeeper.RandomValidator`. Use `testutil.RandSliceElem(r, sk.GetAllValidators(ctx))` instead.
-* (x/gov) [13160](https://github.com/cosmos/cosmos-sdk/pull/13160) Remove custom marshaling of proposl and voteoption. 
+* (x/gov) [13160](https://github.com/cosmos/cosmos-sdk/pull/13160) Remove custom marshaling of proposl and voteoption.
 
 ### CLI Breaking Changes
 
@@ -1276,7 +1278,7 @@ sure you are aware of any relevant breaking changes.
     client transaction signing
         * added `overwriteSig` argument to `x/auth/client.SignTx` and `client/tx.Sign` functions.
         * removed `x/auth/tx.go:wrapper.GetSignatures`. The `wrapper` provides `TxBuilder` functionality, and it's a private
-      structure. That function was not used at all and it's not exposed through the `TxBuilder` interface.
+    structure. That function was not used at all and it's not exposed through the `TxBuilder` interface.
     * (x/bank) [#7327](https://github.com/cosmos/cosmos-sdk/pull/7327) AddCoins and SubtractCoins no longer return a resultingValue and will only return an error.
     * (x/capability) [#7918](https://github.com/cosmos/cosmos-sdk/pull/7918) Add x/capability safety checks:
         * All outward facing APIs will now check that capability is not nil and name is not empty before performing any state-machine changes
@@ -1651,11 +1653,11 @@ sure you are aware of any relevant breaking changes.
 * (baseapp/types) [#5421](https://github.com/cosmos/cosmos-sdk/pull/5421) The `Error` interface (`types/errors.go`)
   has been removed in favor of the concrete type defined in `types/errors/` which implements the standard `error` interface.
     * As a result, the `Handler` and `Querier` implementations now return a standard `error`.
-  Within `BaseApp`, `runTx` now returns a `(GasInfo, *Result, error)`tuple and`runMsgs`returns a `(_Result, error)`tuple. A reference to a`Result`is now used to indicate success whereas an error signals an invalid message or failed message execution. As a result, the fields`Code`, `Codespace`, `GasWanted`, and `GasUsed`have been removed the`Result`type. The latter two fields are now found in the`GasInfo` type which is always returned regardless of execution outcome.
-  _ Note to developers: Since all handlers and queriers must now return a standard `error`, the `types/errors/`
-  package contains all the relevant and pre-registered errors that you typically work with. A typical
-  error returned will look like `sdkerrors.Wrap(sdkerrors.ErrUnknownRequest, "...")`. You can retrieve
-  relevant ABCI information from the error via `ABCIInfo`.
+    Within `BaseApp`, `runTx` now returns a `(GasInfo, *Result, error)`tuple and`runMsgs`returns a `(_Result, error)`tuple. A reference to a`Result`is now used to indicate success whereas an error signals an invalid message or failed message execution. As a result, the fields`Code`, `Codespace`, `GasWanted`, and `GasUsed`have been removed the`Result`type. The latter two fields are now found in the`GasInfo` type which is always returned regardless of execution outcome.
+    \_ Note to developers: Since all handlers and queriers must now return a standard `error`, the `types/errors/`
+    package contains all the relevant and pre-registered errors that you typically work with. A typical
+    error returned will look like `sdkerrors.Wrap(sdkerrors.ErrUnknownRequest, "...")`. You can retrieve
+    relevant ABCI information from the error via `ABCIInfo`.
 * (client) [#5442](https://github.com/cosmos/cosmos-sdk/pull/5442) Remove client/alias.go as it's not necessary and
   components can be imported directly from the packages.
 * (store) [#4748](https://github.com/cosmos/cosmos-sdk/pull/4748) The `CommitMultiStore` interface

client/account_retriever.go

@@ -5,7 +5,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-// Account defines a read-only version of the auth module's AccountI.
+// Account defines a read-only version of the auth module's IAccount.
 type Account interface {
 	GetAddress() sdk.AccAddress
 	GetPubKey() cryptotypes.PubKey // can return nil.

codec/types/compat_test.go

@@ -83,8 +83,8 @@ func (s *Suite) TestAminoJSON() {
 }
 
 func (s *Suite) TestNested() {
-	s.cdc.RegisterInterface((*testdata.HasAnimalI)(nil), nil)
-	s.cdc.RegisterInterface((*testdata.HasHasAnimalI)(nil), nil)
+	s.cdc.RegisterInterface((*testdata.IHasAnimal)(nil), nil)
+	s.cdc.RegisterInterface((*testdata.IHasHasAnimal)(nil), nil)
 	s.cdc.RegisterConcrete(&testdata.HasAnimal{}, "testdata/HasAnimal", nil)
 	s.cdc.RegisterConcrete(&testdata.HasHasAnimal{}, "testdata/HasHasAnimal", nil)
 	s.cdc.RegisterConcrete(&testdata.HasHasHasAnimal{}, "testdata/HasHasHasAnimal", nil)

codec/types/types_test.go

@@ -27,7 +27,7 @@ func TestAnyPackUnpack(t *testing.T) {
 	require.Equal(t, spot, animal)
 }
 
-type TestI interface {
+type ITest interface {
 	DoSomething()
 }
 
@@ -50,7 +50,7 @@ func (dog FakeDog) Greet() string           { return "fakedog" }
 func TestRegister(t *testing.T) {
 	registry := types.NewInterfaceRegistry()
 	registry.RegisterInterface("Animal", (*testdata.Animal)(nil))
-	registry.RegisterInterface("TestI", (*TestI)(nil))
+	registry.RegisterInterface("ITest", (*ITest)(nil))
 
 	// Happy path.
 	require.NotPanics(t, func() {
@@ -59,12 +59,12 @@ func TestRegister(t *testing.T) {
 
 	// testdata.Dog doesn't implement TestI
 	require.Panics(t, func() {
-		registry.RegisterImplementations((*TestI)(nil), &testdata.Dog{})
+		registry.RegisterImplementations((*ITest)(nil), &testdata.Dog{})
 	})
 
 	// nil proto message
 	require.Panics(t, func() {
-		registry.RegisterImplementations((*TestI)(nil), nil)
+		registry.RegisterImplementations((*ITest)(nil), nil)
 	})
 
 	// Not an interface.

cosmovisor/args_test.go

@@ -700,7 +700,7 @@ func BenchmarkDetailString(b *testing.B) {
 		PollInterval:          450 * time.Second,
 		PreupgradeMaxRetries:  1e7,
 	}
-	
+
 	b.ReportAllocs()
 	b.ResetTimer()
 

docs/core/encoding.md

@@ -86,8 +86,8 @@ init() {
 }
 ```
 
-This will allow the `x/authz` module to properly serialize and de-serializes `MsgExec` instances using Amino, 
-which is required when signing this kind of messages using a Ledger. 
+This will allow the `x/authz` module to properly serialize and de-serializes `MsgExec` instances using Amino,
+which is required when signing this kind of messages using a Ledger.
 
 ### Gogoproto
 
@@ -146,7 +146,7 @@ In [ADR-019](../architecture/adr-019-protobuf-state-encoding.md), it has been de
 message Profile {
   // account is the account associated to a profile.
   google.protobuf.Any account = 1 [
-    (cosmos_proto.accepts_interface) = "AccountI"; // Asserts that this field only accepts Go types implementing `AccountI`. It is purely informational for now.
+    (cosmos_proto.accepts_interface) = "IAccount"; // Asserts that this field only accepts Go types implementing `AccountI`. It is purely informational for now.
   ];
   // bio is a short description of the account.
   string bio = 4;
@@ -156,7 +156,7 @@ message Profile {
 To add an account inside a profile, we need to "pack" it inside an `Any` first, using `codectypes.NewAnyWithValue`:
 
 ```go
-var myAccount AccountI
+var myAccount IAccount
 myAccount = ... // Can be a BaseAccount, a ContinuousVestingAccount or any struct implementing `AccountI`
 
 // Pack the account into an Any
@@ -191,15 +191,15 @@ fmt.Printf("%T\n", myProfile.Account)                  // Prints "Any"
 fmt.Printf("%T\n", myProfile.Account.GetCachedValue()) // Prints "BaseAccount", "ContinuousVestingAccount" or whatever was initially packed in the Any.
 
 // Get the address of the accountt.
-accAddr := myProfile.Account.GetCachedValue().(AccountI).GetAddress()
+accAddr := myProfile.Account.GetCachedValue().(IAccount).GetAddress()
 ```
 
 It is important to note that for `GetCachedValue()` to work, `Profile` (and any other structs embedding `Profile`) must implement the `UnpackInterfaces` method:
 
 ```go
 func (p *Profile) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error {
   if p.Account != nil {
-    var account AccountI
+    var account IAccount
     return unpacker.UnpackAny(p.Account, &account)
   }
 

orm/internal/testutil/testutil.go

@@ -169,7 +169,6 @@ func (k TestKeyCodec) Draw(t *rapid.T, id string) []protoreflect.Value {
 	n := len(k.KeySpecs)
 	keyValues := make([]protoreflect.Value, n)
 	for i, k := range k.KeySpecs {
-
 		keyValues[i] = protoreflect.ValueOf(k.Gen.Draw(t, fmt.Sprintf("%s[%d]", id, i)))
 	}
 	return keyValues

proto/cosmos/auth/v1beta1/auth.proto

@@ -15,7 +15,7 @@ message BaseAccount {
   option (gogoproto.goproto_stringer) = false;
   option (gogoproto.equal)            = false;
 
-  option (cosmos_proto.implements_interface) = "AccountI";
+  option (cosmos_proto.implements_interface) = "IAccount";
 
   string              address        = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
   google.protobuf.Any pub_key        = 2 [(gogoproto.jsontag) = "public_key,omitempty"];
@@ -27,7 +27,7 @@ message BaseAccount {
 message ModuleAccount {
   option (gogoproto.goproto_getters)         = false;
   option (gogoproto.goproto_stringer)        = false;
-  option (cosmos_proto.implements_interface) = "ModuleAccountI";
+  option (cosmos_proto.implements_interface) = "IModuleAccount";
 
   BaseAccount     base_account = 1 [(gogoproto.embed) = true];
   string          name         = 2;

proto/cosmos/auth/v1beta1/query.proto

@@ -85,7 +85,7 @@ message QueryAccountsRequest {
 // Since: cosmos-sdk 0.43
 message QueryAccountsResponse {
   // accounts are the existing accounts
-  repeated google.protobuf.Any accounts = 1 [(cosmos_proto.accepts_interface) = "AccountI"];
+  repeated google.protobuf.Any accounts = 1 [(cosmos_proto.accepts_interface) = "IAccount"];
 
   // pagination defines the pagination in the response.
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
@@ -114,7 +114,7 @@ message QueryParamsResponse {
 // QueryAccountResponse is the response type for the Query/Account RPC method.
 message QueryAccountResponse {
   // account defines the account of the corresponding address.
-  google.protobuf.Any account = 1 [(cosmos_proto.accepts_interface) = "AccountI"];
+  google.protobuf.Any account = 1 [(cosmos_proto.accepts_interface) = "IAccount"];
 }
 
 // QueryParamsRequest is the request type for the Query/Params RPC method.
@@ -124,7 +124,7 @@ message QueryParamsRequest {}
 //
 // Since: cosmos-sdk 0.46
 message QueryModuleAccountsResponse {
-  repeated google.protobuf.Any accounts = 1 [(cosmos_proto.accepts_interface) = "ModuleAccountI"];
+  repeated google.protobuf.Any accounts = 1 [(cosmos_proto.accepts_interface) = "IModuleAccount"];
 }
 
 // Bech32PrefixRequest is the request type for Bech32Prefix rpc method.

proto/cosmos/bank/v1beta1/bank.proto

@@ -60,7 +60,7 @@ message Supply {
   option (gogoproto.equal)           = true;
   option (gogoproto.goproto_getters) = false;
 
-  option (cosmos_proto.implements_interface) = "SupplyI";
+  option (cosmos_proto.implements_interface) = "ISupply";
 
   repeated cosmos.base.v1beta1.Coin total = 1
       [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];

proto/cosmos/feegrant/v1beta1/feegrant.proto

@@ -14,7 +14,7 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/feegrant";
 // BasicAllowance implements Allowance with a one-time grant of coins
 // that optionally expires. The grantee can use up to SpendLimit to cover fees.
 message BasicAllowance {
-  option (cosmos_proto.implements_interface) = "FeeAllowanceI";
+  option (cosmos_proto.implements_interface) = "IFeeAllowance";
 
   // spend_limit specifies the maximum amount of coins that can be spent
   // by this allowance and will be updated as coins are spent. If it is
@@ -29,7 +29,7 @@ message BasicAllowance {
 // PeriodicAllowance extends Allowance to allow for both a maximum cap,
 // as well as a limit per time period.
 message PeriodicAllowance {
-  option (cosmos_proto.implements_interface) = "FeeAllowanceI";
+  option (cosmos_proto.implements_interface) = "IFeeAllowance";
 
   // basic specifies a struct of `BasicAllowance`
   BasicAllowance basic = 1 [(gogoproto.nullable) = false];
@@ -56,10 +56,10 @@ message PeriodicAllowance {
 // AllowedMsgAllowance creates allowance only for specified message types.
 message AllowedMsgAllowance {
   option (gogoproto.goproto_getters)         = false;
-  option (cosmos_proto.implements_interface) = "FeeAllowanceI";
+  option (cosmos_proto.implements_interface) = "IFeeAllowance";
 
   // allowance can be any of basic and periodic fee allowance.
-  google.protobuf.Any allowance = 1 [(cosmos_proto.accepts_interface) = "FeeAllowanceI"];
+  google.protobuf.Any allowance = 1 [(cosmos_proto.accepts_interface) = "IFeeAllowance"];
 
   // allowed_messages are the messages for which the grantee has the access.
   repeated string allowed_messages = 2;
@@ -74,5 +74,5 @@ message Grant {
   string grantee = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
   // allowance can be any of basic, periodic, allowed fee allowance.
-  google.protobuf.Any allowance = 3 [(cosmos_proto.accepts_interface) = "FeeAllowanceI"];
+  google.protobuf.Any allowance = 3 [(cosmos_proto.accepts_interface) = "IFeeAllowance"];
 }

proto/cosmos/feegrant/v1beta1/tx.proto

@@ -32,7 +32,7 @@ message MsgGrantAllowance {
   string grantee = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
   // allowance can be any of basic, periodic, allowed fee allowance.
-  google.protobuf.Any allowance = 3 [(cosmos_proto.accepts_interface) = "FeeAllowanceI"];
+  google.protobuf.Any allowance = 3 [(cosmos_proto.accepts_interface) = "IFeeAllowance"];
 }
 
 // MsgGrantAllowanceResponse defines the Msg/GrantAllowanceResponse response type.

server/rosetta/converter.go

@@ -755,7 +755,7 @@ func (c converter) SigningComponents(tx authsigning.Tx, metadata *ConstructionMe
 
 // SignerData converts the given any account to signer data
 func (c converter) SignerData(anyAccount *codectypes.Any) (*SignerData, error) {
-	var acc auth.AccountI
+	var acc auth.IAccount
 	err := c.ir.UnpackAny(anyAccount, &acc)
 	if err != nil {
 		return nil, crgerrs.WrapError(crgerrs.ErrCodec, err.Error())

simapp/export.go

@@ -73,7 +73,7 @@ func (app *SimApp) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs []
 	/* Handle fee distribution state. */
 
 	// withdraw all validator commission
-	app.StakingKeeper.IterateValidators(ctx, func(_ int64, val stakingtypes.ValidatorI) (stop bool) {
+	app.StakingKeeper.IterateValidators(ctx, func(_ int64, val stakingtypes.IValidator) (stop bool) {
 		_, _ = app.DistrKeeper.WithdrawValidatorCommission(ctx, val.GetOperator())
 		return false
 	})
@@ -102,7 +102,7 @@ func (app *SimApp) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs []
 	ctx = ctx.WithBlockHeight(0)
 
 	// reinitialize all validators
-	app.StakingKeeper.IterateValidators(ctx, func(_ int64, val stakingtypes.ValidatorI) (stop bool) {
+	app.StakingKeeper.IterateValidators(ctx, func(_ int64, val stakingtypes.IValidator) (stop bool) {
 		// donate any unwithdrawn outstanding reward fraction tokens to the community pool
 		scraps := app.DistrKeeper.GetValidatorOutstandingRewardsCoins(ctx, val.GetOperator())
 		feePool := app.DistrKeeper.GetFeePool(ctx)

simapp/state.go

@@ -232,7 +232,7 @@ func AppStateFromGenesisFileFn(r io.Reader, cdc codec.JSONCodec, genesisFile str
 
 		privKey := secp256k1.GenPrivKeyFromSecret(privkeySeed)
 
-		a, ok := acc.GetCachedValue().(authtypes.AccountI)
+		a, ok := acc.GetCachedValue().(authtypes.IAccount)
 		if !ok {
 			panic("expected account")
 		}

tests/e2e/server/export_test.go

@@ -22,11 +22,11 @@ import (
 	tmtypes "github.com/tendermint/tendermint/types"
 	dbm "github.com/tendermint/tm-db"
 
+	"cosmossdk.io/simapp"
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/server"
 	"github.com/cosmos/cosmos-sdk/server/types"
-	"cosmossdk.io/simapp"
 	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
 	"github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/x/genutil"

tests/e2e/tx/service_test.go

@@ -10,14 +10,14 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
+	"cosmossdk.io/simapp"
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	clienttx "github.com/cosmos/cosmos-sdk/client/tx"
 	"github.com/cosmos/cosmos-sdk/crypto/hd"
 	"github.com/cosmos/cosmos-sdk/crypto/keyring"
 	kmultisig "github.com/cosmos/cosmos-sdk/crypto/keys/multisig"
 	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
-	"cosmossdk.io/simapp"
 	"github.com/cosmos/cosmos-sdk/testutil"
 	"github.com/cosmos/cosmos-sdk/testutil/cli"
 	"github.com/cosmos/cosmos-sdk/testutil/network"

tests/integration/bank/keeper/keeper_test.go

@@ -26,8 +26,8 @@ import (
 	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 	tmtime "github.com/tendermint/tendermint/types/time"
 
-	"github.com/cosmos/cosmos-sdk/baseapp"
 	"cosmossdk.io/simapp"
+	"github.com/cosmos/cosmos-sdk/baseapp"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/query"
 	authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"

tests/integration/staking/keeper/common_test.go

@@ -7,8 +7,8 @@ import (
 	"github.com/stretchr/testify/require"
 	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 
-	"github.com/cosmos/cosmos-sdk/codec"
 	"cosmossdk.io/simapp"
+	"github.com/cosmos/cosmos-sdk/codec"
 	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"

tests/integration/staking/keeper/genesis_test.go

@@ -9,8 +9,8 @@ import (
 	abci "github.com/tendermint/tendermint/abci/types"
 	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 
-	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	"cosmossdk.io/simapp"
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/bank/testutil"
 	"github.com/cosmos/cosmos-sdk/x/staking"

tests/integration/staking/keeper/keeper_test.go

@@ -8,8 +8,8 @@ import (
 
 	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 
-	"github.com/cosmos/cosmos-sdk/baseapp"
 	"cosmossdk.io/simapp"
+	"github.com/cosmos/cosmos-sdk/baseapp"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/staking/keeper"
 	"github.com/cosmos/cosmos-sdk/x/staking/types"

tests/integration/staking/keeper/validator_test.go

@@ -9,8 +9,8 @@ import (
 	"github.com/stretchr/testify/require"
 	abci "github.com/tendermint/tendermint/abci/types"
 
-	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
 	"cosmossdk.io/simapp"
+	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
 	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/bank/testutil"