Skip to content

Commit 1f10f81

Browse files
Update migration guide (#1384)
1 parent 1565660 commit 1f10f81

File tree

2 files changed

+64
-1
lines changed

2 files changed

+64
-1
lines changed

docs/api/typed_data.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,38 @@ Parameter
1515
:members:
1616
:undoc-members:
1717
:exclude-members: __init__
18+
:member-order: bysource
19+
20+
-------------------
21+
StandardParameter
22+
-------------------
23+
24+
25+
.. autoclass:: starknet_py.utils.typed_data.StandardParameter
26+
:members:
27+
:undoc-members:
28+
:exclude-members: __init__
29+
:member-order: bysource
30+
31+
-------------------
32+
EnumParameter
33+
-------------------
34+
35+
.. autoclass:: starknet_py.utils.typed_data.EnumParameter
36+
:members:
37+
:undoc-members:
38+
:exclude-members: __init__
39+
:member-order: bysource
40+
41+
-------------------
42+
MerkleTreeParameter
43+
-------------------
44+
45+
.. autoclass:: starknet_py.utils.typed_data.MerkleTreeParameter
46+
:members:
47+
:undoc-members:
48+
:exclude-members: __init__
49+
:member-order: bysource
1850

1951
--------------
2052
Domain
@@ -26,3 +58,22 @@ Domain
2658
:exclude-members: __init__
2759
:member-order: bysource
2860

61+
---------
62+
BasicType
63+
---------
64+
65+
.. autoclass:: starknet_py.utils.typed_data.BasicType
66+
:members:
67+
:undoc-members:
68+
:exclude-members: __init__
69+
:member-order: bysource
70+
71+
----------
72+
PresetType
73+
----------
74+
75+
.. autoclass:: starknet_py.utils.typed_data.PresetType
76+
:members:
77+
:undoc-members:
78+
:exclude-members: __init__
79+
:member-order: bysource

docs/migration_guide.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Migration guide
55
0.23.0 Migration guide
66
******************************
77

8+
Version 0.23.0 of **starknet.py** comes with support for `SNIP-12 <https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-12.md>`_!
9+
810
0.23.0 Targeted versions
911
------------------------
1012

@@ -13,11 +15,21 @@ Migration guide
1315

1416
0.23.0 Breaking changes
1517
-----------------------
18+
1619
.. currentmodule:: starknet_py.utils.typed_data
1720

1821
1. :class:`StarkNetDomain` has been renamed to :class:`Domain`
19-
2022
2. :class:`TypedData` field ``domain`` has been changed from ``dict`` to :class:`Domain`
23+
3. :class:`Parameter` is now abstract - :class:`StandardParameter`, :class:`EnumParameter` and :class:`MerkleTreeParameter` should be used
24+
25+
0.23.0 Minor changes
26+
-----------------------
27+
28+
.. currentmodule:: starknet_py.net.account.account
29+
30+
1. :meth:`Account.sign_message` now accepts parameter ``typed_data`` as both :class:`~starknet_py.utils.typed_data.TypedData` and :class:`~starknet_py.net.models.typed_data.TypedDataDict`
31+
2. :meth:`Account.verify_message` now accepts parameter ``typed_data`` as both :class:`~starknet_py.utils.typed_data.TypedData` and :class:`~starknet_py.net.models.typed_data.TypedDataDict`
32+
3. :meth:`~starknet_py.net.signer.stark_curve_signer.KeyPair.from_keystore` has been added
2133

2234
******************************
2335
0.22.0 Migration guide

0 commit comments

Comments
 (0)