docs: document jsonStringify for writing and clarify the .0 integer convention - #332
Open
aelmanaa wants to merge 1 commit into
Open
docs: document jsonStringify for writing and clarify the .0 integer convention#332aelmanaa wants to merge 1 commit into
aelmanaa wants to merge 1 commit into
Conversation
|
You must have Developer access to commit code to Chainlink Labs on Vercel. If you contact an administrator and receive Developer access, commit again to see your changes. Learn more: https://vercel.com/docs/accounts/team-members-and-roles/access-roles#team-level-roles |
|
👋 aelmanaa, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
Coverage Report |
andrevmatos
approved these changes
Aug 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation to clarify how to handle JSON serialization and integer precision when working with the SDK, especially regarding
bigintvalues. The changes help users avoid common pitfalls when reading and writing JSON with large integers.Improvements to JSON serialization guidance:
jsonStringifyfrom@chainlink/ccip-sdkfor serializing objects containingbigintvalues, since the standardJSON.stringifydoes not supportbigintand throws an error. Also clarified thatjsonParseandjsonStringifyshould be used together to ensure compatibility and full precision.bigintshould be compared tobigintliterals (e.g.,11n) and not tonumberliterals (e.g.,11).Clarifications on integer precision conventions:
.0suffix used byjsonStringifyto indicate safe casting tonumberis a convention, not a requirement; values without the suffix (like2) are still parsed asbigintand accepted by the SDK's public interfaces. This ensures compatibility with sources that do not use the.0suffix, such as Python, Go, and Postgres.