Allow TypedData revision 1 (#1360)

* Differentiate typed data files by revision

* Add `HashMethod`

* Add `Revision` enum; Rename `StarkNetDomain` to `Domain`

* Add tests to revision 1

* Remove prints

* Add more rev 1 test cases to `test_type_hash`

* Change values param to `List[int]` in `HashMethod.hash()`

* Add `DomainSchema`; Add `RevisionField` and `ChainIdField`

* Move `HashMethod` to separate file

* Refactor `Domain.to_dict()`

* Update comment

* Add `TypedData._hash_method` field

* Remove `TypedData._hash_method` field

* Update docs

* Update docs

* Update comment

* Reduce `Domain._verify_types()`

* Remove unnecessary variable duplication

* Remove unused functions

* Convert `TypedData._hash_method` to `@property`

* Change `Domain.revision` type to `Revision`

* Use equality comparison for `resolved_revision`

* Set `revision` in `Domain` typed dict to be `Optional`

* Update import

* Refactor `Domain.to_dixt()`

* Fix doc examples for `sign_message` and `verify_message`; Update function descriptions

* Remove unused import

* Remove `test_sign_message_rev_v0` and `test_verify_message_rev_v0`

* Change `sign_message()` and `verify_message()` to accept `TypedData` dataclass

* Update migration guide

* Update `test_sign_offchain_message()` to use `TypedData` class instance

* Update previous changes in `sign_message()` and `verify_message()`

* Update `sign_message()` and `verify_message()` description comments

* Minor `DomainSchema.make_dataclass()` refactor

* Restore retrieving `revision` using `data.get()`

* Add missing type annotation in `test_invalid_types()`

* Update `RevisionField._deserialize()` return type to `Revision`

* Add custom error message on missing value in `Revision` enum

* Add module in migration guide to enable hyperlinks

* Check error message in `test_invalid_types`

* Add `Parameter.to_dict()` and `TypedData.to_dict()`

* Move `Revision` to common schemas

* Format

* Set `ChainIdField._deserialize()` return type to `str`; Change 'DomainDict.chainId' type to `str`

* Remove unnecessary import

* Restore previous import of `keccak256`

* Format

* Add newline in typed data rev 1 example json

* Remove unnecessary `ChainIdField`

* Change chainId from `int` to `str` in all examples

* Refactor `TypedData.to_dict()`

* Remove `Parameter.to_dict()`; Add `RevisionField._serialize()`

* Update starknet_py/net/schemas/common.py

Co-authored-by: ddoktorski <[email protected]>

* Update starknet_py/net/schemas/common.py

Co-authored-by: ddoktorski <[email protected]>

---------

Co-authored-by: ddoktorski <[email protected]>

Author: franciszekjob

docs/api/typed_data.rst

@@ -17,9 +17,12 @@ Parameter
     :exclude-members: __init__
 
 --------------
-StarkNetDomain
+Domain
 --------------
 
-.. autoclass:: starknet_py.net.models.typed_data.StarkNetDomainDict
+.. autoclass:: starknet_py.utils.typed_data.Domain
     :members:
     :undoc-members:
+    :exclude-members: __init__
+    :member-order: bysource
+

docs/migration_guide.rst

@@ -1,6 +1,24 @@
 Migration guide
 ===============
 
+******************************
+0.23.0 Migration guide
+******************************
+
+0.23.0 Targeted versions
+------------------------
+
+- Starknet - `0.13.1.1 <https://docs.starknet.io/documentation/starknet_versions/version_notes/#version0.13.1.1>`_
+- RPC - `0.7.1 <https://github.com/starkware-libs/starknet-specs/releases/tag/v0.7.1>`_
+
+0.23.0 Breaking changes
+-----------------------
+.. currentmodule:: starknet_py.utils.typed_data
+
+1. :class:`StarkNetDomain` has been renamed to :class:`Domain`
+
+2. :class:`TypedData` field ``domain`` has been changed from ``dict`` to :class:`Domain`
+
 ******************************
 0.22.0 Migration guide
 ******************************

starknet_py/hash/hash_method.py

@@ -0,0 +1,22 @@
+from enum import Enum
+from typing import List
+
+from poseidon_py.poseidon_hash import poseidon_hash_many
+
+from starknet_py.hash.utils import compute_hash_on_elements
+
+
+class HashMethod(Enum):
+    """
+    Enum representing hash method.
+    """
+
+    PEDERSEN = "pedersen"
+    POSEIDON = "poseidon"
+
+    def hash(self, values: List[int]):
+        if self == HashMethod.PEDERSEN:
+            return compute_hash_on_elements(values)
+        if self == HashMethod.POSEIDON:
+            return poseidon_hash_many(values)
+        raise ValueError(f"Unsupported hash method: {self}.")

starknet_py/net/account/base_account.py

@@ -318,6 +318,7 @@ def sign_message(self, typed_data: TypedDataDict) -> List[int]:
         """
         Sign an TypedData TypedDict for off-chain usage with the Starknet private key and return the signature.
         This adds a message prefix, so it can't be interchanged with transactions.
+        Both v0 and v1 domain revision versions are supported.
 
         :param typed_data: TypedData TypedDict to be signed.
         :return: The signature of the TypedData TypedDict.
@@ -327,6 +328,7 @@ def sign_message(self, typed_data: TypedDataDict) -> List[int]:
     def verify_message(self, typed_data: TypedDataDict, signature: List[int]) -> bool:
         """
         Verify a signature of a TypedData dict on Starknet.
+        Both v0 and v1 domain revision versions are supported.
 
         :param typed_data: TypedData TypedDict to be verified.
         :param signature: signature of the TypedData TypedDict.

starknet_py/net/models/typed_data.py

@@ -2,7 +2,9 @@
 TypedDict structures for TypedData
 """
 
-from typing import Any, Dict, List, TypedDict, Union
+from typing import Any, Dict, List, Optional, TypedDict
+
+from starknet_py.net.schemas.common import Revision
 
 
 class ParameterDict(TypedDict):
@@ -14,14 +16,15 @@ class ParameterDict(TypedDict):
     type: str
 
 
-class StarkNetDomainDict(TypedDict):
+class DomainDict(TypedDict):
     """
-    TypedDict representing a StarkNetDomain object
+    TypedDict representing a domain object (both StarkNetDomain, StarknetDomain).
     """
 
     name: str
     version: str
-    chainId: Union[str, int]
+    chainId: str
+    revision: Optional[Revision]
 
 
 class TypedDataDict(TypedDict):
@@ -31,5 +34,5 @@ class TypedDataDict(TypedDict):
 
     types: Dict[str, List[ParameterDict]]
     primaryType: str
-    domain: StarkNetDomainDict
+    domain: DomainDict
     message: Dict[str, Any]

starknet_py/net/schemas/common.py

@@ -1,5 +1,6 @@
 import re
 import sys
+from enum import Enum
 from typing import Any, Mapping, Optional, Union
 
 from marshmallow import Schema, ValidationError, fields, post_load
@@ -336,3 +337,32 @@ class StorageEntrySchema(Schema):
     def make_dataclass(self, data, **kwargs):
         # pylint: disable=no-self-use
         return StorageEntry(**data)
+
+
+class Revision(Enum):
+    """
+    Enum representing the revision of the specification to be used.
+    """
+
+    V0 = 0
+    V1 = 1
+
+
+class RevisionField(fields.Field):
+    def _serialize(self, value: Any, attr: str, obj: Any, **kwargs):
+        if value is None or value == Revision.V0:
+            return str(Revision.V0.value)
+        return value.value
+
+    def _deserialize(self, value, attr, data, **kwargs) -> Revision:
+        if isinstance(value, str):
+            value = int(value)
+        revisions = [revision.value for revision in Revision]
+
+        if value not in revisions:
+            allowed_revisions_str = "".join(list(map(str, revisions)))
+            raise ValidationError(
+                f"Invalid value provided for Revision: {value}. Allowed values are {allowed_revisions_str}."
+            )
+
+        return Revision(value)

starknet_py/tests/e2e/docs/code_examples/test_account.py

@@ -78,7 +78,7 @@ def test_sign_message(account):
                 ],
             },
             primaryType="Example",
-            domain={"name": "StarkNet Example", "version": "1", "chainId": 1},
+            domain={"name": "StarkNet Example", "version": "1", "chainId": "1"},
             message={"value": 1},
         )
     )
@@ -100,7 +100,7 @@ def test_verify_message(account):
                 ],
             },
             primaryType="Example",
-            domain={"name": "StarkNet Example", "version": "1", "chainId": 1},
+            domain={"name": "StarkNet Example", "version": "1", "chainId": "1"},
             message={"value": 1},
         ),
         signature=[12, 34],

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

@@ -31,7 +31,7 @@ async def test_sign_offchain_message(account):
             ],
         },
         "primaryType": "Mail",
-        "domain": {"name": "StarkNet Mail", "version": "1", "chainId": 1},
+        "domain": {"name": "StarkNet Mail", "version": "1", "chainId": "1"},
         "message": {
             "from": {
                 "name": "Cow",

starknet_py/tests/e2e/fixtures/misc.py

@@ -30,10 +30,11 @@ def pytest_addoption(parser):
 
 @pytest.fixture(
     params=[
-        "typed_data_example.json",
-        "typed_data_felt_array_example.json",
-        "typed_data_long_string_example.json",
-        "typed_data_struct_array_example.json",
+        "typed_data_rev_0_example.json",
+        "typed_data_rev_0_felt_array_example.json",
+        "typed_data_rev_0_long_string_example.json",
+        "typed_data_rev_0_struct_array_example.json",
+        "typed_data_rev_1_example.json",
     ],
 )
 def typed_data(request) -> TypedDataDict:

starknet_py/tests/e2e/mock/typed_data/typed_data_example.json renamed to starknet_py/tests/e2e/mock/typed_data/typed_data_rev_0_example.json

@@ -19,7 +19,7 @@
   "domain": {
     "name": "StarkNet Mail",
     "version": "1",
-    "chainId": 1
+    "chainId": "1"
   },
   "message": {
     "from": {

starknet_py/tests/e2e/mock/typed_data/typed_data_felt_array_example.json renamed to starknet_py/tests/e2e/mock/typed_data/typed_data_rev_0_felt_array_example.json

@@ -20,7 +20,7 @@
   "domain": {
     "name": "StarkNet Mail",
     "version": "1",
-    "chainId": 1
+    "chainId": "1"
   },
   "message": {
     "from": {

starknet_py/tests/e2e/mock/typed_data/typed_data_long_string_example.json renamed to starknet_py/tests/e2e/mock/typed_data/typed_data_rev_0_long_string_example.json

@@ -23,7 +23,7 @@
     "domain": {
         "name": "StarkNet Mail",
         "version": "1",
-        "chainId": 1
+        "chainId": "1"
     },
     "message": {
         "from": {

starknet_py/tests/e2e/mock/typed_data/typed_data_struct_array_example.json renamed to starknet_py/tests/e2e/mock/typed_data/typed_data_rev_0_struct_array_example.json

@@ -24,7 +24,7 @@
   "domain": {
     "name": "StarkNet Mail",
     "version": "1",
-    "chainId": 1
+    "chainId": "1"
   },
   "message": {
     "from": {

starknet_py/tests/e2e/mock/typed_data/typed_data_rev_1_example.json

@@ -0,0 +1,37 @@
+{
+  "types": {
+    "StarknetDomain": [
+      { "name": "name", "type": "shortstring" },
+      { "name": "version", "type": "shortstring" },
+      { "name": "chainId", "type": "shortstring" },
+      { "name": "revision", "type": "shortstring" }
+    ],
+    "Person": [
+      { "name": "name", "type": "felt" },
+      { "name": "wallet", "type": "felt" }
+    ],
+    "Mail": [
+      { "name": "from", "type": "Person" },
+      { "name": "to", "type": "Person" },
+      { "name": "contents", "type": "felt" }
+    ]
+  },
+  "primaryType": "Mail",
+  "domain": {
+    "name": "StarkNet Mail",
+    "version": "1",
+    "chainId": "1",
+    "revision": 1
+  },
+  "message": {
+    "from": {
+      "name": "Cow",
+      "wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"
+    },
+    "to": {
+      "name": "Bob",
+      "wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"
+    },
+    "contents": "Hello, Bob!"
+  }
+}