docs: improve formats parameter description for offchain users#3449
Merged
nidhi-singh02 merged 2 commits intomainfrom Feb 9, 2026
Merged
docs: improve formats parameter description for offchain users#3449nidhi-singh02 merged 2 commits intomainfrom
nidhi-singh02 merged 2 commits intomainfrom
Conversation
Co-Authored-By: Nidhi Singh <nidhi2894@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
5 Skipped Deployments
|
| - `priceFeedIds` is the list of price feeds to receive price data for. It will also include the verified payloads for the price feeds. Refer to the [Price Feed IDs list](/price-feeds/pro/price-feed-ids) for the supported price feeds. | ||
| - `properties` is the list of properties to retrieve, such as **price**, **bestBidPrice**, **bestAskPrice**, etc. | ||
| - `formats`(formerly known as `chains`) is the list of chains to receive a signed payload for, such as **evm**, **solana**, etc. | ||
| - `formats`(formerly known as `chains`) specifies the binary encoding format for the payload. This field is mandatory, but can be set to an empty array (e.g., `formats: []`) if no binary payload is needed. Use **evm** or **solana** to receive a signed payload for onchain verification, or **leUnsigned** for offchain-only use without signatures. See [Binary Formats & Signature Schemes](#binary-formats--signature-schemes) for all options. |
Contributor
There was a problem hiding this comment.
clicking on the hyperlinks takes me to same page, it should take to the relevant page and section.
Contributor
Author
There was a problem hiding this comment.
Fixed — the anchor was pointing to a section on the same page that doesn't exist. Updated the link to /price-feeds/pro/payload-reference#binary-formats--signature-schemes so it navigates to the Binary Formats section on the Payload Reference page.
…ge anchor Co-Authored-By: Nidhi Singh <nidhi2894@gmail.com>
nidhi-singh02
approved these changes
Feb 9, 2026
alexcambose
approved these changes
Feb 9, 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
2 participants
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.
Summary
Updates the
formatsparameter description on the Subscribe to Prices page to be clearer for offchain users.The old description framed
formatspurely as a chain selector ("list of chains to receive a signed payload for"), which was confusing for offchain consumers. The new description:formatscontrols the binary encoding format of the payloadformats: []) when no binary payload is neededleUnsignedas the offchain-only optionRationale
Recent offchain customers found the existing description unintuitive since it only referenced chains and signed payloads, with no mention of the offchain use case or the ability to pass an empty array.
Updates since last revision
#binary-formats--signature-schemes) to a cross-page link (/price-feeds/pro/payload-reference#binary-formats--signature-schemes) since the section lives on the Payload Reference page, not on the Subscribe to Prices page.How has this been tested?
This is a documentation-only change (single line in an MDX file). No functional code is affected.
Review checklist
#binary-formats--signature-schemesresolves correctly on the Payload Reference page (the&in the heading "Binary Formats & Signature Schemes" produces a double hyphen in the slug — confirm this matches)formatsis indeed mandatory and thatformats: []is a valid value per the APILink to Devin run: https://app.devin.ai/sessions/35a898029ea8449cbd657d84eb357792
Requested by: @nidhi-singh02