Skip to content

Commit 8c39a72

Browse files
Revise CHANGELOG.md for recent updates Updated changelog to reflect recent changes, including breaking API changes, added classes, and modified imports. Signed-off-by: tech0priyanshu <[email protected]> <[email protected]>
1 parent cf99cf3 commit 8c39a72

File tree

1 file changed

+30
-60
lines changed

1 file changed

+30
-60
lines changed

CHANGELOG.md

Lines changed: 30 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@ This project adheres to [Semantic Versioning](https://semver.org).
77
This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
88

99
## [Unreleased]
10-
1110
- Convert camelCase to snake_case in integration tests (#318)
1211

1312
### Added
14-
1513
- ScheduleSignTransaction class
1614
- NodeUpdateTransaction class
1715
- NodeDeleteTransaction class
@@ -45,10 +43,9 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
4543
- Function docstrings in /tokens, /transaction, /query, /consensus
4644

4745
### Changed
48-
4946
- bump protobufs version to `v0.66.0`
5047
- bump solo version to `v0.13`
51-
- Extract \_build_proto_body() from build_transaction_body() in every transaction
48+
- Extract _build_proto_body() from build_transaction_body() in every transaction
5249
- StatefulContract's setMessage() function designed with no access restrictions, allowing calls from any address
5350
- bump solo version to `v0.12`
5451
- Extract Ed25519 byte loading logic into private helper method `_from_bytes_ed25519()`
@@ -61,7 +58,6 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
6158
- Add CI tests across Python 3.10–3.12.
6259

6360
### Fixed
64-
6561
- Unit test compatibility issues when running with UV package manager
6662
- Type annotations in TokenRelationship class (kyc_status and freeze_status)
6763
- Test assertions in test_executable.py using pytest match parameter
@@ -74,60 +70,53 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
7470
- Invalid signature verification for examples/keys_public_der.py
7571

7672
### Removed
77-
7873
- Removed the old `/documentation` folder.
7974
- Rebase command in README_upstream changed to just -S
8075
- generate_proto.sh
8176
- pkg_resources dependency in generate_proto.py
8277

83-
### Breaking API changes
8478

85-
- We have some changed imports and returns to maintain compatability in the proto bump
79+
### Breaking API changes
80+
- We have some changed imports and returns to maintain compatability in the proto bump
8681

8782
transaction_body_pb2.TransactionBody -> transaction_pb2.TransactionBody
8883

8984
contract_call_local_pb2.ContractFunctionResult -> contract_types_pb2.ContractFunctionResult
9085

9186
contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
92-
9387
- Removed init.py content in /tokens
9488

9589
## Corrected
96-
9790
- Duplicate validation function in TokenCreate
9891
- kyc_status: Optional[TokenFreezeStatusProto] = None → kyc_status: Optional[TokenKycStatus] = None
9992
- assert relationship.freeze_status == TokenFreezeStatus.FROZEN, f"Expected freeze status to be FROZEN, but got {relationship.freeze_status}" → assert relationship.freeze_status == TokenFreezeStatus.UNFROZEN, f"Expected freeze status to be UNFROZEN, but got {relationship.freeze_status}"
10093

101-
### Breaking API changes
94+
### Breaking API changes
10295

10396
**Changed imports**
104-
10597
- src/hiero_sdk_python/consensus/topic_message.py: from hiero_sdk_python import Timestamp → from hiero_sdk_python.timestamp import Timestamp
10698
- src/hiero_sdk_python/query/topic_message_query.py: from hiero_sdk_python import Client → from hiero_sdk_python.client.client import Client
107-
- src/hiero_sdk_python/tokens/**init**.py: content removed.
99+
- src/hiero_sdk_python/tokens/__init__.py: content removed.
108100
- src/hiero_sdk_python/tokens/token_info.py: from hiero_sdk_python.hapi.services.token_get_info_pb2 import TokenInfo as proto_TokenInfo → from hiero_sdk_python.hapi.services import token_get_info_pb2
109101
- src/hiero_sdk_python/tokens/token_key_validation.py: from hiero_sdk_python.hapi.services → import basic_types_pb2
110102
- src/hiero_sdk_python/tokens/token_kyc_status.py: from hiero_sdk_python.hapi.services.basic_types_pb2 import TokenKycStatus as proto_TokenKycStatus → from hiero_sdk_python.hapi.services import basic_types_pb2
111103
- src/hiero_sdk_python/tokens/token_pause_status.py: from hiero_sdk_python.hapi.services.basic_types_pb2 import (TokenPauseStatus as proto_TokenPauseStatus,) → from hiero_sdk_python.hapi.services import basic_types_pb2
112104
- src/hiero_sdk_python/tokens/token_pause_transaction.py: from hiero_sdk_python.hapi.services.token_pause_pb2 import TokenPauseTransactionBody → from hiero_sdk_python.hapi.services import token_pause_pb2, transaction_pb2
113105
- from hiero_sdk_python.hapi.services.token_revoke_kyc_pb2 import TokenRevokeKycTransactionBody → from hiero_sdk_python.hapi.services import token_revoke_kyc_pb2, transaction_pb2
114106
- src/hiero_sdk_python/tokens/token_update_nfts_transaction.py: from hiero_sdk_python.hapi.services.token_update_nfts_pb2 import TokenUpdateNftsTransactionBody → from hiero_sdk_python.hapi.services import token_update_nfts_pb2,transaction_pb2
115-
- src/hiero_sdk_python/tokens/token_wipe_transaction.py: from hiero_sdk_python.hapi.services.token_wipe_account_pb2 import TokenWipeAccountTransactionBody → from hiero_sdk_python.hapi.services import token_wipe_account_pb2, transaction_pb2
107+
- src/hiero_sdk_python/tokens/token_wipe_transaction.py: from hiero_sdk_python.hapi.services.token_wipe_account_pb2 import TokenWipeAccountTransactionBody → from hiero_sdk_python.hapi.services import token_wipe_account_pb2, transaction_pb2
116108

117109
## [0.1.4] - 2025-08-19
118-
119110
### Added
120-
121111
- CONTRIBUTING.md: expanded documentation detailing various contribution processes in a step-by-step way. Includes new sections: blog posts and support.
122112
- README_upstream.md: documentation explaining how to rebase to main.
123113

124114
### Added
125-
126115
- Legacy ECDSA DER parse support
127116
- documented private key from_string method behavior
128117
- ContractInfo class
129118
- ContractInfoQuery class
130-
- ContractID check in PublicKey.\_from_proto() method
119+
- ContractID check in PublicKey._from_proto() method
131120
- PendingAirdropId Class
132121
- PendingAirdropRecord Class
133122
- TokenCancelAirdropTransaction Class
@@ -138,55 +127,48 @@ contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
138127
- ContractUpdateTransaction class
139128

140129
### Fixed
141-
142130
- missing ECDSA support in query.py and contract_create_transaction.py (was only creating ED25519 keys)
143131
- Applied linting and code formatting across the consensus module
144132
- fixed pip install hiero_sdk_python -> pip install hiero-sdk-python in README.md
145133

146-
### Breaking API changes
147-
134+
### Breaking API changes
148135
**We have several camelCase uses that will be deprecated → snake_case** Original aliases will continue to function, with a warning, until the following release.
149136

150137
#### In `token_info.py`
151-
152-
- tokenId → token_id
153-
- totalSupply → total_supply
138+
- tokenId → token_id
139+
- totalSupply → total_supply
154140
- isDeleted → is_deleted
155-
- tokenType → token_type
156-
- maxSupply → max_supply
157-
- adminKey → admin_key
141+
- tokenType → token_type
142+
- maxSupply → max_supply
143+
- adminKey → admin_key
158144
- kycKey → kyc_key
159-
- freezeKey → freeze_key
145+
- freezeKey → freeze_key
160146
- wipeKey → wipe_key
161147
- supplyKey → supply_key
162-
- defaultFreezeStatus → default_freeze_status
163-
- defaultKycStatus → default_kyc_status
164-
- autoRenewAccount → auto_renew_account
165-
- autoRenewPeriod → auto_renew_period
166-
- pauseStatus → pause_status
167-
- supplyType → supply_type
148+
- defaultFreezeStatus → default_freeze_status
149+
- defaultKycStatus → default_kyc_status
150+
- autoRenewAccount → auto_renew_account
151+
- autoRenewPeriod → auto_renew_period
152+
- pauseStatus → pause_status
153+
- supplyType → supply_type
168154

169155
#### In `nft_id.py`
170-
171-
- tokenId → token_id
172-
- serialNumber → serial_number
156+
- tokenId → token_id
157+
- serialNumber → serial_number
173158

174159
#### In `transaction_receipt.py`
175-
176160
- tokenId → token_id
177-
- topicId → topic_id
178-
- accountId → account_id
161+
- topicId → topic_id
162+
- accountId → account_id
179163
- fileId → file_id
180164

181165
### Deprecated Additions
182-
183166
- logger.warn will be deprecated in v0.1.4. Please use logger.warning instead.
184167
- get_logger method passing (name, level) will be deprecated in v0.1.4 for (level, name).
185168

186-
## [0.1.3] - 2025-07-03
187169

170+
## [0.1.3] - 2025-07-03
188171
### Added
189-
190172
- TokenType Class
191173
- MAINTAINERS.md file
192174
- Duration Class
@@ -213,8 +195,8 @@ contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
213195
- TransactionRecordQuery Class
214196
- AccountInfoQuery Class
215197

216-
### Changed
217198

199+
### Changed
218200
- replace datetime.utcnow() with datetime.now(timezone.utc) for Python 3.10
219201
- updated pr-checks.yml
220202
- added add_require_frozen() to Transaction Base Class
@@ -234,66 +216,54 @@ contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
234216
- Created `sdk_users` docs folder and renamed `examples/README.md` to `running_examples.md`
235217
- Updated references and links accordingly
236218

237-
### Fixed
238219

220+
### Fixed
239221
- fixed INVALID_NODE_ACCOUNT during node switching
240222
- fixed ed25519 key ambiguity (PrivateKey.from_string -> PrivateKey.from_string_ed25519 in examples)
241223

242224
### Removed
243-
244225
- Redundant test.py file
245226

246-
## [0.1.2] - 2025-03-12
247227

228+
## [0.1.2] - 2025-03-12
248229
### Added
249-
250230
- NFTId Class
251231

252232
### Changed
253-
254233
- use SEC1 ECPrivateKey instead of PKCS#8
255234

256235
### Fixed
257-
258236
- PR checks
259237
- misnamed parameter (ECDSASecp256k1=pub_bytes -> ECDSA_secp256k1=pub_bytes)
260238

261239
### Removed
262-
263240
- .DS_store file
264241

265-
## [0.1.1] – 2025-02-25
266242

243+
## [0.1.1] – 2025-02-25
267244
### Added
268-
269245
- RELEASE.md
270246
- CONTRIBUTING.md
271247

272248
### Changed
273-
274249
- README now split into root README for project overview and /examples README for transaction types and syntax.
275250
- Python version incremented from 3.9 to 3.10
276251

277252
### Removed
278-
279253
- pdm.lock & uv.lock file
280254

281-
## [0.1.0] - 2025-02-19
282255

256+
## [0.1.0] - 2025-02-19
283257
### Added
284-
285258
- Initial release of the Python SDK core functionality.
286259
- Basic documentation on how to install and use the SDK.
287260
- Example scripts illustrating setup and usage.
288261

289262
### Changed
290-
291263
- N/A
292264

293265
### Fixed
294-
295266
- N/A
296267

297268
### Removed
298-
299269
- N/A

0 commit comments

Comments
 (0)