chore: added detailed and accurate samples for nodejs #22
Conversation
This file contains 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
johnquinnvictaboada
changed the title
scarmuega
approved these changes
Sep 5, 2024
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:
Updated Documentation: The documentation for the UTxORPC Node.js SDK has been revised to provide a more comprehensive and structured overview of the SDK's capabilities and usage.
Introduction and Overview: Replaced the initial broad description with a more detailed introduction outlining the SDK's features and primary clients, including
SyncClient,QueryClient, andSubmitClient.Detailed Examples: Added specific examples for each client:
SyncClient: Examples for following the tip and fetching blocks.QueryClient: Examples for reading blockchain parameters and searching UTXOs by address.SubmitClient: Example for submitting transactions, with an emphasis on handling the transaction hash.API Reference: Provided a detailed API reference for each client, including constructors, methods, and their functionalities.
Conclusion: Enhanced the conclusion to summarize the SDK's purpose and its utility for interacting with UTxORPC.