Support `enum` basic type in `TypedData` #1382

franciszekjob · 2024-07-03T09:24:27Z

Relates #1353

Introduced changes

Support revision 1 enum basic type in TypedData
Make Parameter abstract
Add StandardParameter, EnumParameter, MerkleTreeParameter
Add enum-related tests

This PR contains breaking changes

Parameter is now abstract; StandardParameter, EnumParameter, MerkleTreeParameter should be used

…are-mansion/starknet.py into franciszekjob/1353-snip-12

… data tests

…are-mansion/starknet.py into franciszekjob/1353-snip-12

starknet_py/utils/typed_data_test.py

starknet_py/utils/typed_data.py

ddoktorski · 2024-07-05T09:26:28Z

Please also fix the docs build. It's failing because class Parameter does not exist.

Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com>

…re-mansion/starknet.py into franciszekjob/1353-7-enum

ddoktorski

Please address the last comment before merging 🚀

starknet_py/utils/typed_data.py

Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com>

franciszekjob and others added 30 commits June 14, 2024 16:04

Add HashMethod

139f970

Add Revision enum; Rename StarkNetDomain to Domain

1317848

Add tests to revision 1

2cf0aaa

Remove prints

9d9fda3

Add more rev 1 test cases to test_type_hash

f67cdb7

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

5469dd3

Add DomainSchema; Add RevisionField and ChainIdField

1be0060

Move HashMethod to separate file

9781a21

Refactor Domain.to_dict()

a7e7f89

Update comment

57c16ec

Add TypedData._hash_method field

c648f84

Remove TypedData._hash_method field

74cf615

Update docs

549e143

Update docs

9c67d18

Merge branch 'franciszekjob/1353-snip-12' of https://github.com/softw…

be1e1ec

…are-mansion/starknet.py into franciszekjob/1353-snip-12

Update comment

23562a4

Reduce Domain._verify_types()

1c4cde6

Remove unnecessary variable duplication

e158122

Remove unused functions

57ed19f

Add merkle tree type data jsons

64a7a6a

Add HashMethod.hash_many()

599f6bd

Add MerkleTree dataclass; Add merkle tree tests

8b6e28d

Add Parameter.contains to handle merkle parameter

d7540eb

Introduce merkle trees in TypedData; Add merkle tree cases in typed…

9290b5e

… data tests

Convert TypedData._hash_method to @property

3d92324

Change Domain.revision type to Revision

0c651d4

Use equality comparison for resolved_revision

961e489

Merge branch 'franciszekjob/1353-snip-12' of https://github.com/softw…

e98ed80

…are-mansion/starknet.py into franciszekjob/1353-snip-12

Set revision in Domain typed dict to be Optional

59a7b2e

Update import

80e9b87

franciszekjob added 4 commits July 4, 2024 11:06

Remove Parameter; Rename StandardParameter to Parameter

9b8ac62

Change value type in _encode_value_v0()

01a768d

Rename is_enum() to is_enum_variant_type()

943994a

Change error messages

14a7145

franciszekjob requested a review from ddoktorski July 4, 2024 10:45

ddoktorski reviewed Jul 4, 2024

View reviewed changes

starknet_py/utils/typed_data_test.py Outdated Show resolved Hide resolved

starknet_py/utils/typed_data.py Outdated Show resolved Hide resolved

starknet_py/utils/typed_data.py Show resolved Hide resolved

starknet_py/utils/typed_data.py Show resolved Hide resolved

Remove unnecessary comment

b678fcc

franciszekjob requested a review from ddoktorski July 4, 2024 16:35

franciszekjob added 2 commits July 4, 2024 19:15

Add check for enum types in TypedData._verify_types()

c7b8424

Format

499c254

ddoktorski reviewed Jul 5, 2024

View reviewed changes

franciszekjob and others added 9 commits July 5, 2024 12:00

Remove docstrings from parameter classes

e965bf1

Fix adding enum types to referenced types

af57cc7

Add check for enum variant type in TypedData._get_dependencies()

06fd8fe

Remove redundant self._validate_enum_type()

c203c5c

Update starknet_py/utils/typed_data.py

c4cf87c

Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com>

Rename variant_type to variant_definition

4da3ec0

Merge branch 'franciszekjob/1353-7-enum' of https://github.com/softwa…

0476d3a

…re-mansion/starknet.py into franciszekjob/1353-7-enum

Minor refactor - move variable before return statement

3671cce

Change Parameter to StandardParameter in docs

0069881

franciszekjob requested a review from ddoktorski July 5, 2024 10:33

franciszekjob added 3 commits July 5, 2024 15:20

Minor refactor of retrieving referenced types

3a65534

Create abstract Parameter class

6209096

Refactor checking basic type names

7f5798f

franciszekjob self-assigned this Jul 5, 2024

ddoktorski approved these changes Jul 5, 2024

View reviewed changes

starknet_py/utils/typed_data.py Outdated Show resolved Hide resolved

Update starknet_py/utils/typed_data.py

0085160

Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com>

franciszekjob merged commit 6508f33 into development Jul 5, 2024
16 checks passed

franciszekjob deleted the franciszekjob/1353-7-enum branch July 5, 2024 15:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support `enum` basic type in `TypedData` #1382

Support `enum` basic type in `TypedData` #1382

franciszekjob commented Jul 3, 2024 •

edited

Loading

ddoktorski commented Jul 5, 2024

ddoktorski left a comment

Support enum basic type in TypedData #1382

Support enum basic type in TypedData #1382

Conversation

franciszekjob commented Jul 3, 2024 • edited Loading

Introduced changes

ddoktorski commented Jul 5, 2024

ddoktorski left a comment

Choose a reason for hiding this comment

Support `enum` basic type in `TypedData` #1382

Support `enum` basic type in `TypedData` #1382

franciszekjob commented Jul 3, 2024 •

edited

Loading