Update TypedData in line with SNIP-12 #428

DelevoXDG · 2024-03-02T14:01:47Z

Describe your changes

This PR is part of the stack:

-- Update TypedData in line with SNIP-12 (#428)
-- Use sealed classes for basic and preset types (#440)
-- Add separate methods for primitives (#442)
-- Nest TypedData-related test cases (#434)

TypedData Revision 0 and Revision 1

Support bool basic type
Introduce Domain class; Use it for domain instead of JsonObject
Introduce Revision enum
Remove raw basic type; Don't allow merkletree with raw leaves type
Rename type-related classes
- TypeBase->Type
- Type->StandardType

TypedData Revision 1

Support new types
- Basic types: enum, string (long string), u128, i128, ContractAddress, ClassHash, timestamp, shortstring
  - Add EnumType
- Preset types: TokenAddress, NtfId, u256
~~Rename types->customTypes; Add types to handle customTypes + presetTypes~~ Add allTypes to handle types + presetTypes
Update type verification in line with these suggestions
Update internal logic in line with revision 1 standards

Other

Expand HashMethod enum to hash multiple elements

Linked issues

Closes #423

Breaking changes

This issue contains breaking changes

TypedData.domain is now of type TypedData.Domain instead of JsonObject
Renamed TypedData.Type->TypedData.StandardType, TypedData.TypeBase->TypedData.Type
Removed raw basic type

References

(might come in handy for reviews)

…raw value

- Add `revision`, `domainObjectName` helper fields to `TypedData` - Add new restrictions on types introduced in SNIP-12 - Move versioned `reservedTypes` to companion object

- All fields handled as JsonPrimitives - Allow `chainId` and `chain_id` (should be verified if `chain_id` is valid for revision 0)

- Add type specific references, arrays - Add `extractEnumTypes` helper - Adjust tests to not have any dangling types

- Add `MerkleHashFunction` enum - `MerkleTree` now accepts `hashFunction` as an optinal argument - (breaking) `MerkleTree.hash` now requires `hashFunction` to be specified

- Rename `domainObjectName` to `domainSeparatorName` - Format `referencedTypes` logic for better readability

- Remove @JsonNames from `TypedData.Domain` - Fix `TD_SESSION` test case in `TypedDataTest` - Use `chainId` instead of `chain_id` in `typed_data_session_example.json`

codecov-commenter · 2024-03-06T11:58:56Z

Codecov Report

Attention: Patch coverage is 85.26786% with 33 lines in your changes are missing coverage. Please review.

Project coverage is 71.11%. Comparing base (245d48b) to head (d2980b9).

Files	Patch %	Lines
...in/kotlin/com/swmansion/starknet/data/TypedData.kt	86.17%	9 Missing and 21 partials ⚠️
...et/data/serializers/TypedDataTypeBaseSerializer.kt	40.00%	0 Missing and 3 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #428      +/-   ##
==========================================
+ Coverage   70.55%   71.11%   +0.55%     
==========================================
  Files          75       75              
  Lines        3186     3337     +151     
  Branches      316      366      +50     
==========================================
+ Hits         2248     2373     +125     
- Misses        789      797       +8     
- Partials      149      167      +18

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Move to package com.swmansion.starknet.crypto - Implement using abstract function instead of stored lambda

- Add revision-based `hashMethod`, `hashArray()` - Use `hashArray()` for hasing arrays - Instantiate `MerkleTree` with `hashMethod`

- Support REV1 enum types - Support getting dep from contains for merkletree (this should probably be verified) - Refactor logic

- Support revision 0 type named enum

lib/src/main/kotlin/com/swmansion/starknet/data/TypedData.kt

…parentheses from both sidews - Only `(example_name)` is not allowed, `(example_name` and `example_name)` are now considered valid

THenry14

💪

DelevoXDG added 19 commits February 29, 2024 16:44

Fix TransactionVersion test cases

69b71ef

Use Transaction.VX_QUERY in estimate fee tests instead of checking …

7e09e80

…raw value

Add TypedDataRevision enum

598a0cb

Add docstring for TypedDataRevision

e016d68

Add EnumType

0744947

Update serializer to support EnumType

c4061c6

Fix TypedDataRevision serialization

1963133

Reference SNIP-12 as a standard in TypedData docstring

105fbca

Add Domain helper class

814e549

Update type verification logic in TypedData

76d76b4

- Add `revision`, `domainObjectName` helper fields to `TypedData` - Add new restrictions on types introduced in SNIP-12 - Move versioned `reservedTypes` to companion object

Merge branch 'main' into feat/snip-12

57bc7fc

Remove redundand typing

0bfb4ab

Fix Domain serialization

336073e

- All fields handled as JsonPrimitives - Allow `chainId` and `chain_id` (should be verified if `chain_id` is valid for revision 0)

Fix dangling types check

3a4c9e0

- Add type specific references, arrays - Add `extractEnumTypes` helper - Adjust tests to not have any dangling types

Update MerkleTree to allow Poseidon hashing

60ccd6c

- Add `MerkleHashFunction` enum - `MerkleTree` now accepts `hashFunction` as an optinal argument - (breaking) `MerkleTree.hash` now requires `hashFunction` to be specified

Minor refactor of TypedData

1bfe287

- Rename `domainObjectName` to `domainSeparatorName` - Format `referencedTypes` logic for better readability

Fix TypedDataTest

61c3331

Don't support chainn_id in TypedData.Domain

51f10dd

- Remove @JsonNames from `TypedData.Domain` - Fix `TD_SESSION` test case in `TypedDataTest` - Use `chainId` instead of `chain_id` in `typed_data_session_example.json`

Format

dd59869

DelevoXDG added 10 commits March 6, 2024 13:05

Rename MerkleHashFunction -> HashMethod

5b84b6d

- Move to package com.swmansion.starknet.crypto - Implement using abstract function instead of stored lambda

Change domain from JsonObject to TypedData.Domain

8ce47e9

Add hash(List<Felt>) method to HashMethod

0a4d59e

Introduce revision-based hashing in TypedData

b65ed36

- Add revision-based `hashMethod`, `hashArray()` - Use `hashArray()` for hasing arrays - Instantiate `MerkleTree` with `hashMethod`

Move TypedData.domainSeparatorName to Domain.separatorName

a26bb60

Replace contains and containKeys calls with in

f800d3a

Add helper String.isArray() and String.isEnum() extensions

9db210e

Fix HashMethod.PEDERSEN.hash

9cb3121

Update TypedData.getDependencies

51abbd9

- Support REV1 enum types - Support getting dep from contains for merkletree (this should probably be verified) - Refactor logic

Fix serialization process for enum type

9111651

- Support revision 0 type named enum

DelevoXDG commented Mar 13, 2024

View reviewed changes

lib/src/main/kotlin/com/swmansion/starknet/data/TypedData.kt Show resolved Hide resolved

DelevoXDG added 3 commits March 14, 2024 00:46

Don't trim type in extractEnumTypes()

c9d1394

Merge branch 'main' into feat/snip-12

ef9fad7

Merge branch 'main' into feat/snip-12

7c847b4

DelevoXDG marked this pull request as ready for review March 14, 2024 13:10

DelevoXDG added 2 commits March 14, 2024 14:20

Simplify types logic; Make it private

6cb5e5e

Mark revision as @Transient

6b7844a

DelevoXDG requested review from THenry14 and ddoktorski March 14, 2024 13:22

THenry14 reviewed Mar 15, 2024

View reviewed changes

DelevoXDG added 3 commits March 15, 2024 10:55

Improve wording in verifyTypes() checks

ee89660

Remove "raw" from basicTypesV0

a695a26

Fix tests

f0d8a8a

DelevoXDG mentioned this pull request Mar 15, 2024

Considering splitting TypedData in revision-specific classes #441

Open

Don't discard type names with parenthesis unless they're enclosed in …

7695f27

…parentheses from both sidews - Only `(example_name)` is not allowed, `(example_name` and `example_name)` are now considered valid

DelevoXDG force-pushed the feat/snip-12 branch from 983ad43 to 7695f27 Compare March 15, 2024 16:31

DelevoXDG added 4 commits March 15, 2024 17:35

Rename types->allTypes, customTypes->types

471b2d6

Improve error messages; Fix merkletree with invalid context test

2897787

Format

04dd026

Minor feltFromPrimitive() refactor

565c272

This was referenced Mar 18, 2024

Add separate methods for primitives #442

Merged

Use sealed classes for basic and preset types #440

Merged

THenry14 approved these changes Mar 18, 2024

View reviewed changes

DelevoXDG and others added 6 commits March 18, 2024 15:42

Use sealed classes for basic and preset types (#440)

510c1f1

Add separate methods for primitives (#442)

fae15d0

Nest TypedData-related test cases (#434)

605700a

Merge branch 'main' into feat/snip-12

d2980b9

Cover extra verifyTypes() errors

a7453dd

Use BasicType instead of raw string

55b9361

DelevoXDG merged commit 569c64f into main Mar 18, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update TypedData in line with SNIP-12 #428

Update TypedData in line with SNIP-12 #428

DelevoXDG commented Mar 2, 2024 •

edited

Loading

codecov-commenter commented Mar 6, 2024 •

edited

Loading

THenry14 left a comment

Update TypedData in line with SNIP-12 #428

Update TypedData in line with SNIP-12 #428

Conversation

DelevoXDG commented Mar 2, 2024 • edited Loading

Describe your changes

TypedData Revision 0 and Revision 1

TypedData Revision 1

Other

Linked issues

Breaking changes

References

codecov-commenter commented Mar 6, 2024 • edited Loading

Codecov Report

THenry14 left a comment

Choose a reason for hiding this comment

DelevoXDG commented Mar 2, 2024 •

edited

Loading

codecov-commenter commented Mar 6, 2024 •

edited

Loading