Default blake in compute_casm_class_hash (#1676)

Author: franciszekjob

docs/migration_guide.rst

@@ -21,6 +21,13 @@ The **lowest** supported version Python is now 3.10.
 
 These packages are needed for HIDAPI compilation. Read official `ledgerctl installation guide <https://github.com/LedgerHQ/ledgerctl?tab=readme-ov-file#quick-install)>`_ for more details.
 
+<unreleased> Breaking changes
+-----------------------------
+
+.. currentmodule:: starknet_py.hash.class_hash
+
+1. :func:`compute_class_hash`: default value of ``hash_method`` param is now ``HashMethod.BLAKE2S``.
+
 ***************************
 0.29.0-rc.1 Migration guide
 ***************************

starknet_py/hash/casm_class_hash.py

@@ -26,7 +26,7 @@ def get_casm_hash_method_for_starknet_version(starknet_version: Version) -> Hash
 
 
 def compute_casm_class_hash(
-    casm_contract_class: CasmClass, hash_method: HashMethod = HashMethod.POSEIDON
+    casm_contract_class: CasmClass, hash_method: HashMethod = HashMethod.BLAKE2S
 ) -> int:
     """
     Calculate class hash of a CasmClass.

starknet_py/tests/e2e/account/account_test.py

@@ -8,6 +8,7 @@
 from starknet_py.constants import ARGENT_V040_CLASS_HASH
 from starknet_py.hash.address import compute_address
 from starknet_py.hash.casm_class_hash import compute_casm_class_hash
+from starknet_py.hash.hash_method import HashMethod
 from starknet_py.hash.selector import get_selector_from_name
 from starknet_py.net.account.account import Account
 from starknet_py.net.account.base_account import BaseAccount
@@ -757,7 +758,11 @@ async def test_declare_v3_with_tip(account):
     tip = 12345
     signed_tx = await account.sign_declare_v3(
         compiled_contract["sierra"],
-        compute_casm_class_hash(create_casm_class(compiled_contract["casm"])),
+        compute_casm_class_hash(
+            # TODO(#1659): Use blake
+            create_casm_class(compiled_contract["casm"]),
+            HashMethod.POSEIDON,
+        ),
         resource_bounds=MAX_RESOURCE_BOUNDS,
         tip=tip,
     )
@@ -780,7 +785,11 @@ async def test_declare_v3_auto_estimate_tip(
         mocked_block_with_txs.return_value = block_with_tips_mock
         signed_tx = await account.sign_declare_v3(
             compiled_contract["sierra"],
-            compute_casm_class_hash(create_casm_class(compiled_contract["casm"])),
+            compute_casm_class_hash(
+                # TODO(#1659): Use blake
+                create_casm_class(compiled_contract["casm"]),
+                HashMethod.POSEIDON,
+            ),
             resource_bounds=MAX_RESOURCE_BOUNDS,
             auto_estimate_tip=True,
         )

starknet_py/tests/e2e/client/full_node_test.py

@@ -8,6 +8,7 @@
 from starknet_py.contract import Contract
 from starknet_py.hash.address import compute_address
 from starknet_py.hash.casm_class_hash import compute_casm_class_hash
+from starknet_py.hash.hash_method import HashMethod
 from starknet_py.hash.selector import get_selector_from_name
 from starknet_py.hash.storage import get_storage_var_address
 from starknet_py.net.account.account import Account
@@ -522,7 +523,8 @@ async def test_simulate_transactions_two_txs(account, deployed_balance_contract)
     )
 
     casm_class = create_casm_class(contract["casm"])
-    casm_class_hash = compute_casm_class_hash(casm_class)
+    # TODO(#1659): Use blake
+    casm_class_hash = compute_casm_class_hash(casm_class, HashMethod.POSEIDON)
 
     declare_v3_tx = await account.sign_declare_v3(
         compiled_contract=contract["sierra"],

starknet_py/tests/e2e/docs/guide/test_cairo1_contract.py

@@ -2,6 +2,7 @@
 
 import pytest
 
+from starknet_py.hash.hash_method import HashMethod
 from starknet_py.net.client_models import SierraContractClass
 from starknet_py.net.udc_deployer.deployer import _get_random_salt
 from starknet_py.tests.e2e.fixtures.constants import MAX_RESOURCE_BOUNDS
@@ -30,8 +31,9 @@ async def test_cairo1_contract(
     # contract_compiled_casm is a string containing the content of the starknet-sierra-compile (.casm file)
     casm_class = create_casm_class(contract_compiled_casm)
 
+    # TODO(#1659): Use blake
     # Compute Casm class hash
-    casm_class_hash = compute_casm_class_hash(casm_class)
+    casm_class_hash = compute_casm_class_hash(casm_class, HashMethod.POSEIDON)
     # docs: end
 
     assert casm_class_hash == compiled_class_hash

starknet_py/tests/e2e/fixtures/contracts_v1.py

@@ -8,6 +8,7 @@
 from starknet_py.common import create_casm_class, create_sierra_compiled_contract
 from starknet_py.contract import Contract
 from starknet_py.hash.casm_class_hash import compute_casm_class_hash
+from starknet_py.hash.hash_method import HashMethod
 from starknet_py.net.account.base_account import BaseAccount
 from starknet_py.net.models import DeclareV3
 from starknet_py.net.udc_deployer.deployer import Deployer
@@ -18,7 +19,11 @@
 async def declare_contract(
     account: BaseAccount, compiled_contract: str, compiled_contract_casm: str
 ) -> Tuple[int, int]:
-    casm_class_hash = compute_casm_class_hash(create_casm_class(compiled_contract_casm))
+    casm_class_hash = compute_casm_class_hash(
+        # TODO(#1659): Use blake
+        create_casm_class(compiled_contract_casm),
+        HashMethod.POSEIDON,
+    )
 
     declare_tx = await account.sign_declare_v3(
         compiled_contract=compiled_contract,
@@ -66,7 +71,11 @@ def constructor_with_arguments_abi() -> List:
 @pytest_asyncio.fixture(scope="package")
 async def declare_v3_hello_starknet(account: BaseAccount) -> DeclareV3:
     contract = load_contract("HelloStarknet")
-    casm_class_hash = compute_casm_class_hash(create_casm_class(contract["casm"]))
+    casm_class_hash = compute_casm_class_hash(
+        # TODO(#1659): Use blake
+        create_casm_class(contract["casm"]),
+        HashMethod.POSEIDON,
+    )
 
     declare_tx = await account.sign_declare_v3(
         contract["sierra"], casm_class_hash, resource_bounds=MAX_RESOURCE_BOUNDS
@@ -232,7 +241,11 @@ def map_compiled_contract_and_class_hash() -> Tuple[str, int]:
 
     return (
         contract["sierra"],
-        compute_casm_class_hash(create_casm_class(contract["casm"])),
+        compute_casm_class_hash(
+            # TODO(#1659): Use blake
+            create_casm_class(contract["casm"]),
+            HashMethod.POSEIDON,
+        ),
     )
 
 
@@ -242,7 +255,11 @@ def map_compiled_contract_and_class_hash_copy_1() -> Tuple[str, int]:
 
     return (
         contract["sierra"],
-        compute_casm_class_hash(create_casm_class(contract["casm"])),
+        compute_casm_class_hash(
+            # TODO(#1659): Use blake
+            create_casm_class(contract["casm"]),
+            HashMethod.POSEIDON,
+        ),
     )
 
 
@@ -252,7 +269,11 @@ def map_compiled_contract_and_class_hash_copy_2() -> Tuple[str, int]:
 
     return (
         contract["sierra"],
-        compute_casm_class_hash(create_casm_class(contract["casm"])),
+        compute_casm_class_hash(
+            # TODO(#1659): Use blake
+            create_casm_class(contract["casm"]),
+            HashMethod.POSEIDON,
+        ),
     )
 
 
@@ -304,7 +325,11 @@ def sierra_minimal_compiled_contract_and_class_hash() -> Tuple[str, int]:
 
     return (
         contract["sierra"],
-        compute_casm_class_hash(create_casm_class(contract["casm"])),
+        compute_casm_class_hash(
+            # TODO(#1659): Use blake
+            create_casm_class(contract["casm"]),
+            HashMethod.POSEIDON,
+        ),
     )
 
 
@@ -317,7 +342,11 @@ def abi_types_compiled_contract_and_class_hash() -> Tuple[str, int]:
 
     return (
         contract["sierra"],
-        compute_casm_class_hash(create_casm_class(contract["casm"])),
+        compute_casm_class_hash(
+            # TODO(#1659): Use blake
+            create_casm_class(contract["casm"]),
+            HashMethod.POSEIDON,
+        ),
     )
 
 
@@ -349,7 +378,8 @@ async def account_declare_class_hash(
     """
 
     casm_class = create_casm_class(compiled_account_contract_casm)
-    casm_class_hash = compute_casm_class_hash(casm_class)
+    # TODO(#1659): Use blake
+    casm_class_hash = compute_casm_class_hash(casm_class, HashMethod.POSEIDON)
     declare_v3_transaction = await account.sign_declare_v3(
         compiled_contract=compiled_account_contract,
         compiled_class_hash=casm_class_hash,
@@ -365,7 +395,9 @@ async def account_with_validate_deploy_class_hash(
     pre_deployed_account_with_validate_deploy: BaseAccount,
 ) -> int:
     contract = load_contract("Account")
-    casm_class_hash = compute_casm_class_hash(create_casm_class(contract["casm"]))
+    casm_class_hash = compute_casm_class_hash(
+        create_casm_class(contract["casm"]), HashMethod.POSEIDON
+    )
 
     return await declare_account(
         pre_deployed_account_with_validate_deploy, contract["sierra"], casm_class_hash

starknet_py/tests/unit/hash/casm_class_hash_test.py

@@ -32,7 +32,7 @@ def test_compute_casm_class_hash_with_poseidon(contract, expected_casm_class_has
     )['casm']
 
     casm_class = create_casm_class(casm_contract_class_str)
-    casm_class_hash = compute_casm_class_hash(casm_class)
+    casm_class_hash = compute_casm_class_hash(casm_class, HashMethod.POSEIDON)
     assert casm_class_hash == expected_casm_class_hash_poseidon
 
 @pytest.mark.parametrize(
@@ -51,7 +51,7 @@ def test_precompiled_compute_casm_class_hash_with_poseidon(casm_contract_class_s
     )
 
     casm_class = create_casm_class(casm_contract_class_str)
-    casm_class_hash = compute_casm_class_hash(casm_class)
+    casm_class_hash = compute_casm_class_hash(casm_class, HashMethod.POSEIDON)
     assert casm_class_hash == expected_casm_class_hash_poseidon