Convenience flag to query stake distribution with drep-state query

[carlhammann]

Changelog

- description: |
    Add `--include-stake` flag to obtain the stake in the `drep-state` query
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

This PR closes #551.

I introduce an overlap between the drep-state and drep-stake-distribution queries. With the --include-stake flag, the former now subsumes the latter. AFAICT, the queries are exposed separately because drep-stake-distribution is expensive. This makes obtaining all information associated with a DRep credential a two-command process. With the new flag, the expensive query is still guarded, but the CLI gets more user-friendly.

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]

LGTM but one comment

[gitmachtl]

looks like the current command defaults to --include-stake, i guess that should be false per default?

also, the generated output does not contain the keyhash anymore. looks like:

[
    {
        "anchor": {
            "dataHash": "1111111111111111111111111111111111111111111111111111111111111111",
            "url": "https://bit.ly/3zCH2HL"
        },
        "deposit": 2000000,
        "expiry": 188,
        "stake": null
    },
    {
        "anchor": null,
        "deposit": 2000000,
        "expiry": 230,
        "stake": null
    },
    {
        "anchor": null,
        "deposit": 2000000,
        "expiry": 216,
        "stake": null
    },
    {
        "anchor": {
            "dataHash": "f8f21b94aef91b0d5e7ff330889d60f665529897b5c1ae4a1aa608b6249e20e6",
            "url": "https://github.com/Mborongoma/SANCH-GOV-TESTES/blob/main/bio.txt"
        },
        "deposit": 2000000,
        "expiry": 227,
        "stake": null
    },
    {
        "anchor": {
            "dataHash": "fd1b4e7fd844a8e2805bfda173f6461fd59812fcad4ce8a69b5ab427f7226cf7",
            "url": "https://my-ip.at/test/hwdrep.json"
        },
        "deposit": 2000000,
        "expiry": 232,
        "stake": null
    }
]

[carlhammann]

looks like the current command defaults to --include-stake, i guess that should be false per default?

Well spotted, @gitmachtl! The flag is actually off by default, in the sense that the query isn't performed, but the output includes the "stake" field always. That's confusing, so I changed that behaviour in f11dd55: Now the field should only be present when --include-stake is used.

[gitmachtl]

looks like the current command defaults to --include-stake, i guess that should be false per default?

Well spotted, @gitmachtl! The flag is actually off by default, in the sense that the query isn't performed, but the output includes the "stake" field always. That's confusing, so I changed that behaviour in f11dd55: Now the field should only be present when --include-stake is used.

thx! and the keyHash is missing in the output too for some reason.

[carlhammann]

thx! and the keyHash is missing in the output too for some reason.

Fixed in 9bd912b. Thanks for the reminder 🙇

[gitmachtl]

hi, any plans to merge this into main soon? thx.

[Jimbo4350]

This is fine for now but we should convert this into a ToJSON instance.

[smelc]

Follow-up issue created: #606