Fix conflicting comment on rent fee#304
Merged
Merged
Conversation
The comment for rentFeeCharged stated it is part of totalNonRefundableResourceFeeCharged, contradicting the comment on totalRefundableResourceFeeCharged which lists the rent fee as one of its components. Rent is a refundable resource, so rentFeeCharged is part of totalRefundableResourceFeeCharged.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects the documentation comment for rentFeeCharged in SorobanTransactionMetaExtV1 to accurately describe rent as a component of totalRefundableResourceFeeCharged, aligning it with the surrounding fee breakdown documentation.
Changes:
- Update the
rentFeeChargedcomment to state it is part oftotalRefundableResourceFeeCharged(not non-refundable). - Resolve an internal documentation contradiction within
SorobanTransactionMetaExtV1’s Soroban fee component descriptions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dmkozh
approved these changes
Jun 9, 2026
sisuresh
added a commit
to sisuresh/stellar-xdr-next
that referenced
this pull request
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Correct the documentation comment on
rentFeeChargedinSorobanTransactionMetaExtV1so it describes the rent fee as a component oftotalRefundableResourceFeeCharged.Why
The struct contained two comments that contradicted each other: the comment on
totalRefundableResourceFeeChargedlists the rent fee as one of its components, while the comment onrentFeeChargedstated it was part oftotalNonRefundableResourceFeeCharged. Rent is a refundable Soroban resource that is charged based on actual usage, as documented in the Stellar fees, resource limits, and metering docs, so the comment onrentFeeChargedwas the incorrect one.Generated by Claude Code