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

Rename delegationDeposit to deposit #433

Closed
wants to merge 1 commit into from

Conversation

carlhammann
Copy link
Contributor

Changelog

- description: |
    Rename the `delegationDeposit` field in the output of the `stake-address-info` query to `deposit
# 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 closes #417. The other possible solution discussed there, namely to distinguish between the delegation deposit and the other deposits associated to the stake address, seems impracticable: The ledger maintains only one deposit for each staking credential.

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

@carlhammann carlhammann changed the title Rename 'delegationDeposit' to 'deposit' Rename delegationDeposit to deposit Nov 3, 2023
@newhoggy
Copy link
Contributor

newhoggy commented Nov 4, 2023

I'm a little bit concerned there isn't already a golden for this output. It is possible to add a golden test?

@carlhammann
Copy link
Contributor Author

I'm a little bit concerned there isn't already a golden for this output. It is possible to add a golden test?

I agree that it's concerning. However, this command queries a running node, and I don't think we have golden tests for any such command in this repository, do we?

@carlhammann
Copy link
Contributor Author

After some consultation with the ledger team, I found out that my initial assessment of what's possible seems to have been wrong. We should indeed be able to separate the different delegations. I'll close this and open another PR.

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.

stake-address-info - delegationDeposit
2 participants