feat(sdk): export NfdApiClient and enhance reverseLookup #2
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
Export the `NfdApiClient` class from the SDK to allow direct usage for API-only integrations. Standardize type definitions by: - Replacing `NfdRecord` with `Nfd` type across the codebase - Adding `SearchResponse` type for consistent search results - Omitting `nocache` parameter from `getNfd` options - Updating method return types for better type safety This change enables integrators to use the API client directly when they only need search and lookup functionality, while maintaining the recommended approach of using `NfdClient` for full SDK capabilities.
Add a new example project demonstrating how to use the NFD SDK's API client to search for NFDs using various criteria. This example showcases: - Searching NFDs by substring, owner address, category, and state - Pagination of search results - Displaying NFD details with expandable JSON data - Both recommended and alternative approaches to using the API client
Improve the `reverseLookup` method in the NFD SDK with: - Automatic chunking of addresses (max 20 per request) - Parallel processing of address chunks - Prioritization of verified NFDs over unverified ones - Robust error handling for 404 responses - Filtering of empty addresses before processing
Add a new example demonstrating how to look up NFDs by wallet address: - Support for multiple wallet addresses - Option to allow unverified NFDs - Configurable view options (tiny, thumbnail, brief, full) - Display of lookup results with key NFD information - Error handling and loading states
- Add concise code examples to each example project README - Demonstrate core SDK functionality with simplified syntax - Standardize README structure across all examples - Update section headings for consistency - Add "About the NFD SDK" section to all examples
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.
Description
This PR enhances the NFD SDK by exporting the
NfdApiClientclass directly and improving thereverseLookupmethod with address chunking and prioritization. It also adds two new example projects demonstrating API client usage.Details
NfdApiClientclass to allow direct usage for API-only integrationsNfdRecordwithNfdtype across the codebasereverseLookupmethod with automatic chunking of addresses (max 20 per request)