Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Signature Redesign] fix Error: new BigNumber() number type has more than 15 significant digits: 3.000123123123121e+26 #25751

Closed
9 tasks
digiwand opened this issue Jul 10, 2024 · 0 comments · Fixed by #25741
Assignees
Labels
release-12.1.0 Issue or pull request that will be included in release 12.1.0 release-12.3.0 Issue or pull request that will be included in release 12.3.0 team-confirmations Push issues to confirmations team type-bug

Comments

@digiwand
Copy link
Contributor

digiwand commented Jul 10, 2024

What is this about?

On the redesign signature pages, an error displays when the value in the parsed message or the calculation to insert the tokenDecimals exceeds 15 digits. This happens for both the simulation and the data tree value display. We need to fix the error message and fix the precision.

CleanShot 2024-07-10 at 01 14 52

Related: #25438

Scenario

No response

Design

No response

Technical Details

No response

Threat Modeling Framework

No response

Acceptance Criteria

No response

Stakeholder review needed before the work gets merged

  • Engineering (needed in most cases)
  • Design
  • Product
  • QA (automation tests are required to pass before merging PRs but not all changes are covered by automation tests - please review if QA is needed beyond automation tests)
  • Security
  • Legal
  • Marketing
  • Management (please specify)
  • Other (please specify)

References

No response

@digiwand digiwand added type-bug team-confirmations Push issues to confirmations team release-12.1.0 Issue or pull request that will be included in release 12.1.0 labels Jul 10, 2024
@digiwand digiwand self-assigned this Jul 10, 2024
@github-project-automation github-project-automation bot moved this to To be fixed in Bugs by team Jul 10, 2024
@github-project-automation github-project-automation bot moved this to To be fixed in Bugs by severity Jul 10, 2024
@digiwand digiwand changed the title [Signature Redesign] Permit: Incorrect precision and fix Error: new BigNumber() number type has more than 15 significant digits: 3.000123123123121e+26 [Signature Redesign] fix Error: new BigNumber() number type has more than 15 significant digits: 3.000123123123121e+26 Jul 10, 2024
@github-project-automation github-project-automation bot moved this from To be fixed to Fixed in Bugs by severity Jul 12, 2024
@github-project-automation github-project-automation bot moved this from To be fixed to Fixed in Bugs by team Jul 12, 2024
@metamaskbot metamaskbot added the release-12.3.0 Issue or pull request that will be included in release 12.3.0 label Jul 12, 2024
digiwand added a commit that referenced this issue Jul 12, 2024
…25741)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

Plan is to cherry-pick this PR for V12.1
- Adds ellipsis to Permit value
- Fixes error:
```
BigNumber Error: new BigNumber() number type has more than 15 significant digits
```

Note that the precision is lost through formatAmount. Fix will be added
#25755

Most file updates are snapshot updates

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/25741?quickstart=1)

Fixes: MetaMask/MetaMask-planning#2730
(ellipsis)
Fixes: #25751
(Error)

- `JSON.parse` coerces number values into scientific notation if they
are greater than Number.MAX_SAFE_INTEGER, which is the max safe integer
in JavaScript.
e.g. 30001231231212312138768 → 3.0001231231212312e+22
- `JSON.parse` reviver cannot help since the value will be coerced by
the time it
 reaches the reviver function.
- We preserve the value by extracting the value with a regex and
overwriting the `JSON.parse` value. The preserved value should never be
converted to a JavaScript number since it will lose its precision.
Instead, we can preserve the value as a string, BigNumber, or Numeric
type. BigInt also has rounding limitations.
- BigNumber errors out when constructed with numbers with 15+ digits. It
can accept strings to preserve digits.
- formatAmount in
`ui/pages/confirmations/components/simulation-details/formatAmount.ts`
utilizes Intl.NumberFormat, which requires a BigInt or number passed to
it causing a loss in precision when computing large numbers. It does not
accept strings. Currently, it will display 0s for the digits after 15
digits.
e.g. 30001231231212312138768 → 30,001,231,231,212,312,000,000
Issue ticket to address this
#25755

