Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redact errors returned in reply #765

Merged
merged 8 commits into from
Mar 2, 2022
+20 −5
Merged

Redact errors returned in reply #765

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
446c664
Redact errors returned in reply
ethanfrey Feb 23, 2022
8f75ad1
Fix lint error, failing test
ethanfrey Feb 23, 2022
30bb290
Fix submessage tests
ethanfrey Feb 23, 2022
3953bda
Adjust error string
ethanfrey Mar 2, 2022
66ac1f5
Handle nil logger again
ethanfrey Mar 2, 2022
654fcec
Revert "Handle nil logger again"
alpe Mar 2, 2022
b2217a3
Fix test setup and assertions
alpe Mar 2, 2022
daf0d00
Merge pull request #770 from CosmWasm/759-redact-reply-errors-tests
ethanfrey Mar 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion x/wasm/keeper/msg_dispatcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package keeper

import (
"fmt"

wasmvmtypes "github.com/CosmWasm/wasmvm/types"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
Expand Down Expand Up @@ -131,8 +133,10 @@ func (d MessageDispatcher) DispatchSubmessages(ctx sdk.Context, contractAddr sdk
},
}
} else {
// Issue #759 - we don't return error string for worries of non-determinism
moduleLogger(ctx).Info("Redacting submessage error", "cause", err)
result = wasmvmtypes.SubcallResult{
Err: err.Error(),
Err: redactError(err),
}
}

Expand All @@ -155,6 +159,15 @@ func (d MessageDispatcher) DispatchSubmessages(ctx sdk.Context, contractAddr sdk
return rsp, nil
}

func redactError(err error) string {
// FIXME: do we want to hardcode some constant string mappings here as well?
// Or better document them? (SDK error string may change on a patch release to fix wording)
// sdk/11 is out of gas
// sdk/5 is insufficient funds (on bank send)
codespace, code, _ := sdkerrors.ABCIInfo(err, false)
return fmt.Sprintf("codespace: %s, code: %d", codespace, code)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a pretty nice error string. Can be parsed if really needed but does not screem PARSE ME.

}

func filterEvents(events []sdk.Event) []sdk.Event {
// pre-allocate space for efficiency
res := make([]sdk.Event, 0, len(events))
Expand Down
6 changes: 3 additions & 3 deletions x/wasm/keeper/submsg_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ func TestDispatchSubMsgErrorHandling(t *testing.T) {
msg: invalidBankSend,
subMsgError: true,
// uses less gas than the send tokens (cost of bank transfer)
resultAssertions: []assertion{assertGasUsed(76000, 79000), assertErrorString("insufficient funds")},
resultAssertions: []assertion{assertGasUsed(76000, 79000), assertErrorString("sdk/5")},
},
"out of gas panic with no gas limit": {
submsgID: 7,
Expand All @@ -275,15 +275,15 @@ func TestDispatchSubMsgErrorHandling(t *testing.T) {
subMsgError: true,
gasLimit: &subGasLimit,
// uses same gas as call without limit (note we do not charge the 40k on reply)
resultAssertions: []assertion{assertGasUsed(79000, 79040), assertErrorString("insufficient funds")},
resultAssertions: []assertion{assertGasUsed(77500, 77600), assertErrorString("sdk/5")},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New error stings are cheaper 👍

},
"out of gas caught with gas limit": {
submsgID: 17,
msg: infiniteLoop,
subMsgError: true,
gasLimit: &subGasLimit,
// uses all the subGasLimit, plus the 52k or so for the main contract
resultAssertions: []assertion{assertGasUsed(subGasLimit+73000, subGasLimit+80000), assertErrorString("out of gas")},
resultAssertions: []assertion{assertGasUsed(subGasLimit+72000, subGasLimit+73000), assertErrorString("sdk/11")},
},
"instantiate contract gets address in data and events": {
submsgID: 21,
Expand Down