sdk: improve type safety + add documentation #1102
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
evan-gray
requested changes
Apr 22, 2022
kcsongor
force-pushed
the
sdk-type-improvements
branch
5 times, most recently
from
e7f6df0 to
8d35eaa
Compare
evan-gray
force-pushed
the
sdk-type-improvements
branch
from
4bfbb59 to
5c4a6d9
Compare
✅ Deploy Preview for tubular-dango-1656b2 canceled.
|
✅ Deploy Preview for roaring-moonbeam-aa0ca5 canceled.
|
evan-gray
force-pushed
the
sdk-type-improvements
branch
3 times, most recently
from
12d38d4 to
b040fd0
Compare
added 6 commits
May 5, 2022 10:32
This is a legit chain id that some governance VAAs target
evan-gray
force-pushed
the
sdk-type-improvements
branch
from
b040fd0 to
986b32a
Compare
evan-gray
force-pushed
the
sdk-type-improvements
branch
from
986b32a to
683e733
Compare
evan-gray
previously approved these changes
May 5, 2022
kcsongor
commented
May 5, 2022
evan-gray
force-pushed
the
sdk-type-improvements
branch
from
683e733 to
063655c
Compare
evan-gray
previously approved these changes
May 5, 2022
evan-gray
force-pushed
the
sdk-type-improvements
branch
from
063655c to
a6f2b8c
Compare
panoel
approved these changes
May 5, 2022
evan-gray
approved these changes
May 5, 2022
bruce-riley
pushed a commit
that referenced
this pull request
May 25, 2022
* sdk/js: improve type safety + add documentation * sdk/js: add support for chain names * sdk/js: fix boolean conditional bug in transferFromSolana * sdk/js: remove unsafe ChainId coercions in sdk * sdk/js: Chain id 0 This is a legit chain id that some governance VAAs target * sdk/js: Add mainnet and testnet contract addresses * sdk/js: bump version to 0.3.0 * sdk/js: limit minor version changes * sdk/js: update contracts and add devnet Co-authored-by: Csongor Kiss <ckiss@jumptrading.com> Co-authored-by: Evan Gray <battledingo@gmail.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.
The main goal of this PR is to improve the type safety of some of the sdk functionality.
isEVMChainnow performs type refinement. This way, we can achieve exhaustivity checking in downstream code that relies on this check.nullvalue is returned from using the functions in an intended way (that is, passing in well-typed arguments). This obviates the need for callers to coalesce null cases to values like""which results in a debugging nightmare.Promise<any>, which is not that helpful.This change is