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

Updated documented JSON API encoding for decimals #15725

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

HilaryYates
Copy link

Fixes #15302

I updated the JSON API docs for decimals, which were outdated. Now, it states (as per LF numerics ), that the fixpoint can be anywhere within the digits except at the start.

see https://github.com/digital-asset/daml/blob/main/daml-lf/transaction/src/main/protobuf/com/daml/lf/value.proto#L39-L48

@digitalasset-cla
Copy link
Member

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


hilaryyates seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Comment on lines +39 to +40
// Between v1 and v5 this field expressed a number in base-10 with a
// fixed point anywhere within the digits except at the start.
Copy link
Collaborator

@remyhaemmerle-da remyhaemmerle-da Nov 29, 2022

Choose a reason for hiding this comment

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

Thanks for taking care of thank, however :

  • As far I know this is not use by the JSON API. It is use to persists value in the DB and communicate data between participant.
  • Since LF: Kill deprecated Transaction versions #7785 (basically SDK 2.0) we do not support anymore versions 1 to 5, so the comment is now useless. It is probably better to just drop it complelty.

Copy link
Collaborator

@remyhaemmerle-da remyhaemmerle-da left a comment

Choose a reason for hiding this comment

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

Please:

  • Drop the comment complelty
  • Change the title to something like "[LF] Drop outdated documentation in Ledger values proto."

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.

Update documented JSON API encoding for decimals
3 participants