Rename To/FromCBOR -> Enc/DecCBOR
#3303
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
lehins
force-pushed
the
lehins/rename-tofrom-encdec-cbor
branch
from
5e4fc6d to
9d0fef0
Compare
This is necessary to disambiguate from classes from `cardano-binary`, since they will have to sometimes be used in conjunction with each other Command that was used to do the renaming: ``` git ls-files -- "*.hs" -- "*.cabal" | xargs sed -i \ 's/FromCBOR/DecCBOR/g; s/fromCBOR/decCBOR/g; s/ToCBOR/EncCBOR/g; s/toCBOR/encCBOR/g' ```
* `fromSharedCBOR` -> `decShareCBOR` * `fromSharedPlusCBOR` -> `decSharePlusCBOR` * `fromSharedLensCBOR` -> `decShareLensCBOR` * `fromSharedPlusLensCBOR` -> `decSharePlusLensCBOR` * `fromNotSharedCBOR` -> `decNoShareCBOR` * `fromShareCBORfunctor` -> `decShareMonadCBOR` This rename is needed for consistency with the `FromCBOR` -> `DecCBOR` in the previous two commits. Command used during renaming: ``` git ls-files -- "*.hs" | xargs sed -i \ 's/FromSharedCBOR/DecShareCBOR/g; s/fromSharedCBOR/decShareCBOR/g; s/fromSharedPlusCBOR/decSharePlusCBOR/g; s/fromSharedLensCBOR/decShareLensCBOR/g; s/fromSharedPlusLensCBOR/decSharePlusLensCBOR/g; s/fromNotSharedCBOR/decNoShareCBOR/g; s/fromShareCBORfunctor/decShareMonadCBOR/g;' ```
lehins
force-pushed
the
lehins/rename-tofrom-encdec-cbor
branch
from
193db12 to
637b3ec
Compare
lehins
changed the title
To/FromCBOR -> EncDecCBORTo/FromCBOR -> Enc/DecCBOR
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
Rename
ToCBOR->EncCBORandFromCBOR->DecCBORRename
FromSharedCBOR->DecShareCBORand all the related functions:fromSharedCBOR->decShareCBORfromSharedPlusCBOR->decSharePlusCBORfromSharedLensCBOR->decShareLensCBORfromSharedPlusLensCBOR->decSharePlusLensCBORfromNotSharedCBOR->decNoShareCBORfromShareCBORfunctor->decShareMonadCBORThis PR disambiguates between versioned CBOR implemented
cardano-ledger-binaryand regular plain CBOR interface implemented bycardano-binary. This is necessary for two major reasons:To/FromCBORtoEnc/DecCBORinstead of the plain fromcardano-binarywe reduce breakage downstream, since it is mostly ledger codebase that is concerned with versioning by the protocol version.This PR was fully generated by running
sedand doinggit mvon two files. In other words there are no changes that were done manually. This fact should simplify the review process. That also means that the changelog entries will follow in a subsequent PRChecklist
fourmolu(which can be run withscripts/fourmolize.sh)scripts/cabal-format.sh)