Add JSON schema checking functionality for DRep and Gov action metadata #713
+918
−0
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
palas
requested review from
dcoutts,
Jimbo4350,
erikd,
newhoggy,
carbolymer and
smelc
as code owners
palas
requested review from
kevinhammond,
CarlosLopezDeLara and
disassembler
as code owners
palas
force-pushed
the
gov-action-schema-checking
branch
from
c2d6579 to
4c6424e
Compare
palas
force-pushed
the
gov-action-schema-checking
branch
from
4c6424e to
4168561
Compare
|
But the CIPs 0119 and 0108 are in proposed state. Shouldn't we wait till they get accepted? |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
cardano-api/internal/Cardano/Api/Governance/Metadata/DrepRegistration.hs
Fixed
Show fixed
Hide fixed
palas
force-pushed
the
gov-action-schema-checking
branch
2 times, most recently
from
b7ef81c to
554a65c
Compare
palas
force-pushed
the
gov-action-schema-checking
branch
from
554a65c to
a447f80
Compare
palas
force-pushed
the
gov-action-schema-checking
branch
from
a447f80 to
504575e
Compare
Jimbo4350
reviewed
Jan 13, 2025
|
|
||
| import Data.Aeson (FromJSON, eitherDecodeStrict) | ||
| import Data.ByteString (ByteString) | ||
| import Data.Either.Combinators (mapRight) | ||
|
|
||
| data family GovActionMetadata cip | ||
| data GovActionMetadata cip |
Jimbo4350
reviewed
Jan 13, 2025
| @@ -76,7 +77,7 @@ prop_given_name_too_long_drep_registration_json = propertyOnce $ do | |||
| :: File DRepMetadata In | |||
| ) | |||
| value <- H.evalEither eitherValue | |||
| validateGovActionAnchorData CIP119 value | |||
| validateGovActionAnchorData DrepRegistrationMetadata value | |||
There was a problem hiding this comment.
👍 I think this is way more informative
Jimbo4350
reviewed
Jan 13, 2025
| <*> v .:? "sha256" | ||
|
|
||
| -- DoNotList Enum | ||
| data DoNotList = DoNotListTrue | DoNotListFalse |
There was a problem hiding this comment.
What does DoNotList refer to?
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.
Changelog
Context
The objective is addressing this issue: IntersectMBO/cardano-cli#906
This PR adds 3 functions to the API that should be the only ones needed by the
cardano-cliin order to implement this functionality:isDRepRegOrUpdateCert- Checks whether a certificate is for DRep registration or DRep update.validateDRepAnchorData- Checks whether aByteStringis valid JSON and conforms to CIP-0119.validateGovActionAnchorData- Checks whether aByteStringis valid JSON and conforms to CIP-0108This PR is a requirement from PR #995 that implements the checking in
cardano-cliand is based of the version ofcardano-apiin this PR.Related PRs in
CIPsrepo:@beforetypefield nameCIP-0008is in capital lettersHow to trust this PR
Tests should give some assurance. They are taken from the CIPs repo, with some adaptations that I have already created PRs in
CIPsrepo for (see above).The main thing to check here is the accuracy of the checks (are they enough, are they too much, are they right).
Could be useful to check the
cardano-cliPR together with this one.Checklist