refactor(baseapp,types)!: msg responses #17348

zakir-code · 2023-08-10T06:09:48Z

Description

The sdk.Result.Data field will be reset here.

Lines 981 to 987 in dea5b97

    
           data, err := makeABCIData(msgResponses) 
        
           if err != nil { 
        
           	return nil, errorsmod.Wrap(err, "failed to marshal tx data") 
        
           } 
        
           return &sdk.Result{ 
        
           	Data:         data,

msgResult.MsgResponses length must be greater than zero, if there is no error.

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...

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 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)

baseapp/baseapp.go

types/result.go

zakir-code · 2023-08-11T11:46:56Z

Ok, I've restored the length check.

CHANGELOG.md

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

julienrbrt

Can we update this comment:

cosmos-sdk/baseapp/baseapp.go

Line 1001 in 2803afd

// `WrapServiceResult`. We take that Msg response, and aggregate it

and

cosmos-sdk/docs/docs/building-modules/03-msg-services.md

Line 95 in 2803afd

    
           The invoked `msgServer` method returns a `proto.Message` response and an `error`. These return values are then wrapped into an `*sdk.Result` or an `error` using `sdk.WrapServiceResult(ctx context.Context, res proto.Message, err error)`:

zakir-code · 2023-08-16T14:06:51Z

@julienrbrt sorry for the late reply.

feedback implemented

julienrbrt · 2023-08-16T15:10:39Z

docs/docs/building-modules/03-msg-services.md

