feat!: refactor sign_message and update to 0.7.0 eth-ape

[z80dev]

note: this will fail type checking until we release the changes in ApeWorX/ape#1614 (review)

now supports strings, SignableMessage, and EIP712Message

What I did

Updated sign_message and check_message to support the types they can handle

Fixes: APE-1351

How I did it

some type checking and lots of experimenting

How to verify it

I used this script

from eip712 import EIP712Message
from ape import accounts
from eth_account.messages import encode_defunct


class CustomMessage(EIP712Message):
    _name_ = "CustomMessage"
    _version_ = "1"
    _chainId_ = 1
    amount: "uint256"  # type: ignore
    recipient: "address"  # type: ignore


acc = accounts.load("frame")

c = CustomMessage(amount=1, recipient=acc.address)

sig = acc.sign_message("Hello World")
assert acc.check_signature("Hello World", sig)

strmsg = encode_defunct(text="Hello World")
sig = acc.sign_message(strmsg)
assert acc.check_signature(strmsg, sig)

sig = acc.sign_message(c)
assert acc.check_signature(c, sig)

Checklist

• Passes all linting checks (pre-commit and CI jobs)
• New test cases have been added and are passing
• Documentation has been updated
• PR title follows Conventional Commit standard (will be automatically included in the changelog)

[fubuloubu]

Tests are failing... because there are no tests 😅

How could we test this? Does Frame provide an automated mock we could integrate with?

[linear]

APE-1351 "feat: refactor sign_message" (ApeWorX/ape-frame #5)

now supports strings, SignableMessage, and EIP712Message

What I did

Updated sign_message and check_message to support the types they can handle

How I did it

some type checking and lots of experimenting

How to verify it

I used this script

from eip712 import EIP712Message
from ape import accounts
from eth_account.messages import encode_defunct


class CustomMessage(EIP712Message):
    _name_ = "CustomMessage"
    _version_ = "1"
    _chainId_ = 1
    amount: "uint256"  # type: ignore
    recipient: "address"  # type: ignore


acc = accounts.load("frame")

c = CustomMessage(amount=1, recipient=acc.address)

sig = acc.sign_message("Hello World")
assert acc.check_signature("Hello World", sig)

strmsg = encode_defunct(text="Hello World")
sig = acc.sign_message(strmsg)
assert acc.check_signature(strmsg, sig)

sig = acc.sign_message(c)
assert acc.check_signature(c, sig)

Checklist

• Passes all linting checks (pre-commit and CI jobs)
• New test cases have been added and are passing
• Documentation has been updated
• PR title follows Conventional Commit standard (will be automatically included in the changelog)

---

ApeWorX/ape-frame #5 by z80dev on GitHub

via LinearSync

[antazoey]

mostly nit comments though you may want to be careful assuming all ValueErrors have arguments, that is likely to cause a random IndexError down the line.

[fubuloubu]

I think this PR needs some rebasing or something, not sure if it's up to date with core

[antazoey]

@z80dev may know more about the type discrepancy here, but I created this issue: ethereum/web3.py#3255

[antazoey]

I think this PR needs some rebasing or something, not sure if it's up to date with core

OK, I tidied it all up and updated everything, lemme know if that works