Deprecate --protocol-params-file option of the transaction build command more thoroughly
#28
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
newhoggy
changed the title
newhoggy
changed the title
--protocol-params-file option of the transaction build command more thoroughly
…and more thoroughly
newhoggy
force-pushed
the
newhoggy/deprecate-tx-build-protocol-params-file-more-thoroughly
branch
from
c1b9737
to
f9ebbe5
Compare
newhoggy
commented
Jun 16, 2023
| @@ -232,7 +234,7 @@ data TransactionCmd | |||
| [ScriptFile] | |||
| -- ^ Auxiliary scripts | |||
| [MetadataFile] | |||
| (Maybe ProtocolParamsFile) | |||
| (Maybe (Deprecated ProtocolParamsFile)) | |||
There was a problem hiding this comment.
This makes it more obvious a field is deprecated.
newhoggy
commented
Jun 16, 2023
| , "retrieved from the node." | ||
| ] | ||
| , Opt.completer (Opt.bashCompleter "file") | ||
| ] |
There was a problem hiding this comment.
Deprecated options should have help that reflects that.
newhoggy
commented
Jun 16, 2023
| mUpperBound certs wdrls metadataSchema scriptFiles metadataFiles mDeprecatedProtocolParamsFile | ||
| mUpProp outputOptions = do | ||
| forM_ mDeprecatedProtocolParamsFile $ \_ -> | ||
| liftIO $ printWarning "'--protocol-params-file' for 'transaction build' is deprecated" |
There was a problem hiding this comment.
Warn early rather than print warnings deep within the call hierarchy and after doing work.
newhoggy
commented
Jun 16, 2023
| mUpdatePropF mOverrideWits outputOptions = do | ||
|
|
||
| liftIO $ forM_ mpparams $ \_ -> | ||
| printWarning "'--protocol-params-file' for 'transaction build' is deprecated" |
There was a problem hiding this comment.
mpparams is never used except for this warning, so don't pass it in the first place.
newhoggy
commented
Jun 16, 2023
| Filepath of the JSON-encoded protocol parameters file | ||
| Filepath of the JSON-encoded protocol parameters | ||
| file. DEPRECATED The option is ignored and protocol | ||
| parameters are retrieved from the node. |
Jimbo4350
approved these changes
Jun 16, 2023
|
@Jimbo4350 should we leave "better deprecation" message or remove the argument altogether? #34 |
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.
Description
Changelog
Checklist
See Runnings tests for more details
CHANGELOG.mdfor affected package.cabalfiles are updatedhlint. See.github/workflows/check-hlint.ymlto get thehlintversionstylish-haskell. See.github/workflows/stylish-haskell.ymlto get thestylish-haskellversionghc-8.10.7andghc-9.2.7Note on CI
If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.