Implement ADR 031: Protobuf Msg Services

[aaronc]

Summary

Implement ADR 031: Protobuf Msg Services as documented in #7458 and #7122 .

Roadmap

• Base implementation
  • Refactor RegisterQueryServices -> RegisterServices #7518 Refactor RegisterQueryService -> RegisterServices and create Configurator type
  • Add ADR 031 BaseApp and codec infrastructure #7519 Implement ServiceMsg, MsgRequest, and router for a Msg service in testdata. Router should also handle EventManager stuff
  • Refactor x/bank according to ADR 031 #7520 Add buf linter exception for service request type names (we want to use the existing Msg types without the Request suffix)
  • Refactor x/bank according to ADR 031 #7520 Create WrapServiceResult(proto.Message, error) (*sdk.Result, error) func which takes a service method result and error and wraps it in an *sdk.Result or error for use in refactored module handlers
  • Add MsgServer to Configurator and wire up modules
• Modules - only modules which define Msgs. See Implementation Notes below
  • Refactor x/bank according to ADR 031 #7520 x/bank
  • Refactor x/{gov, crisis} according to ADR 031 #7533 x/crisis (@atheeshp )
  • Refactor x/distribution according to ADR 031 #7524 x/distribution (@atheeshp )
  • x/evidence (@amaurymartiny)
  • Refactor x/{gov, crisis} according to ADR 031 #7533 x/gov (@atheeshp )
  • x/ibc
  • [x/slashing] Implement Protobuf Msg Services #7557 x/slashing (@blushi)
  • Refactor x/staking according to ADR 031 #7556 x/staking (@atheeshp )
  • Refactor x/auth/vesting to use ADR-031 #7551 x/vesting (@clevinson)

Implementation Notes

Modules

1. Add a service definition called Msg in each module's tx.proto file. Re-use the existing Msg types for the request type and add an unique Response type for each rpc method.
2. Refactor all handler functions into an implementation of the generated MsgServer interface

// x/bank/handler.go

// Handle MsgSend.
func handleMsgSend(ctx sdk.Context, k keeper.Keeper, msg *types.MsgSend) (*sdk.Result, error) {
    ...
    return &sdk.Result{Events: ctx.EventManager().ABCIEvents()}, nil
}

becomes:

// x/bank/keeper/msg_server.go

type msgServer struct {
    Keeper
}

func (k msgServer) Send(goCtx context.Context, msg *types.MsgSend) (*types.MsgSendResponse, error) {
    ctx := sdk.UnwrapSDKContext(goCtx)
    ...
    return &types.MsgSendResponse{}, nil
}

3. Refactor the root handler to just call those MsgService methods. Ex:

func NewHandler(k keeper.Keeper) sdk.Handler {
	return func(ctx sdk.Context, msg sdk.Msg) (*sdk.Result, error) {
		ctx = ctx.WithEventManager(sdk.NewEventManager())
                
                msgServer := keeper.NewMsgServerImpl(k)

		switch msg := msg.(type) {
		case *types.MsgSend:
			res, err := msgServer.Send(sdk.WrapSDKContext(ctx), msg)
                        return sdk.WrapServiceResult(ctx, res, err)

		case *types.MsgMultiSend:
			res, err := msgServer.MultiSend(sdk.WrapSDKContext(ctx), msg)
                        return sdk.WrapServiceResult(ctx, res, err)

		default:
			return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized bank message type: %T", msg)
		}
	}
}

4. Wire up MsgServer in RegisterServices (if possible - that functionality is currently not ready, so skip this step for now)

[aaronc]

I’m inclined to start on this ASAP. If we get this done pretty quickly clients won’t get too used to the existing API so that we have backwards compatibility concerns. Maybe this could even be part of a quick v0.40.1 in a couple of weeks.

[clevinson]

Closing in favor of #7540 (Codetree Epic)