Add golden tests for the rest of the query result types

[aniketd]

Description

There is no separate issue for this one. Consider this a follow up of #5659 where we add golden examples for all query results.

Note

Some ToJSON instances were found to be orphans in downstream packages because ledger didn't have those instances. These have been added here. Also an instance that could not be found, has been invented.

1. DefaultVote: from cardano-cli/src/Cardano/CLI/Orphan.hs
2. StakeSnapshot, StakeSnapshots: from cardano-api/src/Cardano/Api/Internal/Orphans/Serialisation.hs
3. QueryPoolStateResult: written fresh — no prior ToJSON found across cardano-api, cardano-cli, ouroboros-consensus, or cardano-db-sync, including via intermediate wrapper types. Implemented here via KeyValuePairs to match other query result types.

Checklist

• Commits in meaningful sequence and with useful messages.
• Tests added or updated when needed.
• CHANGELOG.md files updated for packages with externally visible changes.
  NOTE: New section is never added with the code changes. (See RELEASING.md).
• Versions updated in .cabal and CHANGELOG.md files when necessary, according to the
  versioning process.
• Version bounds in .cabal files updated when necessary.
  NOTE: If bounds change in a cabal file, that package itself must have a version increase. (See RELEASING.md).
• Code formatted (use scripts/fourmolize.sh).
• Cabal files formatted (use scripts/cabal-format.sh).
• CDDL files are up to date (use scripts/gen-cddl.sh)
• hie.yaml updated (use scripts/gen-hie.sh).
• Self-reviewed the diff.

[Soupstraw]

The golden test files are in binary, which makes them hard to check, I suggest using prettyHexEnc before outputting the result to the file. That way the diffs can be checked visually.

[lehins]

Great job on adding those examples.

Could I please ask you to confirm for each JSON instances that you added in this PR (as a comment on the PR itself, namely in Github, not in code) whether it was moved over from some place in cardano-api/consensus or did you add them yourself? This will be important for integration work and ensuring that we didn't break the interface

[aniketd]

Could I please ask you to confirm for each JSON instances that you added in this PR (as a comment on the PR itself, namely in Github, not in code) whether it was moved over from some place in cardano-api/consensus or did you add them yourself? This will be important for integration work and ensuring that we didn't break the interface

@lehins I have added the details to the PR description, as that it can be found quickly. 👍 Thanks! 🙌

[aniketd]

The golden test files are in binary, which makes them hard to check, I suggest using prettyHexEnc before outputting the result to the file. That way the diffs can be checked visually.

@Soupstraw this would be a change to the test harnesses we are using, and could be a separate PR 👍 Thanks! 🙌

[lehins]

The golden test files are in binary, which makes them hard to check, I suggest using prettyHexEnc before outputting the result to the file. That way the diffs can be checked visually.

I do very much appose storing binary golden files in hex form in the repo. Not only they double the size of files and add unnecessary overhead to all golden tests, but they also make PRs enormous in size (since github will start to treat them as text). I am not sure who in their right mind would manually inspect hex diff of golden files in a PR review? IMHO, it would result in a ridiculous and useless diff on Github. @Soupstraw, maybe you by now developed a superpower of reading CBOR in hex form, after so much work on cuddle, but I don't think anyone else wants to read hex in PRs 😅.
We have very nice facilities for inspecting diffs on golden test failures, which is more than enough. Anyone interested in seeing the relevant diff can take a look at a CI failure or run tests locally instead.

[lehins]

Awesome work!
Thank you!