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.

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

Jump to bottom

removed deprecate sha3 methods #2479

Merged
merged 3 commits into from
Jun 6, 2022
Merged

removed deprecate sha3 methods #2479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4a4380
removed deprecate sha3 methods
dbfreem May 17, 2022
bfcf65a
newfragment
dbfreem May 17, 2022
2728ce5
removed test
dbfreem May 18, 2022
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
48 changes: 0 additions & 48 deletions docs/web3.main.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,54 +304,6 @@ Cryptographic Hashing
assert(data2 == hex"4e03657aea45a94fc7d47ba826c8d667c0d1e6e33a64a036ec44f58fa12d6c45");


.. py:classmethod:: Web3.sha3(primitive=None, hexstr=None, text=None)

.. WARNING::
This method has been deprecated for :meth:`~Web3.keccak`

Returns the Keccak SHA256 of the given value. Text is encoded to UTF-8 before
computing the hash, just like Solidity. Any of the following are
valid and equivalent:

.. code-block:: python

>>> Web3.sha3(0x747874)
>>> Web3.sha3(b'\x74\x78\x74')
>>> Web3.sha3(hexstr='0x747874')
>>> Web3.sha3(hexstr='747874')
>>> Web3.sha3(text='txt')
HexBytes('0xd7278090a36507640ea6b7a0034b69b0d240766fa3f98e3722be93c613b29d2e')

.. py:classmethod:: Web3.soliditySha3(abi_types, value)

.. WARNING::
This method has been deprecated for :meth:`~Web3.solidityKeccak`


Returns the sha3 as it would be computed by the solidity ``sha3`` function
on the provided ``value`` and ``abi_types``. The ``abi_types`` value
should be a list of solidity type strings which correspond to each of the
provided values.


.. code-block:: python

>>> Web3.soliditySha3(['bool'], [True])
HexBytes("0x5fe7f977e71dba2ea1a68e21057beebb9be2ac30c6410aa38d4f3fbe41dcffd2")

>>> Web3.soliditySha3(['uint8', 'uint8', 'uint8'], [97, 98, 99])
HexBytes("0x4e03657aea45a94fc7d47ba826c8d667c0d1e6e33a64a036ec44f58fa12d6c45")

>>> Web3.soliditySha3(['uint8[]'], [[97, 98, 99]])
HexBytes("0x233002c671295529bcc50b76a2ef2b0de2dac2d93945fca745255de1a9e4017e")

>>> Web3.soliditySha3(['address'], ["0x49EdDD3769c0712032808D86597B84ac5c2F5614"])
HexBytes("0x2ff37b5607484cd4eecf6d13292e22bd6e5401eaffcc07e279583bc742c68882")

>>> Web3.soliditySha3(['address'], ["ethereumfoundation.eth"])
HexBytes("0x913c99ea930c78868f1535d34cd705ab85929b2eaaf70fcd09677ecd6e5d75e9")


Check Encodability
~~~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions newsfragments/2479.breaking-change.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sha3 and soliditySha3 were previously deprecated and now removed
7 changes: 0 additions & 7 deletions tests/core/web3-module/test_keccak.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,3 @@ def test_keccak_raise_if_hexstr_and_text():
def test_keccak_raise_if_no_args():
with pytest.raises(TypeError):
Web3.keccak()


def test_deprecated_bound_method():
w3 = Web3()
h = HexBytes('0x0f355f04c0a06eebac1d219b34c598f85a1169badee164be8a30345944885fe8')
with pytest.warns(DeprecationWarning, match='sha3 is deprecated in favor of keccak'):
assert w3.sha3(text='cowmö') == h
15 changes: 0 additions & 15 deletions web3/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,6 @@
build_strict_registry,
map_abi_data,
)
from web3._utils.decorators import (
deprecated_for,
)
from web3._utils.empty import (
empty,
)
Expand Down Expand Up @@ -276,13 +273,6 @@ def api(self) -> str:
from web3 import __version__
return __version__

@staticmethod
@deprecated_for("keccak")
@apply_to_return_value(HexBytes)
def sha3(primitive: Optional[Primitives] = None, text: Optional[str] = None,
hexstr: Optional[HexStr] = None) -> bytes:
return Web3.keccak(primitive, text, hexstr)

@staticmethod
@apply_to_return_value(HexBytes)
def keccak(primitive: Optional[Primitives] = None, text: Optional[str] = None,
Expand All @@ -300,11 +290,6 @@ def keccak(primitive: Optional[Primitives] = None, text: Optional[str] = None,
)
)

@combomethod
@deprecated_for("solidityKeccak")
def soliditySha3(cls, abi_types: List[TypeStr], values: List[Any]) -> bytes:
return cls.solidityKeccak(abi_types, values)

@combomethod
def solidityKeccak(cls, abi_types: List[TypeStr], values: List[Any]) -> bytes:
"""
Expand Down