feat: default unitsToFill to 1 for offers and listings, add includePrivateListings parameter #1809
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
Changes the SDK to always default `unitsToFill` to "1" for both listings and offers, providing consistent behavior across order types. Previously: - Listings: defaulted to remaining_quantity (API-side) - Offers: defaulted to 1 (API-side) - SDK sent undefined when not specified Now: - SDK always sends "1" when unitsToFill is not specified - Consistent default behavior for both listings and offers - Cleaner implementation with default parameters in utility functions Changes: - Updated JSDoc comments to reflect new behavior - Modified fulfillment.ts to default to "1" instead of undefined - Refactored getFulfillListingPayload and getFulfillOfferPayload to use default parameters and always include units_to_fill - Updated tests to verify new default behavior - Bumped version to 8.0.5 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Update test expectations to include units_to_fill: "1" in the expected payloads, reflecting the new default behavior. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Add support for include_private_listings query parameter to getBestListing API method. This allows the integration test to fetch private listings when needed, fixing the "No listings found" error. Changes: - Added includePrivateListings optional parameter to getBestListing in ListingsAPI and OpenSeaAPI - Updated integration test to use include_private_listings=true - Updated JSDoc documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
…and getNFTListings
Add support for include_private_listings query parameter to listing endpoints to match backend API changes.
Changes:
- Added includePrivateListings parameter to getAllListings, getBestListings, and getNFTListings in ListingsAPI
- Updated corresponding public API methods in OpenSeaAPI
- Updated JSDoc documentation for all affected methods
- All tests passing
Aligns SDK with backend PR that adds include_private_listings support to:
- GET /api/v2/listings/collection/{slug}/best
- GET /api/v2/listings/collection/{slug}/nfts/{tokenId}/best
- GET /api/v2/listings/collection/{slug}/all
- GET /api/v2/chain/{chain}/protocol/{protocol}/orders
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
ryanio
changed the title
ryanio
changed the title
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.
Summary
This PR includes two main features:
unitsToFillto"1"for both listings and offersincludePrivateListingsparameter to all listing endpoints to match backend API changesChanges
1. unitsToFill Default Behavior
Before
remaining_quantity(API-side)1(API-side)undefinedwhenunitsToFillwas not specifiedAfter
"1"whenunitsToFillis not specified2. includePrivateListings Parameter
Added support for
include_private_listingsquery parameter to all listing endpoints:getBestListing- get best listing for a specific NFTgetBestListings- get best listings for a collectiongetAllListings- get all listings for a collectiongetNFTListings- get all listings for a specific NFTThis aligns the SDK with backend API changes that add
include_private_listingssupport to:GET /api/v2/listings/collection/{slug}/bestGET /api/v2/listings/collection/{slug}/nfts/{tokenId}/bestGET /api/v2/listings/collection/{slug}/allGET /api/v2/chain/{chain}/protocol/{protocol}/ordersModified Files
unitsToFill Changes:
src/sdk.ts,src/sdk/fulfillment.ts, andsrc/api/api.tssrc/sdk/fulfillment.tsunitsToFillto"1"instead ofundefinedsrc/orders/utils.tsgetFulfillListingPayloadandgetFulfillOfferPayloadto use default parametersunits_to_fillfrom optional to required in payload typesunits_to_fillin payload (no conditional check)test/sdk/fulfillmentManager.spec.tsandtest/orders/utils.spec.tsundefinedto"1"includePrivateListings Changes:
src/api/listings.tsincludePrivateListingsparameter togetAllListings,getBestListing,getBestListings, andgetNFTListingssrc/api/api.tsincludePrivateListingsparametertest/integration/fulfillBestListing.spec.tsinclude_private_listings=trueVersion:
package.json8.0.5Test Plan
unitsToFillnow defaults to"1"Notes
BigNumberish(number, BigInt, or string) forunitsToFillfor developer convenience"1"(e.g., defaulting listings to remaining_quantity if needed)includePrivateListingsdefaults tofalsefor backward compatibility