Improve readability and error messages #15
Merged
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
|
@victorkirov Rebased and ready to be reviewed. Depending on how you wanna treat error messages, some of these changes could be considered breaking. If you prefer, I could combine this PR with #16, just let me know. |
victorkirov
approved these changes
Jul 7, 2023
There was a problem hiding this comment.
The error messages are definitely better 👍 @yknl could you take a look at this one? As Matías mentioned, this could potentially break code that's matching on the error message in a catch.
|
@victorkirov Thank you for updating the branch! |
|
@victorkirov Given that other breaking changes were merged to I'd then rebase #16 and would love if you could give me feedback on it then. |
yknl
reviewed
Jul 13, 2023
yknl
approved these changes
Jul 14, 2023
m-aboelenein
added a commit
that referenced
this pull request
Aug 29, 2023
* added signMessage method to provider * throw error on missing options * Include send btc transaction function * Remove console.log * convert to amountSats * make message optional * Allow to pass a custom Bitcoin provider (#14) * Allow to pass a custom Bitcoin provider * Extract GetBitcoinProviderFunc type * Add senderAddress and allow multiple recipients (#10) * Add senderAddress and allow multiple recipients * Use Recipient in payload * Use bigint type for amountSats * Improve readability and error messages (#15) * Improve readability * Clean up error messages * Remove duplicate line * Improve error message --------- Co-authored-by: Victor Kirov <victor.kirov@gmail.com> * Add NPM pull request preview publish github workflow (#22) * Add NPM pull request preview publish github workflow * Add NPM pull request preview publish github workflow * fix build script * add npmrc file * add npm token * add npmrc file * change package repository to npm * update release workflow * release v0.5.0 (#23) * Improve APIs and types (BREAKING) (#16) * Remove unused type * Rename AddressPurposes enum for best practices * Extract call types into separate file * Remove unused CallMethod enum * Extract provider types into separate file * Rename directories for consistency * Rename sendBtcTransaction -> sendTransaction * Extract transactions types to separate file * Extract networks module * Improve types * Use [] instead of Array<> for consistency * Fix copy-paste oversight * Move index.ts inside src * Use import type for types * Revert sendBtcTransaction -> sendTransaction renaming * Simplify types --------- Co-authored-by: Victor Kirov <victor.kirov@gmail.com> * Fix bigInt serialisation Issue (#25) * serialize recipient array * Fix AddressPurposes type * Revert AddressPurpose name change * Rename const * Check recipient type * chore: npm publish with prerelease tag if prerelease option selected (#27) * chore: update release-package.yml syntax (#28) * Release v1.0.0 (#24) release v1.0.0 Co-authored-by: Tim Man <tim@secretkeylabs.com> --------- Co-authored-by: Ken Liao <yukanliao@gmail.com> Co-authored-by: Imamah-Zafar <imamah.zafar@tintash.com> Co-authored-by: Duska.T <55587184+DuskaT021@users.noreply.github.com> Co-authored-by: Matías Olivera <moliverafreire@gmail.com> Co-authored-by: Imamah-Zafar <88320460+Imamah-Zafar@users.noreply.github.com> Co-authored-by: Victor Kirov <victor.kirov@gmail.com> Co-authored-by: Tim Man <tim@secretkeylabs.com>
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
This PR improves general readability (mostly adding whitespaces and removing dead code) and brings consistency to error messages.
Depends on #14.