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

[FEATURE] - Update stake-address-info to show all types of deposits: drep deposit, action deposit, pool deposits #954

Open
3 of 18 tasks
CarlosLopezDeLara opened this issue Oct 29, 2024 · 1 comment
Labels
conway-feature enhancement New feature or request

Comments

@CarlosLopezDeLara
Copy link
Contributor

What

Update query stake-address-info so that it returns all possible deposits associated to the stake address, not only stake address registration:

  • stake pool deposits
  • drep deposits
  • governance action deposits

Why

This is useful information for users and should be easily accessible. This helps users to know if it is "safe" for them to deregister an stake address. i.e. there are no pending pool, drep or governance action deposits.

Personas

  • DReps
  • SPOs
  • dApp Devs
  • Exchanges
  • Wallets
  • 3rd party tools
  • ADA holders

Definition of Done (DoD)

  • Acceptance Criteria + User Stories & DoD created and singed-off (by PO, dev & test owners)
  • Builds successfully on CI
  • Code & Test review (as per Acceptance Criteria)
  • There is documentation and/or examples for the new functionality (usage/response)
  • Log/record changes on Vnext (or similar depending on what we adopt)
  • Ticket number(s) included in PR description
  • All Acceptance Criteria met and covered by dev/unit/property/integration tests
  • System/E2E automated tests + System Test Engineer Owner Sign-off

NOTE: Ideally, we should merge only fully implemented and tested features into the master branch.
So all the above steps are required for the PR to be merged.
In order to avoid the PRs becoming stale and requiring to be rebased on master, these can be merged
after a reasonable time (current agreement is 3 days) if the System Test Engineer Owner's sign-off
was not provided (last step in the DoD).

IMPORTANT: Any deviation from the plan should be discussed and agreed as a comment in the Feature file.

Sign-off

  • Product Owner
  • Dev Owner
  • System Test Engineer Owner

Related PRs

  1. PR # here

Acceptance Criteria

  • Rename the field delegationDeposit to registrationDeposit
  • Running query stake-address-info must return fields for each type of deposits and the amounts when a deposit exists or null if there isn't.
[
    {
        "address": "stake_test1upfpm2244k8jf00l357t3adp2hzfsuqrwqvleheqjj08uhswme5cn",
        "registrationDeposit": 2000000,
        "poolDeposit": null,
        "drepDeposit": 500000000, 
        "govActionDeposits": 100000000000,
        "rewardAccountBalance": 123456789,
        "stakeDelegation": pool1t8e9djhlzsgqsvtryewwkhqlkqv0vdyrdqkyu6n8jasrkx682q0,
        "voteDelegation": keyHash-e74584e2748a56ca27593c13cdd314834d10502ec98b5751f7678bea
    }
]
@gitmachtl
Copy link
Contributor

@CarlosLopezDeLara drepDeposit is not living on the stake account. its stored in the ledger yes, but will be paid out directly to the payment address of the deregistration certificate transaction. so i think you can remove this entry from your proposed output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conway-feature enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants