Skip to content

Commit

Permalink
docs: 🚮 Remove adaMinimum field from ApiWalletUtxoSnapshotEntry t…
Browse files Browse the repository at this point in the history
…ype. (#4084) ## Issue ADP-3122 ## Summary This PR removes the `adaMinimum` field from the `ApiWalletUtxoSnapshotEntry` type. ## Context The original purpose of this field was to aid debugging, and specifically to answer the following question: > “For a given UTxO that already exists, what would the ledger have required the minimum quantity of ada to be at the time the UTxO was originally created?” In general this question is quite hard to answer, as for every historical UTxO that belongs to the wallet, we’d need to know: - in which era was this UTxO created? - at which slot (within an era) was this UTxO was created? - what were the values of the protocol parameters at the time the UTxO was created? This is because the minimum UTxO function can change: - as we transition from one era to another; and/or - whenever the protocol parameters are updated. Finally, since: - this field is for debugging purposes only; - it has maintenance burden that is hard to satisfy; - it is an obstacle to ongoing work in other areas; and since - there is little evidence of user demand for this field, We should feel free to remove it. Source commit: c25031d
  • Loading branch information
Cardano Wallet Documentation Bot committed Aug 9, 2023
1 parent 454c884 commit cd60390
Showing 1 changed file with 0 additions and 6 deletions.
6 changes: 0 additions & 6 deletions api/edge/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3221,18 +3221,12 @@ components:
type: object
required:
- ada
- ada_minimum
- assets
properties:
ada:
<<: *amount
description: |
The ada quantity associated with this UTxO entry.
ada_minimum:
<<: *amount
description: |
The minimum ada quantity permitted by the ledger for this UTxO
entry.
assets:
<<: *walletAssets
description: |
Expand Down

0 comments on commit cd60390

Please sign in to comment.