feat: custom get signers (#16340)

Co-authored-by: Aaron Craelius <[email protected]>

codec/proto_codec_test.go

@@ -7,6 +7,7 @@ import (
 
 	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
 	basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
+	"cosmossdk.io/x/tx/signing"
 	"github.com/cosmos/gogoproto/proto"
 	"github.com/stretchr/testify/require"
 	"google.golang.org/grpc/codes"
@@ -176,9 +177,11 @@ func BenchmarkProtoCodecMarshalLengthPrefixed(b *testing.B) {
 
 func TestGetSigners(t *testing.T) {
 	interfaceRegistry, err := types.NewInterfaceRegistryWithOptions(types.InterfaceRegistryOptions{
-		AddressCodec:          testAddressCodec{},
-		ValidatorAddressCodec: testAddressCodec{},
-		ProtoFiles:            protoregistry.GlobalFiles,
+		SigningOptions: signing.Options{
+			AddressCodec:          testAddressCodec{},
+			ValidatorAddressCodec: testAddressCodec{},
+		},
+		ProtoFiles: protoregistry.GlobalFiles,
 	})
 	require.NoError(t, err)
 	cdc := codec.NewProtoCodec(interfaceRegistry)

codec/testutil/codec.go

@@ -1,6 +1,7 @@
 package testutil
 
 import (
+	"cosmossdk.io/x/tx/signing"
 	"github.com/cosmos/gogoproto/proto"
 
 	"github.com/cosmos/cosmos-sdk/codec"
@@ -27,9 +28,11 @@ func (o CodecOptions) NewInterfaceRegistry() codectypes.InterfaceRegistry {
 	}
 
 	ir, err := codectypes.NewInterfaceRegistryWithOptions(codectypes.InterfaceRegistryOptions{
-		ProtoFiles:            proto.HybridResolver,
-		AddressCodec:          address.NewBech32Codec(accAddressPrefix),
-		ValidatorAddressCodec: address.NewBech32Codec(valAddressPrefix),
+		ProtoFiles: proto.HybridResolver,
+		SigningOptions: signing.Options{
+			AddressCodec:          address.NewBech32Codec(accAddressPrefix),
+			ValidatorAddressCodec: address.NewBech32Codec(valAddressPrefix),
+		},
 	})
 	if err != nil {
 		panic(err)

codec/types/interface_registry.go

@@ -9,8 +9,6 @@ import (
 	"google.golang.org/protobuf/reflect/protodesc"
 	"google.golang.org/protobuf/reflect/protoreflect"
 
-	"cosmossdk.io/core/address"
-
 	"cosmossdk.io/x/tx/signing"
 )
 
@@ -114,9 +112,11 @@ type interfaceMap = map[string]reflect.Type
 // NewInterfaceRegistry returns a new InterfaceRegistry
 func NewInterfaceRegistry() InterfaceRegistry {
 	registry, err := NewInterfaceRegistryWithOptions(InterfaceRegistryOptions{
-		ProtoFiles:            proto.HybridResolver,
-		AddressCodec:          failingAddressCodec{},
-		ValidatorAddressCodec: failingAddressCodec{},
+		ProtoFiles: proto.HybridResolver,
+		SigningOptions: signing.Options{
+			AddressCodec:          failingAddressCodec{},
+			ValidatorAddressCodec: failingAddressCodec{},
+		},
 	})
 	if err != nil {
 		panic(err)
@@ -129,11 +129,8 @@ type InterfaceRegistryOptions struct {
 	// ProtoFiles is the set of files to use for the registry. It is required.
 	ProtoFiles signing.ProtoFileResolver
 
-	// AddressCodec is the address codec to use for the registry. It is required.
-	AddressCodec address.Codec
-
-	// ValidatorAddressCodec is the validator address codec to use for the registry. It is required.
-	ValidatorAddressCodec address.Codec
+	// SigningOptions are the signing options to use for the registry.
+	SigningOptions signing.Options
 }
 
 // NewInterfaceRegistryWithOptions returns a new InterfaceRegistry with the given options.
@@ -142,12 +139,8 @@ func NewInterfaceRegistryWithOptions(options InterfaceRegistryOptions) (Interfac
 		return nil, fmt.Errorf("proto files must be provided")
 	}
 
-	signingCtx, err := signing.NewContext(signing.Options{
-		FileResolver:          options.ProtoFiles,
-		TypeResolver:          nil,
-		AddressCodec:          options.AddressCodec,
-		ValidatorAddressCodec: options.ValidatorAddressCodec,
-	})
+	options.SigningOptions.FileResolver = options.ProtoFiles
+	signingCtx, err := signing.NewContext(options.SigningOptions)
 	if err != nil {
 		return nil, err
 	}

runtime/module.go

@@ -8,6 +8,7 @@ import (
 	appv1alpha1 "cosmossdk.io/api/cosmos/app/v1alpha1"
 	"cosmossdk.io/depinject"
 	"cosmossdk.io/log"
+	"cosmossdk.io/x/tx/signing"
 	"github.com/cosmos/gogoproto/proto"
 	"google.golang.org/protobuf/reflect/protodesc"
 	"google.golang.org/protobuf/reflect/protoregistry"
@@ -19,6 +20,7 @@ import (
 	"cosmossdk.io/core/header"
 	"cosmossdk.io/core/store"
 	storetypes "cosmossdk.io/store/types"
+
 	"github.com/cosmos/cosmos-sdk/codec/address"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
@@ -60,6 +62,7 @@ func init() {
 	appmodule.Register(&runtimev1alpha1.Module{},
 		appmodule.Provide(
 			ProvideApp,
+			ProvideInterfaceRegistry,
 			ProvideKVStoreKey,
 			ProvideTransientStoreKey,
 			ProvideMemoryStoreKey,
@@ -76,8 +79,7 @@ func init() {
 	)
 }
 
-func ProvideApp() (
-	codectypes.InterfaceRegistry,
+func ProvideApp(interfaceRegistry codectypes.InterfaceRegistry) (
 	codec.Codec,
 	*codec.LegacyAmino,
 	*AppBuilder,
@@ -98,27 +100,6 @@ func ProvideApp() (
 		_, _ = fmt.Fprintln(os.Stderr, err.Error())
 	}
 
-	interfaceRegistry, err := codectypes.NewInterfaceRegistryWithOptions(codectypes.InterfaceRegistryOptions{
-		ProtoFiles: proto.HybridResolver,
-		// using the global prefixes is a temporary solution until we refactor this
-		// to get the address.Codec's from the container
-		AddressCodec: address.Bech32Codec{
-			Bech32Prefix: sdk.GetConfig().GetBech32AccountAddrPrefix(),
-		},
-		ValidatorAddressCodec: address.Bech32Codec{
-			Bech32Prefix: sdk.GetConfig().GetBech32ValidatorAddrPrefix(),
-		},
-	})
-	if err != nil {
-		return nil, nil, nil, nil, nil, nil, nil, nil, nil, err
-	}
-
-	// validate the signing context to make sure that messages are properly configured
-	// with cosmos.msg.v1.signer
-	if err := interfaceRegistry.SigningContext().Validate(); err != nil {
-		return nil, nil, nil, nil, nil, nil, nil, nil, nil, err
-	}
-
 	amino := codec.NewLegacyAmino()
 
 	std.RegisterInterfaces(interfaceRegistry)
@@ -136,7 +117,7 @@ func ProvideApp() (
 	}
 	appBuilder := &AppBuilder{app}
 
-	return interfaceRegistry, cdc, amino, appBuilder, cdc, msgServiceRouter, appModule{app}, protoFiles, protoTypes, nil
+	return cdc, amino, appBuilder, cdc, msgServiceRouter, appModule{app}, protoFiles, protoTypes, nil
 }
 
 type AppInputs struct {
@@ -176,6 +157,35 @@ func SetupAppBuilder(inputs AppInputs) {
 	}
 }
 
+func ProvideInterfaceRegistry(customGetSigners []signing.CustomGetSigner) (codectypes.InterfaceRegistry, error) {
+	signingOptions := signing.Options{
+		// using the global prefixes is a temporary solution until we refactor this
+		// to get the address.Codec's from the container
+		AddressCodec: address.Bech32Codec{
+			Bech32Prefix: sdk.GetConfig().GetBech32AccountAddrPrefix(),
+		},
+		ValidatorAddressCodec: address.Bech32Codec{
+			Bech32Prefix: sdk.GetConfig().GetBech32ValidatorAddrPrefix(),
+		},
+	}
+	for _, signer := range customGetSigners {
+		signingOptions.DefineCustomGetSigners(signer.MsgType, signer.Fn)
+	}
+
+	interfaceRegistry, err := codectypes.NewInterfaceRegistryWithOptions(codectypes.InterfaceRegistryOptions{
+		ProtoFiles:     proto.HybridResolver,
+		SigningOptions: signingOptions,
+	})
+	if err != nil {
+		return nil, err
+	}
+	err = interfaceRegistry.SigningContext().Validate()
+	if err != nil {
+		return nil, err
+	}
+	return interfaceRegistry, nil
+}
+
 func registerStoreKey(wrapper *AppBuilder, key storetypes.StoreKey) {
 	wrapper.app.storeKeys = append(wrapper.app.storeKeys, key)
 }

simapp/app.go

@@ -10,11 +10,13 @@ import (
 	"path/filepath"
 
 	"cosmossdk.io/log"
+	"cosmossdk.io/x/tx/signing"
 
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
 	reflectionv1 "cosmossdk.io/api/cosmos/reflection/v1"
 	"cosmossdk.io/client/v2/autocli"
 	"cosmossdk.io/core/appmodule"
+
 	"github.com/cosmos/cosmos-sdk/codec/address"
 
 	authcodec "github.com/cosmos/cosmos-sdk/x/auth/codec"
@@ -229,11 +231,13 @@ func NewSimApp(
 ) *SimApp {
 	interfaceRegistry, _ := types.NewInterfaceRegistryWithOptions(types.InterfaceRegistryOptions{
 		ProtoFiles: proto.HybridResolver,
-		AddressCodec: address.Bech32Codec{
-			Bech32Prefix: sdk.GetConfig().GetBech32AccountAddrPrefix(),
-		},
-		ValidatorAddressCodec: address.Bech32Codec{
-			Bech32Prefix: sdk.GetConfig().GetBech32ValidatorAddrPrefix(),
+		SigningOptions: signing.Options{
+			AddressCodec: address.Bech32Codec{
+				Bech32Prefix: sdk.GetConfig().GetBech32AccountAddrPrefix(),
+			},
+			ValidatorAddressCodec: address.Bech32Codec{
+				Bech32Prefix: sdk.GetConfig().GetBech32ValidatorAddrPrefix(),
+			},
 		},
 	})
 	appCodec := codec.NewProtoCodec(interfaceRegistry)

tests/integration/aminojson/aminojson_test.go → tests/integration/tx/aminojson/aminojson_test.go

@@ -43,9 +43,9 @@ import (
 	ed25519types "github.com/cosmos/cosmos-sdk/crypto/keys/ed25519"
 	"github.com/cosmos/cosmos-sdk/crypto/keys/multisig"
 	secp256k1types "github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1"
-	gogo_testpb "github.com/cosmos/cosmos-sdk/tests/integration/aminojson/internal/gogo/testpb"
-	pulsar_testpb "github.com/cosmos/cosmos-sdk/tests/integration/aminojson/internal/pulsar/testpb"
 	"github.com/cosmos/cosmos-sdk/tests/integration/rapidgen"
+	gogo_testpb "github.com/cosmos/cosmos-sdk/tests/integration/tx/internal/gogo/testpb"
+	pulsar_testpb "github.com/cosmos/cosmos-sdk/tests/integration/tx/internal/pulsar/testpb"
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	"github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/bech32"

tests/integration/aminojson/repeated_test.go → tests/integration/tx/aminojson/repeated_test.go

@@ -10,9 +10,10 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"cosmossdk.io/x/tx/signing/aminojson"
+
 	"github.com/cosmos/cosmos-sdk/codec"
-	gogopb "github.com/cosmos/cosmos-sdk/tests/integration/aminojson/internal/gogo/testpb"
-	pulsarpb "github.com/cosmos/cosmos-sdk/tests/integration/aminojson/internal/pulsar/testpb"
+	gogopb "github.com/cosmos/cosmos-sdk/tests/integration/tx/internal/gogo/testpb"
+	pulsarpb "github.com/cosmos/cosmos-sdk/tests/integration/tx/internal/pulsar/testpb"
 )
 
 func TestRepeatedFields(t *testing.T) {

tests/integration/tx/context_test.go

@@ -0,0 +1,74 @@
+package tx
+
+import (
+	"testing"
+
+	"cosmossdk.io/depinject"
+	"cosmossdk.io/log"
+	"cosmossdk.io/x/tx/signing"
+	"github.com/stretchr/testify/require"
+	"google.golang.org/protobuf/proto"
+
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+	"github.com/cosmos/cosmos-sdk/tests/integration/tx/internal/pulsar/testpb"
+	"github.com/cosmos/cosmos-sdk/testutil/configurator"
+	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
+)
+
+func ProvideCustomGetSigners() signing.CustomGetSigner {
+	return signing.CustomGetSigner{
+		MsgType: proto.MessageName(&testpb.TestRepeatedFields{}),
+		Fn: func(msg proto.Message) ([][]byte, error) {
+			testMsg := msg.(*testpb.TestRepeatedFields)
+			// arbitrary logic
+			signer := testMsg.NullableDontOmitempty[1].Value
+			return [][]byte{[]byte(signer)}, nil
+		},
+	}
+}
+
+func TestDefineCustomGetSigners(t *testing.T) {
+	var interfaceRegistry codectypes.InterfaceRegistry
+	_, err := simtestutil.SetupAtGenesis(
+		depinject.Configs(
+			configurator.NewAppConfig(
+				configurator.ParamsModule(),
+				configurator.AuthModule(),
+				configurator.StakingModule(),
+				configurator.BankModule(),
+				configurator.ConsensusModule(),
+			),
+			depinject.Supply(log.NewNopLogger()),
+			depinject.Provide(ProvideCustomGetSigners),
+		),
+		&interfaceRegistry,
+	)
+	require.NoError(t, err)
+	require.NotNil(t, interfaceRegistry)
+
+	msg := &testpb.TestRepeatedFields{
+		NullableDontOmitempty: []*testpb.Streng{
+			{Value: "foo"},
+			{Value: "bar"},
+		},
+	}
+	signers, err := interfaceRegistry.SigningContext().GetSigners(msg)
+	require.NoError(t, err)
+	require.Equal(t, [][]byte{[]byte("bar")}, signers)
+
+	// Reset and provider no CustomGetSigners. Consequently, validation will fail and depinject will return an error
+	_, err = simtestutil.SetupAtGenesis(
+		depinject.Configs(
+			configurator.NewAppConfig(
+				configurator.ParamsModule(),
+				configurator.AuthModule(),
+				configurator.StakingModule(),
+				configurator.BankModule(),
+				configurator.ConsensusModule(),
+			),
+			depinject.Supply(log.NewNopLogger()),
+		),
+		&interfaceRegistry,
+	)
+	require.ErrorContains(t, err, "use DefineCustomGetSigners")
+}