Merge branch 'main' into chore/refactor-token-examples

Author: MonaaEid

.env.example

@@ -1,6 +1,6 @@
-OPERATOR_ID=<YOUR_OPERATOR_ID> #your private key, can be retrived from https://portal.hedera.com/dashboard
-OPERATOR_KEY=<YOUR_PRIVATE_KEY> # your account id, can be retrieved from https://portal.hedera.com/dashboard
-NETWORK=<NETWORK> #eg testnet/previewnet/mainnet
+OPERATOR_ID=<YOUR_OPERATOR_ID> #your account id, can be retrived from https://portal.hedera.com/dashboard
+OPERATOR_KEY=<YOUR_PRIVATE_KEY> #your testnet private key, can be retrieved from https://portal.hedera.com/dashboard
+NETWORK=<NETWORK> #eg testnet/local/previewnet/mainnet, default to testnet or local
 
 # RECIPIENT_ID=<RECIPIENT_ID> #optional
 # RECIPIENT_KEY=<RECIPIENT_KEY>  #optional

.github/dependabot.yml

@@ -14,14 +14,4 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
-    open-pull-requests-limit: 10
-  - package-ecosystem: "pip-compile"
-    directory: "/"
-    schedule:
-      interval: "daily"
-    open-pull-requests-limit: 10
-  - package-ecosystem: "pipenv"
-    directory: "/"
-    schedule:
-      interval: "daily"
-    open-pull-requests-limit: 10
+    open-pull-requests-limit: 10

.github/workflows/examples.yml

