From 899b097da4b2f77e9929656b7025adb9d8f3a33b Mon Sep 17 00:00:00 2001 From: Tyler <48813565+technicallyty@users.noreply.github.com> Date: Tue, 22 Jun 2021 12:30:50 -0700 Subject: [PATCH] feat: make authz MsgExec emit events from all executed msgs (#9522) ## Description Closes: #9501 This PR makes MsgExec emit all events from each executed message. Adds a test to check for the additional events. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] ~~added a changelog entry to `CHANGELOG.md`~~ **N/A** - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] ~~updated the relevant documentation or specification~~ **N/A** - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable) --- x/authz/keeper/keeper.go | 8 ++++++ x/authz/keeper/keeper_test.go | 51 +++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) diff --git a/x/authz/keeper/keeper.go b/x/authz/keeper/keeper.go index 7d541c374..ce4e421c1 100644 --- a/x/authz/keeper/keeper.go +++ b/x/authz/keeper/keeper.go @@ -113,6 +113,14 @@ func (k Keeper) DispatchActions(ctx sdk.Context, grantee sdk.AccAddress, msgs [] return nil, sdkerrors.Wrapf(err, "failed to execute message; message %v", msg) } results[i] = msgResp.Data + + // emit the events from the dispatched actions + events := msgResp.Events + sdkEvents := make([]sdk.Event, 0, len(events)) + for i := 0; i < len(events); i++ { + sdkEvents = append(sdkEvents, sdk.Event(events[i])) + } + ctx.EventManager().EmitEvents(sdkEvents) } return results, nil diff --git a/x/authz/keeper/keeper_test.go b/x/authz/keeper/keeper_test.go index 5e0b79fc6..8dfebac95 100644 --- a/x/authz/keeper/keeper_test.go +++ b/x/authz/keeper/keeper_test.go @@ -196,6 +196,57 @@ func (s *TestSuite) TestKeeperFees() { s.Require().NotNil(authorization) } +// Tests that all msg events included in an authz MsgExec tx +// Ref: https://github.com/cosmos/cosmos-sdk/issues/9501 +func (s *TestSuite) TestDispatchedEvents() { + require := s.Require() + app, addrs := s.app, s.addrs + granterAddr := addrs[0] + granteeAddr := addrs[1] + recipientAddr := addrs[2] + require.NoError(simapp.FundAccount(app.BankKeeper, s.ctx, granterAddr, sdk.NewCoins(sdk.NewInt64Coin("steak", 10000)))) + now := s.ctx.BlockHeader().Time + require.NotNil(now) + + smallCoin := sdk.NewCoins(sdk.NewInt64Coin("steak", 20)) + msgs := authz.NewMsgExec(granteeAddr, []sdk.Msg{ + &banktypes.MsgSend{ + Amount: sdk.NewCoins(sdk.NewInt64Coin("steak", 2)), + FromAddress: granterAddr.String(), + ToAddress: recipientAddr.String(), + }, + }) + + // grant authorization + err := app.AuthzKeeper.SaveGrant(s.ctx, granteeAddr, granterAddr, &banktypes.SendAuthorization{SpendLimit: smallCoin}, now) + require.NoError(err) + authorization, _ := app.AuthzKeeper.GetCleanAuthorization(s.ctx, granteeAddr, granterAddr, bankSendAuthMsgType) + require.NotNil(authorization) + require.Equal(authorization.MsgTypeURL(), bankSendAuthMsgType) + + executeMsgs, err := msgs.GetMessages() + require.NoError(err) + + result, err := app.AuthzKeeper.DispatchActions(s.ctx, granteeAddr, executeMsgs) + require.NoError(err) + require.NotNil(result) + events := s.ctx.EventManager().Events() + // get last 5 events (events that occur *after* the grant) + events = events[len(events)-5:] + requiredEvents := map[string]bool{ + "coin_spent": false, + "coin_received": false, + "transfer": false, + "message": false, + } + for _, e := range events { + requiredEvents[e.Type] = true + } + for _, v := range requiredEvents { + require.True(v) + } +} + func TestTestSuite(t *testing.T) { suite.Run(t, new(TestSuite)) }