feat!: use branded number types #49
Merged
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
silasbw
approved these changes
Apr 14, 2023
| export function toDecimalNumber(value: BigNumber.Value): DecimalNumber | ||
| // Convert bigint balances from ERC20 contracts to decimal numbers | ||
| export function toDecimalNumber(value: bigint, decimals: number): DecimalNumber | ||
| export function toDecimalNumber( |
There was a problem hiding this comment.
I was kinda confused by the "cast" implementation because it's behavior is so different from the "shiftedBy" one. I think it would be slightly less confusing to drop the cast one and just us as directly.
dievazqu
approved these changes
Apr 18, 2023
|
🎉 This PR is included in version 3.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
All balances and prices are now required to be
DecimalNumberorSerializedDecimalNumber.DecimalNumberuses BigNumber under the hood, for arbitrary precision arithmetic.SerializedDecimalNumberare stored as a strings with a maximum of 20 decimals. To avoid responses with too many decimals.These were implemented using branded types. See https://michalzalecki.com/nominal-typing-in-typescript/.
The plugin interface has been updated to reflect this.
This should avoid confusion where previously balances could be in decimal format or as whole (large integer) numbers returned from ERC20 contracts.
An explicit call
toDecimalNumber,toSerializedDecimalNumberor castas DecimalNumberis needed, to satisfy the compiler. Making us think twice about what we are doing.Let me know what you think.