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

Document support in v1.3.2 for large JSON numbers #1577

Merged
merged 4 commits into from
Sep 13, 2024

Conversation

matthew1001
Copy link
Contributor

See issue #1568

This PR documents the new large-number support. For convenience, here's a preview of the updated topic:

image

@matthew1001 matthew1001 requested a review from a team as a code owner September 12, 2024 09:11
Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.75%. Comparing base (4f64fd9) to head (dfdbb37).
Report is 17 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##              main    #1577      +/-   ##
===========================================
- Coverage   100.00%   99.75%   -0.25%     
===========================================
  Files          325      338      +13     
  Lines        24055    24223     +168     
===========================================
+ Hits         24055    24164     +109     
- Misses           0       58      +58     
- Partials         0        1       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@matthew1001 matthew1001 mentioned this pull request Sep 12, 2024
## Maximum size of numbers in versions of FireFly up to `v1.3.1`
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good but I wouldn't only had this section in the ffbigint description as it's quite nested down in the documentation under reference. We need to document this in two other places:

  • Doc around invoking a smart contract through the API
  • Release notes for v1.3.2

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

For example you can see in the simple invoke EVM contract tutorial we use a number https://hyperledger.github.io/firefly/latest/tutorials/custom_contracts/ethereum/#invoke-the-smart-contract

- Support for JSON numbers larger than `2^53-1`
See [FFBigInt](../reference/types/simpletypes.md#ffbigint)
- Ability to install FireFly CLI with Brew for MacOS users
See [Brew](../)
Copy link
Contributor

Choose a reason for hiding this comment

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

missing the link here to brew

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bah, my bad.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Think that's gated on #1572 merging? Assuming that PR merges as-is, the latest commit should be correct for the new brew docs

Signed-off-by: Matthew Whitehead <[email protected]>
@EnriqueL8
Copy link
Contributor

EnriqueL8 commented Sep 13, 2024

LGTM - Will fix codecov in a follow up PR

@EnriqueL8 EnriqueL8 merged commit a948899 into hyperledger:main Sep 13, 2024
16 of 17 checks passed
@EnriqueL8 EnriqueL8 mentioned this pull request Sep 18, 2024
5 tasks
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.

2 participants