feat: custom get signers

runtime/module.go

@@ -19,6 +19,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"
@@ -113,12 +114,6 @@ func ProvideApp() (
 		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)

tests/integration/tx/context_test.go

@@ -0,0 +1,70 @@
+package tx
+
+import (
+	"testing"
+
+	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
+	"cosmossdk.io/depinject"
+	"cosmossdk.io/log"
+	"cosmossdk.io/x/tx/signing"
+	"github.com/stretchr/testify/require"
+
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+	"github.com/cosmos/cosmos-sdk/testutil/configurator"
+	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
+)
+
+func SetCustomGetSigners(registry codectypes.InterfaceRegistry) {
+	signing.DefineCustomGetSigners(registry.SigningContext(), func(msg *bankv1beta1.SendAuthorization) ([][]byte, error) {
+		// arbitrary logic
+		signer := msg.AllowList[1]
+		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.Invoke(SetCustomGetSigners),
+		),
+		&interfaceRegistry,
+	)
+	require.NoError(t, err)
+	require.NotNil(t, interfaceRegistry)
+
+	sendAuth := &bankv1beta1.SendAuthorization{
+		AllowList: []string{"foo", "bar"},
+	}
+	signers, err := interfaceRegistry.SigningContext().GetSigners(sendAuth)
+	require.NoError(t, err)
+	require.Equal(t, [][]byte{[]byte("bar")}, signers)
+
+	// reset without invoker, no custom signer.
+	_, err = simtestutil.SetupAtGenesis(
+		depinject.Configs(
+			configurator.NewAppConfig(
+				configurator.ParamsModule(),
+				configurator.AuthModule(),
+				configurator.StakingModule(),
+				configurator.BankModule(),
+				configurator.ConsensusModule(),
+			),
+			depinject.Supply(log.NewNopLogger()),
+		),
+		&interfaceRegistry,
+	)
+	require.NoError(t, err)
+	require.NotNil(t, interfaceRegistry)
+
+	_, err = interfaceRegistry.SigningContext().GetSigners(sendAuth)
+	require.ErrorContains(t, err, "use DefineCustomGetSigners")
+}

x/nft/go.mod

@@ -152,6 +152,7 @@ require (
 // Fix upstream GHSA-h395-qcrw-5vmq and GHSA-3vp4-m3rf-835h vulnerabilities.
 // TODO Remove it: https://github.com/cosmos/cosmos-sdk/issues/10409
 replace (
+	cosmossdk.io/x/tx => ../../x/tx
 	// TODO: remove me after collections 0.2. is released.
 	cosmossdk.io/collections => ../../collections
 	cosmossdk.io/core => ../../core

x/tx/CHANGELOG.md

@@ -31,6 +31,9 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## Unreleased
 
+### Improvements
+* [#16340](https://github.com/cosmos/cosmos-sdk/pull/16340): add `DefineCustomGetSigners` API function.
+
 ## v0.7.0
 
 ### API Breaking

x/tx/decode/decode_test.go

@@ -61,7 +61,7 @@ func TestDecode(t *testing.T) {
 		{
 			name:  "empty signer option",
 			msg:   &testpb.A{},
-			error: "no cosmos.msg.v1.signer option found for message A: tx parse error",
+			error: "no cosmos.msg.v1.signer option found for message A; use DefineCustomGetSigners to specify a custom getter: tx parse error",
 		},
 	}
 

x/tx/internal/testpb/1.proto

@@ -104,4 +104,4 @@ message Ballot {
   string voter = 2;
   reserved 3;
   repeated WeightedBallotOption options = 4;
-}
+}

x/tx/signing/context.go

@@ -10,8 +10,9 @@ import (
 	"google.golang.org/protobuf/reflect/protoreflect"
 	"google.golang.org/protobuf/reflect/protoregistry"
 
-	msgv1 "cosmossdk.io/api/cosmos/msg/v1"
 	"cosmossdk.io/core/address"
+
+	msgv1 "cosmossdk.io/api/cosmos/msg/v1"
 )
 
 // Context is a context for retrieving the list of signers from a
@@ -85,7 +86,7 @@ type getSignersFunc func(proto.Message) ([][]byte, error)
 func getSignersFieldNames(descriptor protoreflect.MessageDescriptor) ([]string, error) {
 	signersFields := proto.GetExtension(descriptor.Options(), msgv1.E_Signer).([]string)
 	if len(signersFields) == 0 {
-		return nil, fmt.Errorf("no cosmos.msg.v1.signer option found for message %s", descriptor.FullName())
+		return nil, fmt.Errorf("no cosmos.msg.v1.signer option found for message %s; use DefineCustomGetSigners to specify a custom getter", descriptor.FullName())
 	}
 
 	return signersFields, nil
@@ -316,11 +317,26 @@ func (c *Context) ValidatorAddressCodec() address.Codec {
 	return c.validatorAddressCodec
 }
 
-// FileResolver returns the proto file resolver used by the context.
+// FileResolver returns the protobuf file resolver used by the context.
 func (c *Context) FileResolver() ProtoFileResolver {
 	return c.fileResolver
 }
 
+// TypeResolver returns the protobuf type resolver used by the context.
 func (c *Context) TypeResolver() protoregistry.MessageTypeResolver {
 	return c.typeResolver
 }
+
+// DefineCustomGetSigners defines a custom GetSigners function for a given
+// message type. It is defined as a function rather than a method on Context
+// because of how go generics work.
+//
+// NOTE: if a custom signers function is defined, the message type used to
+// define this function MUST be the concrete type passed to GetSigners,
+// otherwise a runtime type error will occur.
+func DefineCustomGetSigners[T proto.Message](ctx *Context, getSigners func(T) ([][]byte, error)) {
+	t := *new(T)
+	ctx.getSignersFuncs[t.ProtoReflect().Descriptor().FullName()] = func(msg proto.Message) ([][]byte, error) {
+		return getSigners(msg.(T))
+	}
+}

x/tx/signing/context_test.go

@@ -145,6 +145,28 @@ func TestGetSigners(t *testing.T) {
 	}
 }
 
+func TestDefineCustomGetSigners(t *testing.T) {
+	customMsg := &testpb.Ballot{}
+	signers := [][]byte{[]byte("foo")}
+
+	context, err := NewContext(Options{
+		AddressCodec:          dummyAddressCodec{},
+		ValidatorAddressCodec: dummyValidatorAddressCodec{},
+	})
+	require.NoError(t, err)
+
+	_, err = context.GetSigners(customMsg)
+	// before calling DefineCustomGetSigners, we should get an error
+	require.ErrorContains(t, err, "use DefineCustomGetSigners to specify")
+	DefineCustomGetSigners(context, func(msg *testpb.Ballot) ([][]byte, error) {
+		return signers, nil
+	})
+	// after calling DefineCustomGetSigners, we should get the signers
+	gotSigners, err := context.GetSigners(customMsg)
+	require.NoError(t, err)
+	require.Equal(t, signers, gotSigners)
+}
+
 type dummyAddressCodec struct{}
 
 func (d dummyAddressCodec) StringToBytes(text string) ([]byte, error) {