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

Enhancement Request: Separate OpenSeaSDK Parameters for NFT Endpoints and Marketplace Endpoints #1569

Open
MuhammadMinhaj opened this issue Oct 8, 2024 · 1 comment
Labels
dev-feature-request features devs want to see

Comments

@MuhammadMinhaj
Copy link

Component

API

Describe the feature you would like

Hello OpenSea team,

We appreciate the support provided for both NFT Endpoints and OpenSea Marketplace Endpoints in the OpenSea SDK (opensea-js). Based on the documentation, we understand that after creating an instance of OpenSeaSDK, we can access the NFT Endpoints via sdkInstance.api.[endpoint method] and the OpenSea Marketplace Endpoints via sdkInstance.[Marketplace Endpoints methods].

Currently, to create an instance of OpenSeaSDK, we are required to provide (signerOrProvider: Signer | JsonRpcProvider) as a parameter, regardless of whether we need access to the OpenSea Marketplace Endpoints or not.

However, in scenarios where we only need to interact with the NFT Endpoints, it seems unnecessary to provide (signerOrProvider: Signer | JsonRpcProvider) since these endpoints don't require signing or provider capabilities. This adds extra complexity when using only the NFT APIs.

I would like to propose separating the parameter requirements for accessing the NFT Endpoints, allowing developers to instantiate the OpenSeaSDK without providing signerOrProvider when only interacting with NFT Endpoints. This would simplify the integration for NFT-focused use cases and improve overall developer experience.

Thank you for considering this enhancement!

Additional context

Screenshot 2024-10-09 013951

@MuhammadMinhaj MuhammadMinhaj added the dev-feature-request features devs want to see label Oct 8, 2024
@ryanio
Copy link
Collaborator

ryanio commented Nov 4, 2024

thanks for the suggestion. we will keep this in mind for future major versions of opensea-js

@ryanio ryanio mentioned this issue Nov 4, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-feature-request features devs want to see
Projects
None yet
Development

No branches or pull requests

2 participants