feat: Added doc on how to create token transaction. #1190
Conversation
Signed-off-by: Adityarya11 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #1190 +/- ##
=======================================
Coverage 91.26% 91.26%
=======================================
Files 139 139
Lines 8447 8447
=======================================
Hits 7709 7709
Misses 738 738 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive training documentation for SDK developers on creating token transactions in the Hiero Python SDK. The guide provides a structured, step-by-step architectural overview covering the essential patterns and requirements for implementing new transaction types.
Key Changes:
- Added
docs/sdk_developers/training/coding_token_transactions.mdwith detailed guidance on transaction implementation - Updated
CHANGELOG.mdto document the new training resource
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
docs/sdk_developers/training/coding_token_transactions.md |
New training document covering inheritance structure, initialization patterns, builder pattern implementation, protobuf conversion, scheduling support, and network routing for token transactions |
CHANGELOG.md |
Added entry documenting the new training documentation under the "Added" section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📝 WalkthroughWalkthroughAdded a new training document explaining how to construct token transaction types in the Hiero Python SDK and updated the changelog to list this new documentation entry. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolCHANGELOG.md[uncategorized] ~59-~59: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
CHANGELOG.mddocs/sdk_developers/training/coding_token_transactions.md
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[uncategorized] ~59-~59: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ed coding_token_transactions.md for a high level overview training on how token transact...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Agent
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: build-and-test (3.11)
- GitHub Check: build-and-test (3.10)
- GitHub Check: build-and-test (3.12)
- GitHub Check: build-and-test (3.13)
- GitHub Check: run-examples
- GitHub Check: StepSecurity Harden-Runner
🔇 Additional comments (2)
docs/sdk_developers/training/coding_token_transactions.md (2)
1-149: Comprehensive training document covering all PR objectives.The documentation is well-structured, clearly written, and successfully addresses all requirements from issue #863. It effectively explains the architectural patterns for creating token transactions, from inheritance through Protobuf conversion to gRPC routing.
68-133: All documented methods and Protobuf patterns are accurate and match the codebase.The referenced base class methods
build_base_transaction_body()andbuild_base_scheduled_body()exist as documented, the_build_proto_body()helper pattern is correctly implemented, and thetransaction_body.tokenAssociate.CopyFrom()usage pattern matches actual implementations in token transactions likeTokenAssociateTransaction. The three-step process for Protobuf conversion is accurate to how the code works.
exploreriii
left a comment
exploreriii
left a comment
There was a problem hiding this comment.
Hi @Adityarya11 this is approved! Really excellent work! I like how you kept it short yet very accurate
One minor suggestion is provided - could you help to create a good first issue to solve that?
Ideally we demonstrate the benefit of method chaining, with reference to an existing example, copying some content from examples/tokens
|
Also please rebase :D |
Signed-off-by: notsogod <[email protected]>
Sorry but what exactly to create the issue |
|
yes |
Will create one soon. |
Signed-off-by: Adityarya11 <[email protected]> Signed-off-by: notsogod <[email protected]> Signed-off-by: prishajaiswal75 <[email protected]>
2 participants
Description:
This PR adds a new training document:
docs/sdk_developers/training/coding_token_transactions.md.This guide provides a high-level architectural overview of how to create a new token transaction class in the Python SDK, covering:
Transaction.__init__pattern with defaultNonevalues.set_account_id).build_transaction_bodyand_build_proto_body.build_scheduled_body._get_methodfor gRPC calls.Related issue(s):
Fixes #863
Checklist