Display boolean values when signing typed data #10048

nlordell · 2020-12-10T22:23:39Z

Fixes: #4639.

Explanation: The confirmation popup when signing typed data was not correctly displaying boolean fields. This is because booleans have special meaning in JSX and don't render their string representation (source). The fix is simple, just toString() the values being displayed.

Manual testing steps:

Load sample code included below 👇.
Check to see that the values are correctly displayed (especially noting the bool value which is displayed now)
Profit 💶

index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Sign Typed Data Test</title>
    <script src="./index.js"></script>
  </head>
  <body>
    <button id="sign">eth_signTypedData</button>
  </body>
</html>

index.js

import { ethers, BigNumber } from "ethers";

async function main() {
  await window.ethereum.enable();

  const provider = new ethers.providers.Web3Provider(window.ethereum);
  const signer = provider.getSigner();
  const account = await signer.getAddress();

  document.querySelector("#sign").addEventListener("click", async () => {
    const signature = await provider.send("eth_signTypedData_v4", [
      account.toLowerCase(),
      JSON.stringify({
        types: {
          EIP712Domain: [
            { name: "name", type: "string" },
          ],
          Data: [
            { name: "bytes2", type: "bytes2" },
            { name: "uint32", type: "uint32" },
            { name: "bool", type: "bool" },
            { name: "bytes", type: "bytes" },
            { name: "string", type: "string" },
            { name: "nested", type: "Inner[]" },
          ],
          Inner: [
            { name: "int8", type: "int8" },
            { name: "uint128", type: "uint128" },
            { name: "address", type: "address" },
          ],
        },
        primaryType: "Data",
        domain: { name: "Test" },
        message: {
          bytes2: "0x1337",
          uint32: "0xbadc0de",
          bool: true,
          bytes: "0x010203040506070809",
          string: "Hello MetaMask!",
          nested: [{
            int8: -42,
            uint128: BigNumber.from("12384761928764192812341324214").toHexString(),
            address: account,
          }],
        },
      })
    ]);

    console.log(signature);
  });
}

main()
  .then(() => console.log("done"))
  .catch((err) => console.error(err));

github-actions · 2020-12-10T22:23:54Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

nlordell · 2020-12-10T22:26:15Z

I have read the CLA Document and I hereby sign the CLA

brad-decker

LGTM! Great work, @nlordell

Gudahtt

LGTM!

Display boolean values when signing typed data

b128fe2

nlordell requested a review from a team as a code owner December 10, 2020 22:23

nlordell requested a review from rekmarks December 10, 2020 22:23

add CHANGELOG entry

8c95338

deal with 'null' and 'undefined'

f74d5ed

brad-decker approved these changes Dec 11, 2020

View reviewed changes

Gudahtt approved these changes Dec 11, 2020

View reviewed changes

brad-decker merged commit fcf75d6 into MetaMask:develop Dec 11, 2020

github-actions bot locked and limited conversation to collaborators Dec 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display boolean values when signing typed data #10048

Display boolean values when signing typed data #10048

nlordell commented Dec 10, 2020 •

edited

github-actions bot commented Dec 10, 2020 •

edited

nlordell commented Dec 10, 2020

brad-decker left a comment

Gudahtt left a comment

Display boolean values when signing typed data #10048

Display boolean values when signing typed data #10048

Conversation

nlordell commented Dec 10, 2020 • edited

github-actions bot commented Dec 10, 2020 • edited

nlordell commented Dec 10, 2020

brad-decker left a comment

Choose a reason for hiding this comment

Gudahtt left a comment

Choose a reason for hiding this comment

nlordell commented Dec 10, 2020 •

edited

github-actions bot commented Dec 10, 2020 •

edited