@@ -92,7 +92,7 @@ ctx.EventManager().EmitEvent(

 These events are relayed back to the underlying consensus engine and can be used by service providers to implement services around the application. Click [here](../core/08-events.md) to learn more about events.

-The invoked `msgServer` method returns a `proto.Message` response and an `error`. These return values are then wrapped into an `*sdk.Result` or an `error` using `sdk.WrapServiceResult(ctx context.Context, res proto.Message, err error)`:
+The invoked `msgServer` method returns a `proto.Message` response and an `error`. These return values are then wrapped into an `*sdk.Result` or an `error`:

 ```go reference
 https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/baseapp/msg_service_router.go#L160


The snippet here has to change in a follow-up.

Sorry, I don't understand what you mean? Do you need to revert the changes here?

julienrbrt · 2023-08-16T15:19:35Z

CHANGELOG.md

@@ -121,6 +121,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (x/genutil) [#17098](https://github.com/cosmos/cosmos-sdk/pull/17098) `GenAppStateFromConfig`, AddGenesisAccountCmd and `GenTxCmd` takes an addresscodec to decode addresses
 * (x/distribution) [#17098](https://github.com/cosmos/cosmos-sdk/pull/17098) `NewMsgDepositValidatorRewardsPool`, `NewMsgFundCommunityPool`, `NewMsgWithdrawValidatorCommission` and `NewMsgWithdrawDelegatorReward` takes a string instead of `sdk.ValAddress` or `sdk.AccAddress`
 * (client) [#17215](https://github.com/cosmos/cosmos-sdk/pull/17215) `server.StartCmd`,`server.ExportCmd`,`server.NewRollbackCmd`,`pruning.Cmd`,`genutilcli.InitCmd`,`genutilcli.GenTxCmd`,`genutilcli.CollectGenTxsCmd`,`genutilcli.AddGenesisAccountCmd`, do not take a home directory anymore. It is inferred from the root command.
+* (types) [#17348](https://github.com/cosmos/cosmos-sdk/pull/17348) Remove the `WrapServiceResult` function.


Can we explain the behavior change as well, if someone is calling a msg the msg server router directly and expects the .Data (even if it is deprecated) field to be filled that won't be there.

Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

This reverts commit 42080b8.

refactor: delete unused data

24cf642

zakir-code requested a review from a team as a code owner August 10, 2023 06:09

github-prbot requested review from a team, alexanderbez and likhita-809 and removed request for a team August 10, 2023 06:10

refactor: msg responses

42e5b4d

zakir-code changed the title ~~refactor: delete unused data~~ refactor: msg responses Aug 10, 2023

alexanderbez reviewed Aug 10, 2023

View reviewed changes

baseapp/baseapp.go Outdated Show resolved Hide resolved

julienrbrt changed the title ~~refactor: msg responses~~ refactor(baseapp,types): msg responses Aug 11, 2023

julienrbrt reviewed Aug 11, 2023

View reviewed changes

baseapp/baseapp.go Outdated Show resolved Hide resolved

types/result.go Show resolved Hide resolved

zakir-code added 2 commits August 11, 2023 19:40

chore: update CHANGELOG.md

ce64d34

revert: check msg response length

3fc338c

alexanderbez approved these changes Aug 12, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

c799a28

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

julienrbrt changed the title ~~refactor(baseapp,types): msg responses~~ refactor(baseapp,types)!: msg responses Aug 12, 2023

alexanderbez approved these changes Aug 12, 2023

View reviewed changes

Merge branch 'main' into zakir/sdk-result-data

5102c26

julienrbrt previously requested changes Aug 13, 2023

View reviewed changes

zakir-code added 2 commits August 14, 2023 19:47

Merge branch 'main' into zakir/sdk-result-data

fdad2d4

update docs

5f257be

Merge branch 'main' into zakir/sdk-result-data

a10ec5a

julienrbrt reviewed Aug 16, 2023

View reviewed changes

julienrbrt approved these changes Aug 16, 2023

View reviewed changes

julienrbrt added this pull request to the merge queue Aug 16, 2023

julienrbrt removed this pull request from the merge queue due to a manual request Aug 16, 2023

julienrbrt requested a review from facundomedica August 16, 2023 15:16

julienrbrt reviewed Aug 16, 2023

View reviewed changes

update CHANGELOG.md

205eef4

tac0turtle assigned alexanderbez and julienrbrt Aug 17, 2023

julienrbrt enabled auto-merge August 18, 2023 12:16

julienrbrt added this pull request to the merge queue Aug 18, 2023

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 18, 2023

julienrbrt added this pull request to the merge queue Aug 18, 2023

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 18, 2023

julienrbrt added this pull request to the merge queue Aug 18, 2023

Merged via the queue into cosmos:main with commit 30997f4 Aug 18, 2023

samricotta pushed a commit that referenced this pull request Aug 19, 2023

refactor(baseapp,types)!: msg responses (#17348)

42080b8

Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

samricotta added a commit that referenced this pull request Aug 21, 2023

Revert "refactor(baseapp,types)!: msg responses (#17348)"

88ede38

This reverts commit 42080b8.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(baseapp,types)!: msg responses #17348

refactor(baseapp,types)!: msg responses #17348

zakir-code commented Aug 10, 2023 •

edited

Loading

zakir-code commented Aug 11, 2023

julienrbrt left a comment

zakir-code commented Aug 16, 2023

julienrbrt Aug 16, 2023

zakir-code Aug 17, 2023

julienrbrt Aug 16, 2023 •

edited

Loading

	data, err := makeABCIData(msgResponses)
	if err != nil {
	return nil, errorsmod.Wrap(err, "failed to marshal tx data")
	}

	return &sdk.Result{
	Data: data,

refactor(baseapp,types)!: msg responses #17348

refactor(baseapp,types)!: msg responses #17348

Conversation

zakir-code commented Aug 10, 2023 • edited Loading

Description

Author Checklist

Reviewers Checklist

zakir-code commented Aug 11, 2023

julienrbrt left a comment

Choose a reason for hiding this comment

zakir-code commented Aug 16, 2023

julienrbrt Aug 16, 2023

Choose a reason for hiding this comment

zakir-code Aug 17, 2023

Choose a reason for hiding this comment

julienrbrt Aug 16, 2023 • edited Loading

Choose a reason for hiding this comment

zakir-code commented Aug 10, 2023 •

edited

Loading

julienrbrt Aug 16, 2023 •

edited

Loading