Show error if using deprecated jets#228
Draft
stringhandler wants to merge 2 commits intoBlockstreamResearch:masterfrom
Draft
Show error if using deprecated jets#228stringhandler wants to merge 2 commits intoBlockstreamResearch:masterfrom
stringhandler wants to merge 2 commits intoBlockstreamResearch:masterfrom
Conversation
stringhandler
commented
Mar 5, 2026
| ), | ||
| Error::JetIsDeprecated(name) => write!( | ||
| f, | ||
| "Jet `{name}` has been deprecrated." |
Author
There was a problem hiding this comment.
Suggested change
| "Jet `{name}` has been deprecrated." | |
| "Jet `{name}` has been deprecated." |
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
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.
Background:
The jets
check_lock_distance,check_lock_duration,tx_lock_distance,tx_lock_durationhave recently been deprecated. In simplicity, the elements jets were renamed with the prefixbroken_do_not_use_.This PR
My aim when I started this was to have
simcgenerate warnings if you used a deprecated jet, with the option of forcing errors via-D warningsor something similar. However, adding warnings would require a large amount of changes and that would be better suited to be it's own PR.This PR, (along with sibling PRs in rust-simplicity#350 and simplicity#333, updates the jets to the new names, which should be enough of a warning to developers. It also returns an error if a deprecated jet is used.
Notably, the example
escrow_with_delay.simfwas using the deprecated jet. At present, I am not sure the correct path to fix this example, so for this PR it just renames the jet.Before:
After
NOTE: This pr requires PRs in rust-simplicity#350 and simplicity #333 to be merged first.