1. run `yarn storybook`
2. go to
http://localhost:6006/?path=/story/pages-confirmations-confirm-signatures-signedtypeddatav3orv4--permit-story&args=msgParams.data:3.0001231231212312e+22
3. copy and paste the following into data
```
"{\"types\":{\"EIP712Domain\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"},{\"name\":\"chainId\",\"type\":\"uint256\"},{\"name\":\"verifyingContract\",\"type\":\"address\"}],\"Permit\":[{\"name\":\"owner\",\"type\":\"address\"},{\"name\":\"spender\",\"type\":\"address\"},{\"name\":\"value\",\"type\":\"uint256\"},{\"name\":\"nonce\",\"type\":\"uint256\"},{\"name\":\"deadline\",\"type\":\"uint256\"}]},\"primaryType\":\"Permit\",\"domain\":{\"name\":\"MyToken\",\"version\":\"1\",\"verifyingContract\":\"0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC\",\"chainId\":1},\"message\":{\"owner\":\"0x935e73edb9ff52e23bac7f7e043a1ecd06d05477\",\"spender\":\"0x5B38Da6a701c568545dCfcB03FcB875f56beddC4\",\"value\":30001231231212312138768,\"nonce\":0,\"deadline\":50000000000}}"
```

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

![CleanShot 2024-07-10 at 01 14
52](https://github.com/MetaMask/metamask-extension/assets/20778143/7a7ff9e3-07a9-4a3b-b8f4-7f672998cdab)

![CleanShot 2024-07-11 at 00 37
25@2x](https://github.com/MetaMask/metamask-extension/assets/20778143/df6b1f0e-fa12-4b6e-9ae1-0486feb7571a)
![CleanShot 2024-07-11 at 00 37
37@2x](https://github.com/MetaMask/metamask-extension/assets/20778143/faffb8e0-6eae-4ef9-8f3b-c399b7f9f7ae)

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
digiwand added a commit that referenced this issue Jul 12, 2024
…25741)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

Plan is to cherry-pick this PR for V12.1
- Adds ellipsis to Permit value
- Fixes error:
```
BigNumber Error: new BigNumber() number type has more than 15 significant digits
```

Note that the precision is lost through formatAmount. Fix will be added
#25755

Most file updates are snapshot updates

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/25741?quickstart=1)

Fixes: MetaMask/MetaMask-planning#2730
(ellipsis)
Fixes: #25751
(Error)

- `JSON.parse` coerces number values into scientific notation if they
are greater than Number.MAX_SAFE_INTEGER, which is the max safe integer
in JavaScript.
e.g. 30001231231212312138768 → 3.0001231231212312e+22
- `JSON.parse` reviver cannot help since the value will be coerced by
the time it
 reaches the reviver function.
- We preserve the value by extracting the value with a regex and
overwriting the `JSON.parse` value. The preserved value should never be
converted to a JavaScript number since it will lose its precision.
Instead, we can preserve the value as a string, BigNumber, or Numeric
type. BigInt also has rounding limitations.
- BigNumber errors out when constructed with numbers with 15+ digits. It
can accept strings to preserve digits.
- formatAmount in
`ui/pages/confirmations/components/simulation-details/formatAmount.ts`
utilizes Intl.NumberFormat, which requires a BigInt or number passed to
it causing a loss in precision when computing large numbers. It does not
accept strings. Currently, it will display 0s for the digits after 15
digits.
e.g. 30001231231212312138768 → 30,001,231,231,212,312,000,000
Issue ticket to address this
#25755

1. run `yarn storybook`
2. go to
http://localhost:6006/?path=/story/pages-confirmations-confirm-signatures-signedtypeddatav3orv4--permit-story&args=msgParams.data:3.0001231231212312e+22
3. copy and paste the following into data
```
"{\"types\":{\"EIP712Domain\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"},{\"name\":\"chainId\",\"type\":\"uint256\"},{\"name\":\"verifyingContract\",\"type\":\"address\"}],\"Permit\":[{\"name\":\"owner\",\"type\":\"address\"},{\"name\":\"spender\",\"type\":\"address\"},{\"name\":\"value\",\"type\":\"uint256\"},{\"name\":\"nonce\",\"type\":\"uint256\"},{\"name\":\"deadline\",\"type\":\"uint256\"}]},\"primaryType\":\"Permit\",\"domain\":{\"name\":\"MyToken\",\"version\":\"1\",\"verifyingContract\":\"0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC\",\"chainId\":1},\"message\":{\"owner\":\"0x935e73edb9ff52e23bac7f7e043a1ecd06d05477\",\"spender\":\"0x5B38Da6a701c568545dCfcB03FcB875f56beddC4\",\"value\":30001231231212312138768,\"nonce\":0,\"deadline\":50000000000}}"
```

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

![CleanShot 2024-07-10 at 01 14
52](https://github.com/MetaMask/metamask-extension/assets/20778143/7a7ff9e3-07a9-4a3b-b8f4-7f672998cdab)

![CleanShot 2024-07-11 at 00 37
25@2x](https://github.com/MetaMask/metamask-extension/assets/20778143/df6b1f0e-fa12-4b6e-9ae1-0486feb7571a)
![CleanShot 2024-07-11 at 00 37
37@2x](https://github.com/MetaMask/metamask-extension/assets/20778143/faffb8e0-6eae-4ef9-8f3b-c399b7f9f7ae)

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
montelaidev pushed a commit that referenced this issue Jul 12, 2024
…25741)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

Plan is to cherry-pick this PR for V12.1
- Adds ellipsis to Permit value
- Fixes error: 
```    
BigNumber Error: new BigNumber() number type has more than 15 significant digits
```

Note that the precision is lost through formatAmount. Fix will be added
#25755

Most file updates are snapshot updates

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/25741?quickstart=1)

## **Related issues**

Fixes: MetaMask/MetaMask-planning#2730
(ellipsis)
Fixes: #25751
(Error)

## Technical Details

- `JSON.parse` coerces number values into scientific notation if they
are greater than Number.MAX_SAFE_INTEGER, which is the max safe integer
in JavaScript.
e.g. 30001231231212312138768 → 3.0001231231212312e+22
- `JSON.parse` reviver cannot help since the value will be coerced by
the time it
 reaches the reviver function.
- We preserve the value by extracting the value with a regex and
overwriting the `JSON.parse` value. The preserved value should never be
converted to a JavaScript number since it will lose its precision.
Instead, we can preserve the value as a string, BigNumber, or Numeric
type. BigInt also has rounding limitations.
- BigNumber errors out when constructed with numbers with 15+ digits. It
can accept strings to preserve digits.
- formatAmount in
`ui/pages/confirmations/components/simulation-details/formatAmount.ts`
utilizes Intl.NumberFormat, which requires a BigInt or number passed to
it causing a loss in precision when computing large numbers. It does not
accept strings. Currently, it will display 0s for the digits after 15
digits.
e.g. 30001231231212312138768 → 30,001,231,231,212,312,000,000
Issue ticket to address this
#25755

## **Manual testing steps**

1. run `yarn storybook`
2. go to
http://localhost:6006/?path=/story/pages-confirmations-confirm-signatures-signedtypeddatav3orv4--permit-story&args=msgParams.data:3.0001231231212312e+22
3. copy and paste the following into data
```
"{\"types\":{\"EIP712Domain\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"},{\"name\":\"chainId\",\"type\":\"uint256\"},{\"name\":\"verifyingContract\",\"type\":\"address\"}],\"Permit\":[{\"name\":\"owner\",\"type\":\"address\"},{\"name\":\"spender\",\"type\":\"address\"},{\"name\":\"value\",\"type\":\"uint256\"},{\"name\":\"nonce\",\"type\":\"uint256\"},{\"name\":\"deadline\",\"type\":\"uint256\"}]},\"primaryType\":\"Permit\",\"domain\":{\"name\":\"MyToken\",\"version\":\"1\",\"verifyingContract\":\"0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC\",\"chainId\":1},\"message\":{\"owner\":\"0x935e73edb9ff52e23bac7f7e043a1ecd06d05477\",\"spender\":\"0x5B38Da6a701c568545dCfcB03FcB875f56beddC4\",\"value\":30001231231212312138768,\"nonce\":0,\"deadline\":50000000000}}"
```

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

 
![CleanShot 2024-07-10 at 01 14
52](https://github.com/MetaMask/metamask-extension/assets/20778143/7a7ff9e3-07a9-4a3b-b8f4-7f672998cdab)


### **After**

![CleanShot 2024-07-11 at 00 37
25@2x](https://github.com/MetaMask/metamask-extension/assets/20778143/df6b1f0e-fa12-4b6e-9ae1-0486feb7571a)
![CleanShot 2024-07-11 at 00 37
37@2x](https://github.com/MetaMask/metamask-extension/assets/20778143/faffb8e0-6eae-4ef9-8f3b-c399b7f9f7ae)



## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
cryptotavares pushed a commit that referenced this issue Jul 17, 2024
…15 digits feat: apply ellipsis #25741  (#25804)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

Cherry-pick #25741
for Version-v12.1.0

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/25800?quickstart=1)

## **Related issues**

Fixes: MetaMask/MetaMask-planning#2730
(ellipsis)
Fixes: #25751
(Error)

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-12.1.0 Issue or pull request that will be included in release 12.1.0 release-12.3.0 Issue or pull request that will be included in release 12.3.0 team-confirmations Push issues to confirmations team type-bug
Projects
Archived in project
2 participants