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

clarify decimal input and hexadecimal api response #2786

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

oeggert
Copy link
Collaborator

@oeggert oeggert commented Sep 23, 2024

No description provided.

@@ -57,7 +57,7 @@ Creates a new `Oracle` ledger entry or updates the fields of an existing one, us
|---------------------|-----------|---------------|-----------|-------------|
| `BaseAsset` | String | Currency | Yes | The primary asset in a trading pair. Any valid identifier, such as a stock symbol, bond CUSIP, or currency code is allowed. For example, in the BTC/USD pair, BTC is the base asset; in 912810RR9/BTC, 912810RR9 is the base asset. |
| `QuoteAsset` | String | Currency | Yes | The quote asset in a trading pair. The quote asset denotes the price of one unit of the base asset. For example, in the BTC/USD pair, BTC is the base asset; in 912810RR9/BTC, 912810RR9 is the base asset. |
| `AssetPrice` | Number | UInt64 | No | The asset price after applying the `Scale` precision level. It's not included if the last update transaction didn't include the `BaseAsset`/`QuoteAsset` pair. |
| `AssetPrice` | Number | UInt64 | No | The asset price after applying the `Scale` precision level. It's not included if the last update transaction didn't include the `BaseAsset`/`QuoteAsset` pair. Must be in decimal format. |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally it should be hexadecimal because Json integer value doesn't support a value greater that max uint.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oeggert, I spoke to Greg, and here is a suggestion. We could say that it's recommended to always provide the value in hexadecimal. If the XRPL libraries (js, py, etc.) are used to execute this transaction API, they convert a decimal input to hexadecimal values but the API takes hexadecimal. I am clarifying with the DGE team what happens if the value is more than the maximum int 32.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about something like this:

The rippled API takes this value in hexadecimal format; client libraries will convert decimal values to hexadecimal, but you'll receive <insert error/transaction failure> if you submit a number larger than the max UInt.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm skeptical that passing the value in hexadecimal will even work as intended, if the problem is that number literals are losing precision in being converted to JavaScript's native double (floating point) format.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a string value. No need to convert.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a clarification to the Price Oracles to specify AssetPrice as decimal
4 participants