Skip to content

Deprecate certificate in tx certificates #962

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Deprecate certificate in tx certificates #962

wants to merge 7 commits into from

Conversation

Jimbo4350
Copy link
Contributor

@Jimbo4350 Jimbo4350 commented Sep 22, 2025 •
edited
Loading

Changelog

- description: |
    Replace `Certificate` in `TxCertificates` with new api's `Certificate` type.
# uncomment types applicable to the change:
  type:
  - breaking       # the API has changed in a breaking way
  projects:
   - cardano-api

Context

Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-certificate-in-tx-certificates branch from d0ae67a to d165125 Compare September 22, 2025 13:22
github-advanced-security[bot]
github-advanced-security bot found potential problems Sep 22, 2025
View reviewed changes
@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-certificate-in-tx-certificates branch 3 times, most recently from 34eb78c to 6bf3263 Compare September 24, 2025 11:16
github-advanced-security[bot]
github-advanced-security bot found potential problems Sep 24, 2025
View reviewed changes
@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-certificate-in-tx-certificates branch from 6bf3263 to 62b27ed Compare September 24, 2025 11:57
github-advanced-security[bot]
github-advanced-security bot found potential problems Sep 24, 2025
View reviewed changes
@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-certificate-in-tx-certificates branch from 62b27ed to 457550a Compare September 24, 2025 12:03
@Jimbo4350 Jimbo4350 changed the title WIP: Deprecate certificate in tx certificates Deprecate certificate in tx certificates Sep 24, 2025
@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-certificate-in-tx-certificates branch from 457550a to ebdf22b Compare September 24, 2025 12:06
@Jimbo4350 Jimbo4350 marked this pull request as ready for review September 24, 2025 12:06
carbolymer
carbolymer reviewed Sep 24, 2025
View reviewed changes
Jimbo4350
Jimbo4350 commented Sep 24, 2025
View reviewed changes
Jimbo4350
Jimbo4350 commented Sep 24, 2025
View reviewed changes
cardano-api/src/Cardano/Api/Query/Internal/Convenience.hs Outdated

let stakeCreds = fromList $ mapMaybe filterUnRegCreds certs
drepCreds = fromList $ mapMaybe filterUnRegDRepCreds certs
-- TODO: Left off here fix filterUnRegCreds
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Remove comment

carbolymer
carbolymer reviewed Sep 24, 2025
View reviewed changes
cardano-api/src/Cardano/Api/Certificate/Internal.hs
filterUnRegCreds sbe (Exp.Certificate cert) =
fmap fromShelleyStakeCredential $
shelleyBasedEraConstraints sbe $
Ledger.lookupUnRegStakeTxCert cert
Copy link
Contributor

@carbolymer carbolymer Sep 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

That's cool, so many hours were wasted here on figuring out the correct implementation here.

carbolymer
carbolymer reviewed Sep 24, 2025
View reviewed changes
carbolymer
carbolymer reviewed Sep 24, 2025
View reviewed changes
cardano-api/src/Cardano/Api/Experimental/Tx/Internal/Certificate.hs Outdated
instance Error AnchorDataFromCertificateError where
prettyError :: AnchorDataFromCertificateError -> Doc ann
prettyError (InvalidPoolMetadataHashError url hash) =
"Invalid pool metadata hash for URL " <> fromString (show url) <> ": " <> fromString (show hash)
Copy link
Contributor

Choose a reason for hiding this comment

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

afair show will quote the argument, so if you don't want quotes, this should be easier

Suggested change
"Invalid pool metadata hash for URL " <> fromString (show url) <> ": " <> fromString (show hash)
"Invalid pool metadata hash for URL " <> pretty url <> ": " <> pretty hash

or this seems more idiomatic:

Suggested change
"Invalid pool metadata hash for URL " <> fromString (show url) <> ": " <> fromString (show hash)
"Invalid pool metadata hash for URL " <> dquotes (pretty url) <> ": " <> dquotes (pretty hash)

carbolymer
carbolymer reviewed Sep 24, 2025
View reviewed changes
Copy link
Contributor

@carbolymer carbolymer left a comment

Choose a reason for hiding this comment

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

LGTM

@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-certificate-in-tx-certificates branch from ebdf22b to 45eae26 Compare September 25, 2025 09:13
@Jimbo4350 Jimbo4350 mentioned this pull request Sep 25, 2025
Open
3 tasks
palas
palas approved these changes Sep 25, 2025
View reviewed changes
Copy link
Contributor

@palas palas left a comment

Choose a reason for hiding this comment

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

It all looks good 👍. I wonder why we had a property around Ord. And we could probably preserve it somehow, but not sure why that was important

@carbolymer
Copy link
Contributor

@palas partially because of this definition:

  TxCertificates
    :: ShelleyBasedEra era
    -> OMap
         (Certificate era)
         ( BuildTxWith
             build
             (Maybe (StakeCredential, Witness WitCtxStake era))
         )
    -> TxCertificates build era

Because the certificate is just wrapper over ledger's TxCert, we can trust ledger to provide a legal Ord instance I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carbolymer carbolymer carbolymer left review comments

@palas palas palas approved these changes

@dcoutts dcoutts Awaiting requested review from dcoutts dcoutts is a code owner

@erikd erikd Awaiting requested review from erikd erikd is a code owner

@newhoggy newhoggy Awaiting requested review from newhoggy newhoggy is a code owner

@kevinhammond kevinhammond Awaiting requested review from kevinhammond kevinhammond is a code owner

@CarlosLopezDeLara CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara CarlosLopezDeLara is a code owner

@disassembler disassembler Awaiting requested review from disassembler disassembler is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Jimbo4350 @carbolymer @palas