@@ -0,0 +1,68 @@
+name: Run Examples
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: 
+      - "**"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  run-examples:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
+        with:
+          egress-policy: audit
+
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+        with:
+          fetch-depth: 0
+          
+      - name: Install uv
+        uses: astral-sh/setup-uv@1781c6eb42f98d67097986d30130a8ff6879fda2
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Generate Proto Files
+        run: uv run python generate_proto.py
+
+      - name: Prepare Hiero Solo
+        id: solo
+        uses: hiero-ledger/hiero-solo-action@6a1a77601cf3e69661fb6880530a4edf656b40d5 #v0.14.0
+        with:
+          installMirrorNode: true
+      - name: Run Examples
+        env:
+          OPERATOR_ID: ${{ steps.solo.outputs.accountId }}
+          OPERATOR_KEY: ${{ steps.solo.outputs.privateKey }}
+          CHAIN_ID: 012A
+          NETWORK: solo
+        shell: bash
+        run: |
+          set -euo pipefail
+          files=$(ls examples/*.py)
+
+          for file in $files;
+          do
+            echo -e "\n************ ${file} ************"
+
+            module="examples.$(basename "$file" .py)"
+
+            # Run the example and capture both stdout and stderr
+            if ! output=$(uv run -m "$module" 2>&1); then
+              echo -e "\n❌ Example failed: ${file}"
+              echo "************ Error Output ************"
+              echo "$output"
+              echo "**************************************"
+              exit 1
+            fi
+
+            echo "$output"
+            echo "✅ Completed ${file} successfully."
+          done

.github/workflows/pr-checks.yml

@@ -31,12 +31,12 @@ jobs:
       statuses: write
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
         with:
           egress-policy: audit
 
       - name: Check PR Title
-        uses: step-security/conventional-pr-title-action@8a8989588c2547f23167c4c42f0fb2356479e81b # v3.2.1
+        uses: step-security/conventional-pr-title-action@cb1c5657ccf4c42f5c0a6c0708cb8251b960d902 # v3.2.5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -47,7 +47,7 @@ jobs:
       contents: read
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
         with:
           egress-policy: audit
 

.github/workflows/publish.yml

@@ -18,15 +18,15 @@ jobs:
       id-token: write
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
         with:
           egress-policy: audit
 
       - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Set up Python
-        uses: actions/setup-python@7f4fc3e22c37d6ff65e88745f38bd3157c663f7c # v4.9.1
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
 
       - name: Upgrade pip
         run: pip install --upgrade pip
@@ -41,4 +41,4 @@ jobs:
         run: python -m build
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # release/v1
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1

.github/workflows/test.yml

@@ -18,25 +18,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
         with:
           egress-policy: audit
 
       - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
 
       - name: Install uv
-        uses: astral-sh/setup-uv@38f3f104447c67c051c4a08e39b64a148898af3a # v4.2.0
+        uses: astral-sh/setup-uv@2ddd2b9cb38ad8efd50337e8ab201519a34c9f24 # v7.1.1
 
       - name: Install setuptools wheel
         run: pip install --upgrade pip setuptools wheel
@@ -49,7 +49,7 @@ jobs:
 
       - name: Prepare Hiero Solo
         id: solo
-        uses: hiero-ledger/hiero-solo-action@b76850c1ac44466900f8e7412b309c3aa0f539c1 # v0.14
+        uses: hiero-ledger/hiero-solo-action@6a1a77601cf3e69661fb6880530a4edf656b40d5 # v0.14.0
         with:
           installMirrorNode: true
 

CHANGELOG.md

@@ -6,27 +6,93 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 
 ## [Unreleased]
 
-- 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.
-- Unified balance and transfer logging format — both now consistently display values in hbars for clarity.
+### Added
+- Add `TokenFeeScheduleUpdateTransaction` class to support updating custom fee schedules on tokens (#471).
+- Add `examples/token_update_fee_schedule_fungible.py` and `examples/token_update_fee_schedule_nft.py` demonstrating the use of `TokenFeeScheduleUpdateTransaction`.
+- Update `docs/sdk_users/running_examples.md` to include `TokenFeeScheduleUpdateTransaction`.
+- added FreezeTransaction class
+- added FreezeType class
+- 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)
+- feat: TokenAirdropClaim Transaction, examples (with signing required and not), unit and integration tests (#201)
+- docs: Add Google-style docstrings to `TokenId` class and its methods in `token_id.py`.
+- added Google-style docstrings to the `TransactionRecord` class including all dataclass fields, `__repr__`, `_from_proto()` & `_to_proto()` methods.
+- Standardized docstrings, improved error handling, and updated type hinting (`str | None` to `Optional[str]`) for the `FileId` class (#652).
+- Add Google-style docstrings to `AccountInfo` class and its methods in `account_info.py`.
+- Added comprehensive Google-style docstrings to the `Logger` class and all utility functions in `src/hiero_sdk_python/logger/logger.py` (#639).
+- add AccountRecordsQuery class
+- chore: added python 3.13 to test.yml workflow (#510, #449)
+- Transaction bytes serialization support: `Transaction.freeze()`, `Transaction.to_bytes()`, and `Transaction.from_bytes()` methods for offline signing and transaction storage
+- docs: Add Google-style docstrings to `ContractId` class and methods in `contract_id.py`.
+- Added TokenUnpauseTransaction class
+- Added expiration_time, auto_renew_period, auto_renew_account, fee_schedule_key, kyc_key in `TokenCreateTransaction`, `TokenUpdateTransaction` classes
+- Added comprehensive Google-style docstrings to the `CustomFee` class and its methods in `custom_fee.py`.
+- docs: Add `docs/sdk_developers/project_structure.md` to explain repository layout and import paths.
+
+### Changed
+- chore: replaced hardcoded 'testnet' messages with environment network name
+- chore: validate that token airdrop transactions require an available token service on the channel (#632) 
+- chore: update local environment configuration in env.example (#649)
+- chore: Update env.example NETWORK to encourage testnet or local usage (#659)
+- chore: updated pyproject.toml with python 3.10 to 3.13 (#510, #449)
+- chore: fix type hint for TokenCancelAirdropTransaction pending_airdrops parameter
+- chore: Moved documentation file `common_issues.md` from `examples/sdk_developers/` to `docs/sdk_developers/` for unified documentation management (#516).
+- chore: Refactored the script of examples/custom_fee.py into modular functions 
+- fix: Replaced `collections.namedtuple` with `typing.NamedTuple` in `client.py` for improved type checking.
+- chore: Refactored examples/custom_fee.py into three separate example files.
+- Expanded `docs/sdk_developers/checklist.md` with a self-review guide for all pull request submission requirements (#645).
+- Expanded docs/sdk_developers/signing.md to clarify GPG and DCO requirements and add a Table of Contents (#455).
+- chore: Standardized client initialization across all examples/ files to promote consistency (#658).
+- chore: changed the file names of airdrop examples, classes, unit and integration tests so they are grouped together. (#631)
+- Refactor `AbstractTokenTransferTransaction` to unify Token/NFT transfer logic.
+
+### Fixed
+- Added explicit read permissions to examples.yml (#623)
+- Removed deprecated Logger.warn() method and legacy parameter swap logic from get_logger() (#673).
+- Improved type hinting in `file_append_transaction.py` to resolve 'mypy --strict` errors. ([#495](https://github.com/hiero-ledger/hiero-sdk-python/issues/495))
+- fix: Resolve `__eq__` type conflict in `CustomFee` class (#627)
+- 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
+- Dependabot alerts (version bumps)
+- Fixed incorrect `TokenType` import (protobuf vs. SDK enum) in 18 example files.
+- Update `schedule_sign_transaction_e2e_test` to check for key presence instead of relying on index.
+  
+### Breaking Changes
+- chore: changed the file names airdrop classes (#631)
+{pending_airdrop_id.py -> token_airdrop_pending_id.py}
+{pending_airdrop_record.py -> token_airdrop_pending_record.py}
+{token_cancel_airdrop_transaction.py -> token_airdrop_transaction_cancel.py}
+
+- In `TokenAirdropTransaction` the parameters of the following methods have been renamed:
+  - add_nft_transfer(sender → sender_id, receiver → receiver_id)
+  - add_approved_nft_transfer(sender → sender_id, receiver → receiver_id)
+
+## [0.1.7] - 2025-10-28
 
 ### Added
+
+- Expanded `README.md` with a new "Follow Us" section detailing how to watch, star, and fork the repository (#472).
 - Refactored `examples/topic_create.py` into modular functions for better readability and reuse.
 - Add Rebasing and Signing section to signing.md with instructions for maintaining commit verification during rebase operations (#556)
 - 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
 - Added Google-style docstrings to `CustomFractionalFee` class and its methods in `custom_fractional_fee.py`.
 - Added `dependabot.yaml` file to enable automated dependency management.
 - Common issues guide for SDK developers at `examples/sdk_developers/common_issues.md`
 - Added documentation for resolving changelog conflicts in `docs/common_issues.md`
-- - Added comprehensive changelog entry guide at `docs/sdk_developers/changelog.md` to help contributors create proper changelog entries (#532).
+- Added comprehensive changelog entry guide at `docs/sdk_developers/changelog.md` to help contributors create proper changelog entries (#532).
 - docs: Added Google-style docstrings to `CustomFixedFee` class and its methods in `custom_fixed_fee.py`.
 - docs: Add Google-style docstrings to `CustomRoyaltyFee` class and its methods in `custom_royalty_fee.py`.
 - docs: Add Google-style docstrings to `AbstractTokenTransferTransaction` class and its methods in `abstract_token_transfer_transaction.py`.
 - docs: Add Google-style docstrings to `TokenRelationship` class and its methods in `token_relationship.py`.
 - feat: add initial testing guide structure
 - Added `checksum` filed for TopicId, FileId, ContractId, ScheduleId class
+- Added workflow for running example scripts.
+- docs: workflow.md documenting key steps to creating a pull request (#605)
+- Added `docs/discord.md` explaining how to join and navigate the Hiero community Discord (#614).
+
 
 ### Changed
 
+- Added direct links to Python SDK channel in Linux Foundation Decentralized Trust Discord back in
+- Updated all occurrences of non-functional Discord invite links throughout the documentation with the new, stable Hyperledger and Hedera invite links (#603).
 - Refactored TopicId class to use @dataclass decorator for reducing boilerplate code
 - Renamed `examples/nft_allowance.py` to `examples/account_allowance_nft.py` for consistency with account class naming scheme
 - Added changelog conflict resolution examples to `docs/common_issues.md`
@@ -43,6 +109,10 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Converted monolithic function in `token_create_nft_infinite.py` to multiple modular functions for better structure and ease.
 - docs: Use relative paths for internal GitHub links (#560).
 - Update pyproject.toml maintainers list.
+  – docs: Updated README.md/CHANGELOG.md and added blog.md, bud.md and setup.md (#474)
+- renamed docs/sdk_developers/changelog.md to docs/sdk_developers/changelog_entry.md for clarity.
+- 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.
+- Unified balance and transfer logging format — both now consistently display values in hbars for clarity.
 
 ### Fixed
 
@@ -91,6 +161,8 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Improved `CONTRIBUTING.md` by explaining the /docs folder structure and fixing broken hyperlinks.(#431)
 - Converted class in `token_nft_info.py` to dataclass for simplicity.
 
+
+
 ### Fixed
 
 - Incompatible Types assignment in token_transfer_list.py
@@ -103,6 +175,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Add strict type hints to `TransactionGetReceiptQuery` (#420)
 - Fixed broken documentation links in CONTRIBUTING.md by converting absolute GitHub URLs to relative paths
 - Updated all documentation references to use local paths instead of pointing to hiero-sdk project hub
+- chore: fix the examples workflow to log error messages and run on import failure (#738)
 
 ## [0.1.5] - 2025-09-25