Improve test coverage and add troubleshooting docs#491
Open
Dark-Brain07 wants to merge 7 commits intostx-labs:mainfrom
Open
Improve test coverage and add troubleshooting docs#491Dark-Brain07 wants to merge 7 commits intostx-labs:mainfrom
Dark-Brain07 wants to merge 7 commits intostx-labs:mainfrom
Conversation
…sMobile functions
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
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
Hey, I was going through the connect package and noticed test coverage was pretty limited - just 2 test files for the whole thing. Also there wasn't really any troubleshooting guide for developers running into issues.
So I added tests for the utility functions that weren't covered (things like network conversion, Clarity value handling, Taproot address detection), improved the docs with better JSDoc comments, and wrote up a troubleshooting section in the README covering the common problems I've seen developers run into.
I also threw in a few extra error codes that seemed useful and a helper function to make error handling cleaner.
Changes:
Type of Change
Does this introduce a breaking change?
Nope, everything is additive. No breaking changes.
Are documentation updates required?
Testing information
Checklist