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

Make stake-address-info query also return deposit #375

Merged
merged 1 commit into from
Oct 19, 2023

Conversation

carlhammann
Copy link
Contributor

@carlhammann carlhammann commented Oct 13, 2023

Changelog

- description: |
    `cardano-cli query stake-address-info` now returns the deposit for the currently delegated staking credential (in addition to what it returned before).
# 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 #353.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • Self-reviewed the diff

Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

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

I like the improvement but can you inform QA about this change. They may depend on the output.

& onLeft (left . QueryCmdLocalStateQueryError . EraMismatchError)

return $ do
writeStakeAddressInfo
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth updating the function name to say writeStakeAddressInfoAndBalances?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure; the name you propose wouldn't even have been completely descriptive before this change, but now we write balances, stake pools, and deposits... In short, all information associated with a stake address that we can query.

Nothing -> liftIO $ LBS.putStrLn (encodePretty jsonInfo)
Just (File fpath) ->
handleIOExceptT (QueryCmdWriteFileError . FileIOError fpath)
$ LBS.writeFile fpath (encodePretty jsonInfo)
Copy link
Contributor

Choose a reason for hiding this comment

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

@newhoggy newhoggy self-requested a review October 19, 2023 14:30
@carlhammann carlhammann added this pull request to the merge queue Oct 19, 2023
Merged via the queue into main with commit 4def5e6 Oct 19, 2023
19 checks passed
@carlhammann carlhammann deleted the ch/query-stake-deposit branch October 19, 2023 15:49
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.

[FEATUE] A query for the stake key deposited amount | Stake-Address-Info is not showing the deposited amount
3 participants