When testing EOS Wallets under #334 I noticed that there are some inconsistent error messages returned for parameters index and addressPoolGap for certain values outside their ranges.
This is observed for endpoints:
Client.postEosWallet
Client.updateEosWallet
For index (range [2147483648..4294967295]):
values 0, 1, 2147483647- Account index should be in range [2147483648..4294967295]
values -1, 4294967296 - Word32 is either floating or will cause over or underflow
For addressPoolGap (range [10..100]):
values 1, 0, 9, 101 - Address pool gap should be in range [10..100]
value -1 - Word8 is either floating or will cause over or underflow: -1.0
Make API return consistent and informative error message when index and addressPoolGap is off the range, i.e.:
Account index should be in range [2147483648..4294967295] - for index
Address pool gap should be in range [10..100] - for addressPoolGap
Acceptance Criterias
The API must return consistent error messages for index and addressPoolGap as described above.
The change would affect following integration tests that will need to have their expectations updated:
EOSWALLETS_CREATE_02 - addressPoolGap cannot be outside [10..100]
EOSWALLETS_CREATE_03 - index must be [2147483648..4294967295]
EOSWALLETS_UPDATE_03 - addressPoolGap cannot be outside [10..100]
Context
When testing EOS Wallets under #334 I noticed that there are some inconsistent error messages returned for parameters
indexandaddressPoolGapfor certain values outside their ranges. This is observed for endpoints:Client.postEosWalletClient.updateEosWalletFor
index(range [2147483648..4294967295]):Account index should be in range [2147483648..4294967295]Word32 is either floating or will cause over or underflowFor
addressPoolGap(range [10..100]):Address pool gap should be in range [10..100]Word8 is either floating or will cause over or underflow: -1.0As explained in https://github.com/input-output-hk/cardano-wallet/pull/334#discussion_r257114227 this is currently expected, however, I believe the messages should be consistent here and informative therefore we should make the API return the message
... should be in range...for every value outside of the range.Decision
Make API return consistent and informative error message when
indexandaddressPoolGapis off the range, i.e.:Account index should be in range [2147483648..4294967295]- forindexAddress pool gap should be in range [10..100]- foraddressPoolGapAcceptance Criterias
The API must return consistent error messages for
indexandaddressPoolGapas described above. The change would affect following integration tests that will need to have their expectations updated:Development Plan
PR
developQA
Retrospective