Skip to content

Commit 2c5c0ff

Browse files
committed
WIP: checkpoint changes to examples
Signed-off-by: MonaaEid <[email protected]>
1 parent 8662a7b commit 2c5c0ff

File tree

2 files changed

+9
-82
lines changed

2 files changed

+9
-82
lines changed

CHANGELOG.md

Lines changed: 5 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -6,93 +6,27 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
66

77
## [Unreleased]
88

9-
### Added
10-
- Add `TokenFeeScheduleUpdateTransaction` class to support updating custom fee schedules on tokens (#471).
11-
- Add `examples/token_update_fee_schedule_fungible.py` and `examples/token_update_fee_schedule_nft.py` demonstrating the use of `TokenFeeScheduleUpdateTransaction`.
12-
- Update `docs/sdk_users/running_examples.md` to include `TokenFeeScheduleUpdateTransaction`.
13-
- added FreezeTransaction class
14-
- added FreezeType class
15-
- Added `docs/sdk_developers/pylance.md`, a new guide explaining how to set up and use **Pylance** in VS Code for validating imports, file references, and methods before review. (#713)
16-
- feat: TokenAirdropClaim Transaction, examples (with signing required and not), unit and integration tests (#201)
17-
- docs: Add Google-style docstrings to `TokenId` class and its methods in `token_id.py`.
18-
- added Google-style docstrings to the `TransactionRecord` class including all dataclass fields, `__repr__`, `_from_proto()` & `_to_proto()` methods.
19-
- Standardized docstrings, improved error handling, and updated type hinting (`str | None` to `Optional[str]`) for the `FileId` class (#652).
20-
- Add Google-style docstrings to `AccountInfo` class and its methods in `account_info.py`.
21-
- Added comprehensive Google-style docstrings to the `Logger` class and all utility functions in `src/hiero_sdk_python/logger/logger.py` (#639).
22-
- add AccountRecordsQuery class
23-
- chore: added python 3.13 to test.yml workflow (#510, #449)
24-
- Transaction bytes serialization support: `Transaction.freeze()`, `Transaction.to_bytes()`, and `Transaction.from_bytes()` methods for offline signing and transaction storage
25-
- docs: Add Google-style docstrings to `ContractId` class and methods in `contract_id.py`.
26-
- Added TokenUnpauseTransaction class
27-
- Added expiration_time, auto_renew_period, auto_renew_account, fee_schedule_key, kyc_key in `TokenCreateTransaction`, `TokenUpdateTransaction` classes
28-
- Added comprehensive Google-style docstrings to the `CustomFee` class and its methods in `custom_fee.py`.
29-
- docs: Add `docs/sdk_developers/project_structure.md` to explain repository layout and import paths.
30-
31-
### Changed
32-
- chore: replaced hardcoded 'testnet' messages with environment network name
33-
- chore: validate that token airdrop transactions require an available token service on the channel (#632)
34-
- chore: update local environment configuration in env.example (#649)
35-
- chore: Update env.example NETWORK to encourage testnet or local usage (#659)
36-
- chore: updated pyproject.toml with python 3.10 to 3.13 (#510, #449)
37-
- chore: fix type hint for TokenCancelAirdropTransaction pending_airdrops parameter
38-
- chore: Moved documentation file `common_issues.md` from `examples/sdk_developers/` to `docs/sdk_developers/` for unified documentation management (#516).
39-
- chore: Refactored the script of examples/custom_fee.py into modular functions
40-
- fix: Replaced `collections.namedtuple` with `typing.NamedTuple` in `client.py` for improved type checking.
41-
- chore: Refactored examples/custom_fee.py into three separate example files.
42-
- Expanded `docs/sdk_developers/checklist.md` with a self-review guide for all pull request submission requirements (#645).
43-
- Expanded docs/sdk_developers/signing.md to clarify GPG and DCO requirements and add a Table of Contents (#455).
44-
- chore: Standardized client initialization across all examples/ files to promote consistency (#658).
45-
- chore: changed the file names of airdrop examples, classes, unit and integration tests so they are grouped together. (#631)
46-
- Refactor `AbstractTokenTransferTransaction` to unify Token/NFT transfer logic.
47-
48-
### Fixed
49-
- Added explicit read permissions to examples.yml (#623)
50-
- Removed deprecated Logger.warn() method and legacy parameter swap logic from get_logger() (#673).
51-
- Improved type hinting in `file_append_transaction.py` to resolve 'mypy --strict` errors. ([#495](https://github.com/hiero-ledger/hiero-sdk-python/issues/495))
52-
- fix: Resolve `__eq__` type conflict in `CustomFee` class (#627)
53-
- Fixes a type conflict in `token_id.py` where `from_string` could receive `None`, preventing a runtime error by raising a `ValueError` if the input is missing. #630
54-
- Dependabot alerts (version bumps)
55-
- Fixed incorrect `TokenType` import (protobuf vs. SDK enum) in 18 example files.
56-
- Update `schedule_sign_transaction_e2e_test` to check for key presence instead of relying on index.
57-
58-
### Breaking Changes
59-
- chore: changed the file names airdrop classes (#631)
60-
{pending_airdrop_id.py -> token_airdrop_pending_id.py}
61-
{pending_airdrop_record.py -> token_airdrop_pending_record.py}
62-
{token_cancel_airdrop_transaction.py -> token_airdrop_transaction_cancel.py}
63-
64-
- In `TokenAirdropTransaction` the parameters of the following methods have been renamed:
65-
- add_nft_transfer(sender → sender_id, receiver → receiver_id)
66-
- add_approved_nft_transfer(sender → sender_id, receiver → receiver_id)
67-
68-
## [0.1.7] - 2025-10-28
9+
- 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.
10+
- Unified balance and transfer logging format — both now consistently display values in hbars for clarity.
6911

7012
### Added
71-
72-
- Expanded `README.md` with a new "Follow Us" section detailing how to watch, star, and fork the repository (#472).
7313
- Refactored `examples/topic_create.py` into modular functions for better readability and reuse.
7414
- Add Rebasing and Signing section to signing.md with instructions for maintaining commit verification during rebase operations (#556)
7515
- 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
7616
- Added Google-style docstrings to `CustomFractionalFee` class and its methods in `custom_fractional_fee.py`.
7717
- Added `dependabot.yaml` file to enable automated dependency management.
7818
- Common issues guide for SDK developers at `examples/sdk_developers/common_issues.md`
7919
- Added documentation for resolving changelog conflicts in `docs/common_issues.md`
80-
- Added comprehensive changelog entry guide at `docs/sdk_developers/changelog.md` to help contributors create proper changelog entries (#532).
20+
- - Added comprehensive changelog entry guide at `docs/sdk_developers/changelog.md` to help contributors create proper changelog entries (#532).
8121
- docs: Added Google-style docstrings to `CustomFixedFee` class and its methods in `custom_fixed_fee.py`.
8222
- docs: Add Google-style docstrings to `CustomRoyaltyFee` class and its methods in `custom_royalty_fee.py`.
8323
- docs: Add Google-style docstrings to `AbstractTokenTransferTransaction` class and its methods in `abstract_token_transfer_transaction.py`.
8424
- docs: Add Google-style docstrings to `TokenRelationship` class and its methods in `token_relationship.py`.
8525
- feat: add initial testing guide structure
8626
- Added `checksum` filed for TopicId, FileId, ContractId, ScheduleId class
87-
- Added workflow for running example scripts.
88-
- docs: workflow.md documenting key steps to creating a pull request (#605)
89-
- Added `docs/discord.md` explaining how to join and navigate the Hiero community Discord (#614).
90-
9127

9228
### Changed
9329

94-
- Added direct links to Python SDK channel in Linux Foundation Decentralized Trust Discord back in
95-
- Updated all occurrences of non-functional Discord invite links throughout the documentation with the new, stable Hyperledger and Hedera invite links (#603).
9630
- Refactored TopicId class to use @dataclass decorator for reducing boilerplate code
9731
- Renamed `examples/nft_allowance.py` to `examples/account_allowance_nft.py` for consistency with account class naming scheme
9832
- Added changelog conflict resolution examples to `docs/common_issues.md`
@@ -109,11 +43,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
10943
- Converted monolithic function in `token_create_nft_infinite.py` to multiple modular functions for better structure and ease.
11044
- docs: Use relative paths for internal GitHub links (#560).
11145
- Update pyproject.toml maintainers list.
112-
– docs: Updated README.md/CHANGELOG.md and added blog.md, bud.md and setup.md (#474)
113-
- renamed docs/sdk_developers/changelog.md to docs/sdk_developers/changelog_entry.md for clarity.
114-
- 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.
115-
- Unified balance and transfer logging format — both now consistently display values in hbars for clarity.
116-
46+
- Refactored token-related example scripts (`token_delete.py`, `token_dissociate.py`, etc.) for improved readability and modularity. [#370]
11747
### Fixed
11848

11949
- Add type hints to `setup_client()` and `create_new_account()` functions in `examples/account_create.py` (#418)
@@ -161,8 +91,6 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
16191
- Improved `CONTRIBUTING.md` by explaining the /docs folder structure and fixing broken hyperlinks.(#431)
16292
- Converted class in `token_nft_info.py` to dataclass for simplicity.
16393

164-
165-
16694
### Fixed
16795

16896
- Incompatible Types assignment in token_transfer_list.py
@@ -175,7 +103,6 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
175103
- Add strict type hints to `TransactionGetReceiptQuery` (#420)
176104
- Fixed broken documentation links in CONTRIBUTING.md by converting absolute GitHub URLs to relative paths
177105
- Updated all documentation references to use local paths instead of pointing to hiero-sdk project hub
178-
- chore: fix the examples workflow to log error messages and run on import failure (#738)
179106

180107
## [0.1.5] - 2025-09-25
181108

@@ -465,4 +392,4 @@ contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
465392

466393
### Removed
467394

468-
- N/A
395+
- N/A

examples/topic_create.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
"""
2-
uv run examples/topic_create.py
3-
python examples/topic_create.py
4-
"""
1+
# uv run examples/topic_create.py
2+
# python examples/topic_create.py
3+
"""Create a new topic on Hedera"""
4+
55
import os
66
import sys
77
from typing import Tuple

0 commit comments

Comments
 (0)