feat(sdk): add NfdManager w/ linkAddress and setMetadata #1
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
This utility provides user-friendly error messages for common Algorand transaction errors: - Adds `parseTransactionError` function that uses regex-based parsing for specific error types - Extracts detailed information for errors like insufficient balance (including account address, available balance, and required balance) - Provides `withErrorParsing` higher-order function to wrap async functions with error parsing - Includes documentation and examples for better understanding
This commit introduces the `NfdManager` class to provide direct management capabilities for NFDs: - Adds `linkAddress` method to connect Algorand addresses to an NFD - Adds `unlinkAddress` method to remove linked addresses - Adds `setMetadata` method to manage user-defined metadata - Implements utility functions for byte array operations - Integrates with error parser for user-friendly error messages - Exposes manager functionality through the `NfdClient.manage()` method
This commit adds two new example projects demonstrating core NFD SDK features: - `link-address`: Demonstrates how to link and unlink Algorand addresses to NFDs - `set-metadata`: Shows how to set, update, and delete user-defined metadata with support for multiple fields in a single transaction Both examples include: - Complete React-based UI with wallet connection - Error handling using the new transaction error parser - Comprehensive README files with setup and usage instructions - Proper fee handling to ensure transactions succeed
drichar
changed the title
Update the site names in the wallet manager configuration for the link-address and set-metadata examples to correctly reflect their respective purposes instead of using "NFD SDK Mint Example".
Add explicit 'public' modifiers to the `linkAddress`, `unlinkAddress`, and `setMetadata` methods in the `NfdManager` class for better code readability and consistency with TypeScript best practices.
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 introduces the
NfdManagerclass to the NFD SDK, providing direct management capabilities for NFDs. It adds support for linking/unlinking Algorand addresses to NFDs and managing user-defined metadata, along with two new example applications demonstrating these features.Details
NfdManagerclass with methods for:linkAddress: Connect Algorand addresses to an NFDunlinkAddress: Remove linked addressessetMetadata: Manage user-defined metadatalink-address: Demonstrates linking and unlinking Algorand addressesset-metadata: Shows how to set, update, and delete user-defined metadata with support for multiple fields in a single transactionNfdClient.manage()method