This repository has been archived by the owner on Jan 22, 2025. It is now read-only.
Document that Transaction::sign might panic #17026
Merged
Conversation
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
This was not obvious from the documentation, which can make programs that rely on it panic unexpectedly.
The direct callers of the Transaction::sign, which can panic, are Transaction::new and related functions, which means these can panic as well.
Codecov Report
@@ Coverage Diff @@
## master #17026 +/- ##
=======================================
Coverage 82.8% 82.8%
=======================================
Files 416 416
Lines 117260 117260
=======================================
+ Hits 97106 97107 +1
+ Misses 20154 20153 -1 |
|
Thanks! |
mergify bot
pushed a commit
that referenced
this pull request
May 4, 2021
(cherry picked from commit 9abfa65)
mvines
pushed a commit
that referenced
this pull request
May 4, 2021
(cherry picked from commit 9abfa65)
jeffwashington
pushed a commit
to jeffwashington/solana
that referenced
this pull request
May 6, 2021
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Problem
My program panicked, because somewhere in a third-party library, that library called
Transaction::new_signed_with_payer, which can panic. I’m not sure whether the caller ofTransaction::new_signed_with_payerwas aware of that. Document it, so users can at least be aware of this.Summary of Changes
Add
# Panicssections. Where possible, include an intra-doc-links to the non-panickingtry_*variants of these functions.