[ADP-2788] add max-count to listTransactions API call #3772
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paolino
force-pushed
the
paolino/ADP-2788/add-max-count-to-get-txs
branch
7 times, most recently
from
b0ccd8e
to
94310e4
Compare
piotr-iohk
reviewed
Mar 7, 2023
lib/wallet/api/http/Cardano/CLI.hs
Outdated
| @@ -1353,6 +1357,14 @@ sortOrderOption = optionT $ mempty | |||
| <> help "specifies a sort order, either 'ascending' or 'descending'." | |||
| <> showDefaultWith showT | |||
|
|
|||
| -- | [--order=ORDER] | |||
There was a problem hiding this comment.
Suggested change
| -- | [--order=ORDER] | |
| -- | [--max_count=MAX_COUNT] |
| w <- fixtureWalletWith @n ctx | ||
| (replicate 100 $ minUTxOValue (_mainEra ctx)) | ||
| txs <- listLimitedTransactions @n ctx w 9 | ||
| length txs `shouldBe` 9 |
There was a problem hiding this comment.
I think we need more detailed testing, in particular showing how max_count plays with order, start and end query parameters. Expectation would be that max_count respects constraints of other parameters as well. It is also not clear how max_count should behave together with order. Possible scenarios:
max_count = n=> n most recent txs in descending ordermax_count = n, order = descending=> n most recent txs in descending ordermax_count = n, order = ascending=> n most recent txs in ascending order or n oldest transactions in ascending order (requirements are not percise)max_count = n, start = date=> n most recent txs from start date in descending ordermax_count = n, start = date, order = descending=> n most recent txs from start date in descending ordermax_count = n, start = date, order = ascending=> n most recent txs from start date in ascending order or n oldest transactions starting from start date in ascending order (requirements are not percise)max_count = n, end = date=> n most recent txs not older than end date in descending ordermax_count = n, end = date , order = descending=> n most recent txs not older than end date in descending ordermax_count = n, end = date , order = ascending=> n most recent txs not older than end date in descending order or n oldest transactions not older than end date in ascending order (requirements are not percise)max_count = n, start = date1, end=date2=> n most recent txs from start date, not older than end date in descending ordermax_count = n, start = date1, end=date2, order=descending=> n most recent txs from start date, not older than end date in descending ordermax_count = n, start = date1, end=date2, order=ascending=> n most recent txs from start date, not older than end date in ascending order or n oldest transactions starting from start date and not older than end date in ascending order (requirements are not percise)
There was a problem hiding this comment.
covered in unit tests
| -> (Maybe UniformTime, Maybe UniformTime) | ||
| -> [(Tx, TxMeta)] | ||
| -> Property | ||
| walletListTransactionsLimited wallet@(wid, _, _) _order (_mstart, _mend) history = |
There was a problem hiding this comment.
Suggested change
| walletListTransactionsLimited wallet@(wid, _, _) _order (_mstart, _mend) history = | |
| walletListTransactionsWithLimit wallet@(wid, _, _) _order (_mstart, _mend) history = |
lib/wallet/api/http/Cardano/CLI.hs
Outdated
| @@ -916,6 +916,7 @@ data TransactionListArgs = TransactionListArgs | |||
| , _timeRangeEnd :: Maybe Iso8601Time | |||
| , _sortOrder :: Maybe SortOrder | |||
| , _schema :: TxMetadataSchema | |||
| , _limit :: Maybe Int | |||
There was a problem hiding this comment.
Question: is the behaviour defined for negative values?
If there's no reason to support negative values, then perhaps we could use Natural or Word here?
There was a problem hiding this comment.
No we are not offering a negative number of results, this is just a wallet :-)
paolino
force-pushed
the
paolino/ADP-2788/add-max-count-to-get-txs
branch
2 times, most recently
from
a5974e1
to
5da3855
Compare
paolino
force-pushed
the
paolino/ADP-2788/add-max-count-to-get-txs
branch
from
5da3855
to
b981c97
Compare
|
bors try |
piotr-iohk
approved these changes
Mar 9, 2023
tryBuild failed: |
|
bors retry |
tryBuild failed: |
|
bors r+ |
|
Build succeeded: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
-- add an optional max_count parameter to the listTransactions API call
ADP-2788