-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Make XRPFees a non-breaking API change #4425
Comments
changing how? |
Ideally, the PR and the amendment would not affect any values returned by the API, so client libraries and other integrations don't need to update. In cases where we do make a change, it would ideally be additive; i.e. add a new field with the nicely-formatted values. We can mark/document some existing fields as deprecated. Then, in 1-2 years, we remove them. In cases where we make a breaking change today (i.e. an existing field goes away or its value changes), it should be very deliberate and necessary. I don't think that's the case here, where the PR and amendment are purely "cleanup" - it doesn't address any specific user feedback or problems, and it doesn't add any new functionality. |
* Original changes: XRPLF@e4b17d1 * Resolves XRPLF#4425
I was incorrect in thinking this amendment changed |
* Original changes: XRPLF@e4b17d1 * Resolve XRPLF#4425
Issue Description
#4247 introduces an amendment,
featureXRPFees
(XRPFees
for short), and causes some breaking API changes.The motivations for the amendment:
XRPAmount
for all fees. Scaling/adjusting of fees can operate directly onXRPAmount
objects instead.XRPFees
converts all representations of fees in the code, ledger, and protocol intoXRPAmount
s.Currently, in the FeeSettings singleton object,
BaseFee
is serialized as hexadecimal;ReferenceFeeUnits
,ReserveBase
,ReserveIncrement
are serialized as integers (when they would make more sense as strings because they are XRP amounts).With
XRPFees
, the replacement fields are namedBaseFeeDrops
,ReserveBaseDrops
, andReserveIncrementDrops
, and they are all XRP amounts serialized as strings.It appears that there are likely impacts to
server_info
,SetFee
(transaction type) txs and Subscription messages for theledger
andvalidations
stream.Expected Result
Ideally, gain the benefits of
XRPFees
without the downside of breaking existing API consumers + client libraries.Actual Result
Some field names and types have changed in the APIs, which would break existing integrations and client library versions.
XRPFees
: Fee setting and handling improvements #4247 can cause.Contexts
Related
featureXRPFees
amendment xrpl.js#2219The text was updated successfully, but these errors were encountered: