Skip to content

Remove signHash in favor of unsafe_sign_hash #260

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.

Sign up for GitHub

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

Merged
kclowes merged 2 commits into from
Apr 5, 2024
Merged

Remove signHash in favor of unsafe_sign_hash #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10bdd06
Remove signHash in favor of unsafe_sign_hash
kclowes Apr 3, 2024
9bb3ad6
Add docs
kclowes Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions eth_account/account.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
Union,
cast,
)
import warnings

from eth_keyfile import (
create_keyfile_json,
Expand Down Expand Up @@ -582,7 +581,7 @@ def sign_message(
return cast(SignedMessage, self._sign_hash(message_hash, private_key))

@combomethod
def signHash(self, message_hash, private_key):
def unsafe_sign_hash(self, message_hash, private_key):
"""
Sign the provided hash.

Expand All @@ -592,9 +591,6 @@ def signHash(self, message_hash, private_key):
Instead, prefer :meth:`~eth_account.account.Account.sign_message`,
which cannot accidentally sign a transaction.

.. CAUTION:: Deprecated for :meth:`~eth_account.account.Account.sign_message`.
This method will be removed in v0.6

:param message_hash: the 32-byte message hash to be signed
:type message_hash: hex str, bytes or int
:param private_key: the key to sign the message with
Expand All @@ -603,11 +599,6 @@ def signHash(self, message_hash, private_key):
importantly the fields: v, r, and s
:rtype: ~eth_account.datastructures.SignedMessage
"""
warnings.warn(
"signHash is deprecated in favor of sign_message",
category=DeprecationWarning,
stacklevel=2,
)
return self._sign_hash(message_hash, private_key)

@combomethod
Expand Down
4 changes: 2 additions & 2 deletions eth_account/messages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,8 +331,8 @@ def defunct_hash_message(
"""
Convert the provided message into a message hash, to be signed.

.. CAUTION:: Intended for use with the deprecated
:meth:`eth_account.account.Account.signHash`.
.. CAUTION:: Intended for use with
:meth:`eth_account.account.Account.unsafe_sign_hash`.
This is for backwards compatibility only. All new implementations
should use :meth:`encode_defunct` instead.

Expand Down
14 changes: 8 additions & 6 deletions eth_account/signers/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,20 @@ def sign_message(self, signable_message: SignableMessage) -> SignedMessage:
"""

@abstractmethod
def signHash(self, message_hash):
def unsafe_sign_hash(self, message_hash):
"""
Sign the hash of a message.

.. WARNING:: *Never* sign a hash that you didn't generate,
it can be an arbitrary transaction. For example, it might
send all of your account's ether to an attacker.
Instead, prefer :meth:`~eth_account.account.Account.sign_message`,
which cannot accidentally sign a transaction.

This uses the same structure
as in :meth:`~eth_account.account.Account.signHash`
as in :meth:`~eth_account.account.Account.unsafe_sign_hash`
but without specifying the private key.

.. CAUTION:: Deprecated for
:meth:`~eth_account.signers.base.BaseAccount.sign_message`.
To be removed in v0.6

:param bytes message_hash: 32 byte hash of the message to sign
"""

Expand Down
4 changes: 2 additions & 2 deletions eth_account/signers/local.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ def encrypt(self, password, kdf=None, iterations=None):
self.key, password, kdf=kdf, iterations=iterations
)

def signHash(self, message_hash):
return self._publicapi.signHash(
def unsafe_sign_hash(self, message_hash):
return self._publicapi.unsafe_sign_hash(
message_hash,
private_key=self.key,
)
Expand Down
1 change: 1 addition & 0 deletions newsfragments/260.removal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove ``signHash`` in favor of ``unsafe_sign_hash``
9 changes: 3 additions & 6 deletions tests/core/test_accounts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,8 +402,7 @@ def test_eth_account_hash_message_hexstr(acct, message, expected):
def test_sign_message_against_sign_hash_as_text(keyed_acct, message_text):
# sign via hash
msg_hash = defunct_hash_message(text=message_text)
with pytest.deprecated_call():
signed_via_hash = keyed_acct.signHash(msg_hash)
signed_via_hash = keyed_acct.unsafe_sign_hash(msg_hash)

# sign via message
signable_message = encode_defunct(text=message_text)
Expand All @@ -415,8 +414,7 @@ def test_sign_message_against_sign_hash_as_text(keyed_acct, message_text):
def test_sign_message_against_sign_hash_as_bytes(keyed_acct, message_bytes):
# sign via hash
msg_hash = defunct_hash_message(message_bytes)
with pytest.deprecated_call():
signed_via_hash = keyed_acct.signHash(msg_hash)
signed_via_hash = keyed_acct.unsafe_sign_hash(msg_hash)

# sign via message
signable_message = encode_defunct(message_bytes)
Expand All @@ -431,8 +429,7 @@ def test_sign_message_against_sign_hash_as_hex(keyed_acct, message_bytes):

# sign via hash
msg_hash_hex = defunct_hash_message(hexstr=message_hex)
with pytest.deprecated_call():
signed_via_hash_hex = keyed_acct.signHash(msg_hash_hex)
signed_via_hash_hex = keyed_acct.unsafe_sign_hash(msg_hash_hex)

# sign via message
signable_message_hex = encode_defunct(hexstr=message_hex)
Expand Down