Clarify JSDoc for orderBy eth_price requirement (addresses #1752) #1774
Conversation
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
Updates documentation for getOrder and getOrders to clarify that when using orderBy: "eth_price", the asset_contract_address and token_ids parameters must also be provided, as noted in the API documentation. Fixes the confusion raised in #1752 without removing the parameters. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Throw descriptive error when orderBy is "eth_price" but required params are missing - Added validation to both getOrder and getOrders methods - Error message clearly indicates both asset_contract_address and token_ids are required - This provides early error detection before API call 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Remove Abstract, ApeChain, Blast, and Zora exclusions - Keep only Solana excluded (no NFT collections) - Test now runs for all chains except Solana 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
ryanio
force-pushed
the
fix/clarify-order-by-eth-price-docs
branch
from
9e1c896 to
d1cc38c
Compare
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.
Motivation
PR #1752 raised concerns about the
orderBy: "eth_price"parameter throwing errors. Rather than removing the parameter documentation as suggested in that PR, this properly clarifies the requirement.Solution
Updated JSDoc comments for both
getOrderandgetOrdersto clearly document that:orderBy: "eth_price", you must also provideasset_contract_addressandtoken_idsparametersTesting
Related
As noted by @ryanio: "The order in which to sort the results. Default: created_date NOTE: If eth_price is used, asset_contract_address and token_id are required."
🤖 Generated with Claude Code
Co-Authored-By: Claude [email protected]