-
Notifications
You must be signed in to change notification settings - Fork 625
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.
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
fix: allow retries for messages signed by relayer. #3402
Merged
DimitrisJim
merged 8 commits into
main
from
jim/3264-avoid-sequence-mismatch-when-using-relayer-wallet-to-sign-ibc-tx-msgs
Apr 12, 2023
Merged
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b046605
fix: allow retries for messages signed by relayer.
DimitrisJim d922e82
Fix review nits.
DimitrisJim 3d8031f
Simplify containsMessage.
DimitrisJim 3c663c8
Address feedback.
DimitrisJim fb515f5
Return the resp if contains fails. Move relayerMap to the relayer fol…
DimitrisJim d3e54a7
Apply suggestions from code review
DimitrisJim 1fa0dc7
Merge branch 'main' into jim/3264-avoid-sequence-mismatch-when-using-…
DimitrisJim f1e3ae7
Merge branch 'main' into jim/3264-avoid-sequence-mismatch-when-using-…
DimitrisJim File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -60,6 +60,7 @@ type E2ETestSuite struct { | |
|
||
grpcClients map[string]GRPCClients | ||
paths map[string]path | ||
relayers map[ibc.Wallet]bool | ||
logger *zap.Logger | ||
DockerClient *dockerclient.Client | ||
network string | ||
|
@@ -117,6 +118,12 @@ func (s *E2ETestSuite) GetRelayerUsers(ctx context.Context, chainOpts ...testcon | |
chainARelayerUser := cosmos.NewWallet(ChainARelayerName, chainAAccountBytes, "", chainA.Config()) | ||
chainBRelayerUser := cosmos.NewWallet(ChainBRelayerName, chainBAccountBytes, "", chainB.Config()) | ||
|
||
if s.relayers == nil { | ||
s.relayers = make(map[ibc.Wallet]bool) | ||
} | ||
s.relayers[chainARelayerUser] = true | ||
s.relayers[chainBRelayerUser] = true | ||
|
||
return chainARelayerUser, chainBRelayerUser | ||
} | ||
|
||
|
@@ -281,7 +288,17 @@ func (s *E2ETestSuite) BroadcastMessages(ctx context.Context, chain *cosmos.Cosm | |
return factory.WithGas(DefaultGasValue) | ||
}) | ||
|
||
resp, err := cosmos.BroadcastTx(ctx, broadcaster, user, msgs...) | ||
// Retry the operation a few times if the user signing the transaction is a relayer. (See issue #3264) | ||
var resp sdk.TxResponse | ||
var err error | ||
broadcastFunc := func() (sdk.TxResponse, error) { | ||
return cosmos.BroadcastTx(ctx, broadcaster, user, msgs...) | ||
} | ||
if s.IsRelayer(user) { | ||
resp, err = s.retryNtimes(broadcastFunc, 5) | ||
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} else { | ||
resp, err = broadcastFunc() | ||
} | ||
if err != nil { | ||
return sdk.TxResponse{}, err | ||
} | ||
|
@@ -611,6 +628,43 @@ func (s *E2ETestSuite) QueryGranterGrants(ctx context.Context, chain *cosmos.Cos | |
return grants.Grants, nil | ||
} | ||
|
||
// IsRelayer returns true if the provided wallet is used by a relayer. | ||
func (s *E2ETestSuite) IsRelayer(user ibc.Wallet) bool { | ||
if s.relayers == nil { | ||
return false | ||
} | ||
return s.relayers[user] | ||
} | ||
|
||
// retryNtimes retries the provided function up to the provided number of attempts. | ||
func (s *E2ETestSuite) retryNtimes(f func() (sdk.TxResponse, error), attempts int) (sdk.TxResponse, error) { | ||
// Ignore account sequence mismatch errors. | ||
allowedMessages := []string{"account sequence mismatch"} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since this is a configuration parameter, maybe we can move it to the top together with the
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
var err error | ||
var resp sdk.TxResponse | ||
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
for i := 0; i < attempts; i++ { | ||
// If the response's raw log doesn't contain any of the allowed prefixes we return, else, we retry. | ||
resp, err = f() | ||
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if !containsMessage(resp.RawLog, allowedMessages) { | ||
return resp, err | ||
} | ||
s.T().Logf("retrying tx due to ignored raw log: %s", resp.RawLog) | ||
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
return resp, err | ||
} | ||
|
||
// containsPrefix returns true if the string s contains any of the prefixes in the slice. | ||
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
func containsMessage(s string, messages []string) bool { | ||
var hasPrefix bool | ||
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
for _, message := range messages { | ||
if strings.Contains(s, message) { | ||
hasPrefix = true | ||
DimitrisJim marked this conversation as resolved.
Show resolved
Hide resolved
|
||
break | ||
} | ||
} | ||
return hasPrefix | ||
} | ||
|
||
// GetIBCToken returns the denomination of the full token denom sent to the receiving channel | ||
func GetIBCToken(fullTokenDenom string, portID, channelID string) transfertypes.DenomTrace { | ||
return transfertypes.ParseDenomTrace(fmt.Sprintf("%s/%s/%s", portID, channelID, fullTokenDenom)) | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
while we do currently just run a single test in each run, we should try and make sure that if we change that we need to make as few changes as possible. With relayers being at the top level, this means that these relayer wallets would be shared across all tests. What might make sense to do is to create a mapping of testName -> relayer pair. Similar to how we do here.
This could even be a
map[string]map[ibc.Wallet]bool
which isn't super pretty, but maybe we could work with an alias of some sort here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did go with an alias here and basically just added a couple of functions on it. Lmk what you think.