Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Acnt -> Account #4002

Merged
merged 17 commits into from
Jan 29, 2024
Merged

Rename Acnt -> Account #4002

merged 17 commits into from
Jan 29, 2024

Conversation

Lucsanszky
Copy link
Contributor

@Lucsanszky Lucsanszky commented Jan 23, 2024

Description

This PR renames Acnt to Account by deprecating the following:

  • prAcnt
  • ppRewardAcnt
  • fromCborRewardAcnt
  • decodeRewardAcnt
  • putRewardAcnt
  • deserialiseRewardAcnt
  • serialiseRewardAcnt
  • RewardAcnt
  • deserialiseRewardAcntOld
  • delPlAcnt
  • mkVKeyRwdAcnt

Furthermore, the PR also renames some occurrences of acnt for consistency, without any deprecation helpers (as these are just internal functions or helpers, etc.).

Resolves #3928

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated
  • When applicable, versions are updated in .cabal and CHANGELOG.md files according to the
    versioning process.
  • The version bounds in .cabal files for all affected packages are updated. If you change the bounds in a cabal file, that package itself must have a version increase. (See RELEASING.md)
  • All visible changes are prepended to the latest section of a CHANGELOG.md for the affected packages. New section is never added with the code changes. (See RELEASING.md)
  • Code is formatted with fourmolu (use scripts/fourmolize.sh)
  • Cabal files are formatted (use scripts/cabal-format.sh)
  • hie.yaml has been updated (use scripts/gen-hie.sh)
  • Self-reviewed the diff

@Lucsanszky Lucsanszky force-pushed the lucsanszky/rename-acnt branch 2 times, most recently from 5dd66d2 to 1db34ec Compare January 23, 2024 02:27
Copy link
Contributor

@lehins lehins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!

We just need changelog entries for the renames and I also suggested two extra renames that can be made in the vicinity of a reward account

libs/cardano-ledger-core/src/Cardano/Ledger/Address.hs Outdated Show resolved Hide resolved
@Lucsanszky Lucsanszky force-pushed the lucsanszky/rename-acnt branch 2 times, most recently from c18a30c to c4a86e1 Compare January 24, 2024 03:19
@Lucsanszky
Copy link
Contributor Author

Sorry for the rebase after (pre-)review but I wanted to keep the commits organised so we can easily revert if need be. Also, I found some more instances of a/Acnt. I will rename those as well.

@Lucsanszky Lucsanszky force-pushed the lucsanszky/rename-acnt branch 2 times, most recently from 92a1c56 to 58f6682 Compare January 25, 2024 03:58
@Lucsanszky Lucsanszky marked this pull request as ready for review January 25, 2024 04:06
@Lucsanszky
Copy link
Contributor Author

Lucsanszky commented Jan 25, 2024

This is now ready for review. I tried to keep the commits as organised as possible. I also attempted to keep changes separate, except for the final commit (f51ed29): that was used to rename some internal stuff for consistency and since those are internal, not exported things, I didn't add deprecation helpers for them. I am also quite certain that I missed a few things here and there.

Copy link
Contributor

@lehins lehins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice work! Thank you.

@Lucsanszky Lucsanszky force-pushed the lucsanszky/rename-acnt branch 11 times, most recently from 621f5f3 to e8ce02a Compare January 29, 2024 04:02
Copy link
Contributor

@lehins lehins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect!
Thank you!

libs/cardano-ledger-core/CHANGELOG.md Outdated Show resolved Hide resolved
@lehins
Copy link
Contributor

lehins commented Jan 29, 2024

With respect to failing CI, it is unrelated to your changes. Both are flaky tests, one of which I already have a fix for.

Renamed to `RewardAccount`
Renamed to `serialiseRewardAccount`
Renamed to `deserialiseRewardAccount`
Lucsanszky and others added 14 commits January 29, 2024 16:09
Renamed to `putRewardAccount`
Renamed to `decodeRewardAccount`
Renamed to `fromCborRewardAccount`
Renamed to `ppRewardAccount`
Renamed to `prAccountState`
* `getRwdNetwork` -> `raNetwork`
* `getRwdCred` -> `raCredential`

Co-authored-by: Alexey Kuleshevich <alexey.kuleshevich@iohk.io>
Renamed to `mkVKeyRewardAccount`

Co-authored-by: Alexey Kuleshevich <alexey.kuleshevich@iohk.io>
Renamed to `delPlAccount`
Renamed to `deserialiseRewardAccountOld`
It seems that these are only used internally, hence no
deprecation helpers.
@Lucsanszky Lucsanszky merged commit 983512a into master Jan 29, 2024
11 of 12 checks passed
@neilmayhew neilmayhew deleted the lucsanszky/rename-acnt branch March 8, 2024 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename Acnt -> Account
2 participants