Fix wait for confirmation function #263
Merged
Conversation
This file contains hidden or 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
winder
reviewed
Dec 7, 2021
|
|
||
| def wait_for_confirmation(algod_client, txid, wait_rounds=0, **kwargs): | ||
| def wait_for_confirmation( | ||
| algod_client: algod.AlgodClient, txid: str, wait_rounds: int = 0, **kwargs |
There was a problem hiding this comment.
Set the default value here instead of checking for 0 and overriding it.
A smaller default like 5 would probably be better default than 1000.
There was a problem hiding this comment.
This is my attempt at maintaining backwards compatibility, since we already shipped a version with this function (unlike the other SDKs).
There might be existing code that passes 0 for wait_rounds and expects the function to wait indefinitely, so I though 1000 was the best replacement for it.
winder
approved these changes
Dec 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes the following issues with the wait for confirmation function:
pool-errorwas being ignoredpending_transaction_inforaises an HTTP error, that error should be ignored and the function should continue retrying ifwait_roundsallows it.wait_roundswhich allows indefinitely waiting. This is a dangerous feature, since your code might actually wait forever if it never sees the transaction fail. Instead a value of 1000 (the maximum txn life) is used to implement the same thing, and in reality is the longest you will ever have to wait. (Because v1.8.0 of this SDK was already released with this function, we can't get rid of the default value altogether without breaking the API).