Clarify smart contract Pirc2#355
Open
Tsukimarf wants to merge 6 commits intoPiNetwork:mainfrom
Open
Conversation
Logo blockchain PI to exchange crypto this new browser
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
1 participant
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.
Summary
This PR proposes revisions to the PiRC2 Subscription Contract API specification to improve clarity, consistency, and completeness of the smart contract definitions.
Changes
Updated and clarified smart contract spec sections for accuracy and readability
Improved descriptions of contract behaviors, parameters, and expected outputs
Ensured alignment between spec sections (data types, error codes, lifecycle methods)
Motivation
The existing PiRC2 spec contains areas where the contract behavior is ambiguous or underspecified, which could lead to inconsistent implementations by developers building on Pi Network. These changes aim to reduce ambiguity and make the spec easier to follow.
Related Sections
3-data-types
4-error-codes
5-constructor-and-service-management
6-subscription-lifecycle
Testing / Verification
Reviewed against the Soroban smart contract model and cross-referenced with existing PiRC2 sections for internal consistency.