Skip to content

Commit 2954714

Browse files
committed
changelog rebase
Signed-off-by: nadineloepfe <[email protected]>
1 parent db82923 commit 2954714

File tree

1 file changed

+94
-13
lines changed

1 file changed

+94
-13
lines changed

CHANGELOG.md

Lines changed: 94 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,91 @@
1-
This is a markdown file, click Ctrl+Shift+V to view or click open preview.
2-
31
# Changelog
42

5-
All notable changes to this project will be documented in this file.
6-
This project adheres to [Semantic Versioning](https://semver.org).
3+
All notable changes to this project will be documented in this file.
4+
This project adheres to [Semantic Versioning](https://semver.org).
75
This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
86

97
## [Unreleased]
108

119
### Added
1210

11+
- Add Google-style docstrings to `AccountInfo` class and its methods in `account_info.py`.
12+
- add AccountRecordsQuery class
13+
- Transaction bytes serialization support - `Transaction.freeze()`, `Transaction.to_bytes()`, and `Transaction.from_bytes()` methods for offline signing and transaction storage (#481)
14+
15+
### Changed
16+
17+
- chore: fix type hint for TokenCancelAirdropTransaction pending_airdrops parameter
18+
- chore: Moved documentation file `common_issues.md` from `examples/sdk_developers/` to `docs/sdk_developers/` for unified documentation management (#516).
19+
20+
### Fixed
21+
22+
- Added explicit read permissions to examples.yml (#623)
23+
24+
### Breaking Changes
25+
26+
## [0.1.7] - 2025-10-28
27+
28+
### Added
29+
30+
- Expanded `README.md` with a new "Follow Us" section detailing how to watch, star, and fork the repository (#472).
31+
- Refactored `examples/topic_create.py` into modular functions for better readability and reuse.
32+
- Add Rebasing and Signing section to signing.md with instructions for maintaining commit verification during rebase operations (#556)
33+
- Add `examples/account_id.py` demonstrating AccountId class usage including creating standard AccountIds, parsing from strings, comparing instances, and creating AccountIds with public key aliases
34+
- Added Google-style docstrings to `CustomFractionalFee` class and its methods in `custom_fractional_fee.py`.
35+
- Added `dependabot.yaml` file to enable automated dependency management.
36+
- Common issues guide for SDK developers at `examples/sdk_developers/common_issues.md`
37+
- Added documentation for resolving changelog conflicts in `docs/common_issues.md`
38+
- Added comprehensive changelog entry guide at `docs/sdk_developers/changelog.md` to help contributors create proper changelog entries (#532).
39+
- docs: Added Google-style docstrings to `CustomFixedFee` class and its methods in `custom_fixed_fee.py`.
40+
- docs: Add Google-style docstrings to `CustomRoyaltyFee` class and its methods in `custom_royalty_fee.py`.
41+
- docs: Add Google-style docstrings to `AbstractTokenTransferTransaction` class and its methods in `abstract_token_transfer_transaction.py`.
42+
- docs: Add Google-style docstrings to `TokenRelationship` class and its methods in `token_relationship.py`.
43+
- feat: add initial testing guide structure
44+
- Added `checksum` filed for TopicId, FileId, ContractId, ScheduleId class
45+
- Added workflow for running example scripts.
46+
- docs: workflow.md documenting key steps to creating a pull request (#605)
47+
- Added `docs/discord.md` explaining how to join and navigate the Hiero community Discord (#614).
48+
49+
### Changed
50+
51+
- Added direct links to Python SDK channel in Linux Foundation Decentralized Trust Discord back in
52+
- Updated all occurrences of non-functional Discord invite links throughout the documentation with the new, stable Hyperledger and Hedera invite links (#603).
53+
- Refactored TopicId class to use @dataclass decorator for reducing boilerplate code
54+
- Renamed `examples/nft_allowance.py` to `examples/account_allowance_nft.py` for consistency with account class naming scheme
55+
- Added changelog conflict resolution examples to `docs/common_issues.md`
56+
- Refactored `examples/topic_create.py` to be more modular by splitting functions and renaming `create_topic()` to `main()`.
57+
- Refactored `examples/transfer_hbar.py` to improve modularity by separating transfer and balance query operations into dedicated functions
58+
- Enhanced contributing section in README.md with resource links
59+
- Refactored examples/topic_message_submit.py to be more modular
60+
- Added "One Issue Per Pull Request" section to `examples/sdk_developers/common_issues.md`.
61+
- docs: Improved the contributing section in the README.md file
62+
- Refactored `examples/transfer_nft.py` to be more modular by isolating transfer logic.
63+
- Refactored `examples/file_append.py` into modular functions for better readability, reuse, and consistency across examples.
64+
- Ensured identical runtime behavior and output to the previous version to maintain backward compatibility.
65+
- Renamed `examples/hbar_allowance.py` to `examples/account_allowance_hbar.py` for naming consistency
66+
- Converted monolithic function in `token_create_nft_infinite.py` to multiple modular functions for better structure and ease.
67+
- docs: Use relative paths for internal GitHub links (#560).
68+
- Update pyproject.toml maintainers list.
69+
– docs: Updated README.md/CHANGELOG.md and added blog.md, bud.md and setup.md (#474)
70+
- renamed docs/sdk_developers/changelog.md to docs/sdk_developers/changelog_entry.md for clarity.
71+
- Refactor `query_balance.py` into modular, reusable functions with `setup_client()`, `create_account()`, `get_balance()`, `transfer_hbars()`, and `main()` for improved readability, maintainability, and error handling.
72+
- Unified balance and transfer logging format — both now consistently display values in hbars for clarity.
73+
74+
### Fixed
75+
76+
- Add type hints to `setup_client()` and `create_new_account()` functions in `examples/account_create.py` (#418)
77+
- Added explicit read and write permissions to test.yml
78+
- Type hinting for `Topic` related transactions.
79+
80+
### Removed
81+
82+
- Remove deprecated camelCase alias support and `_DeprecatedAliasesMixin`; SDK now only exposes snake_case attributes for `NftId`, `TokenInfo`, and `TransactionReceipt`. (Issue #428)
83+
84+
## [0.1.6] - 2025-10-21
85+
86+
### Added
87+
88+
- Add comprehensive Google-style docstrings to examples/account_create.py
1389
- add revenue generating topic tests/example
1490
- add fee_schedule_key, fee_exempt_keys, custom_fees fields in TopicCreateTransaction, TopicUpdateTransaction, TopicInfo classes
1591
- add CustomFeeLimit class
@@ -24,32 +100,37 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
24100
- Approved transfer support to TransferTransaction
25101
- set_transaction_id() API to Transaction class
26102
- Allowance examples (hbar_allowance.py, token_allowance.py, nft_allowance.py)
27-
- Transaction bytes serialization support - `Transaction.freeze()`, `Transaction.to_bytes()`, and `Transaction.from_bytes()` methods for offline signing and transaction storage
103+
- Refactored examples/logging_example.py for better modularity (#478)
28104

29105
### Changed
30106

31107
- TransferTransaction refactored to use TokenTransfer and HbarTransfer classes instead of dictionaries
32108
- Added checksum validation for TokenId
33109
- Refactor examples/token_cancel_airdrop
34110
- Refactor token creation examples for modularity and consistency
111+
- Updated `signing.md` to clarify commit signing requirements, including DCO, GPG, and branch-specific guidelines (#459)
35112

36113
### Changed
37114

115+
- Rearranged running_examples.md to be alphabetical
38116
- Refactor token_associate.py for better structure, add association verification query (#367)
39117
- Refactored `examples/account_create.py` to improve modularity and readability (#363)
40118
- Replace Hendrik Ebbers with Sophie Bulloch in the MAINTAINERS.md file
41119
- Improved `CONTRIBUTING.md` by explaining the /docs folder structure and fixing broken hyperlinks.(#431)
120+
- Converted class in `token_nft_info.py` to dataclass for simplicity.
42121

43122
### Fixed
44123

45124
- Incompatible Types assignment in token_transfer_list.py
46-
- Corrected references to _require_not_frozen() and removed the surplus _is_frozen
125+
- Corrected references to \_require_not_frozen() and removed the surplus \_is_frozen
47126
- Removed duplicate static methods in `TokenInfo` class:
48-
- `_copy_msg_to_proto`
49-
- `_copy_key_if_present`
50-
- `_parse_custom_fees`
51-
Kept robust versions with proper docstrings and error handling.
127+
  - `_copy_msg_to_proto`
128+
  - `_copy_key_if_present`
129+
  - `_parse_custom_fees`
130+
  Kept robust versions with proper docstrings and error handling.
52131
- Add strict type hints to `TransactionGetReceiptQuery` (#420)
132+
- Fixed broken documentation links in CONTRIBUTING.md by converting absolute GitHub URLs to relative paths
133+
- Updated all documentation references to use local paths instead of pointing to hiero-sdk project hub
53134

54135
## [0.1.5] - 2025-09-25
55136

@@ -271,9 +352,9 @@ contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
271352
- SimpleContract and StatefulContract constructors to be payable
272353
- added new_pending_airdrops to TransactionRecord Class
273354
- Reorganized SDK developer documentation:
274-
- Renamed and moved `README_linting.md` to `linting.md`
275-
- Renamed and moved `README_types.md` to `types.md`
276-
- Renamed and moved `Commit_Signing.md` to `signing.md`
355+
  - Renamed and moved `README_linting.md` to `linting.md`
356+
  - Renamed and moved `README_types.md` to `types.md`
357+
  - Renamed and moved `Commit_Signing.md` to `signing.md`
277358
- Created `sdk_users` docs folder and renamed `examples/README.md` to `running_examples.md`
278359
- Updated references and links accordingly
279360

0 commit comments

Comments
 (0)