docs(contract): add top-level //! doc comments to lib.rs#353
Merged
Yunusabdul38 merged 1 commit intoAgora-Events:mainfrom Mar 28, 2026
Merged
Conversation
Adds module-level documentation covering Overview, Architecture, and Usage sections as requested in issue Agora-Events#323. Explains the EventRegistry module structure, key data types, storage strategy, and how EventRegistry interacts with the TicketPayment contract for inventory management during purchase and refund flows.
|
@Coredevjay is attempting to deploy a commit to the oseh-svg's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@Coredevjay Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Yunusabdul38
approved these changes
Mar 28, 2026
Simongodw
added a commit
to Simongodw/agora
that referenced
this pull request
Mar 29, 2026
…s#353) This PR removes hardcoded transfer fee values and introduces a centralized `TRANSFER_FEE_BPS` constant to standardize fee handling. It improves readability, maintainability, and auditability without changing existing contract behavior.
Yunusabdul38
added a commit
that referenced
this pull request
Mar 29, 2026
* docs(contract): add top-level //! doc comments to lib.rs (#353) This PR removes hardcoded transfer fee values and introduces a centralized `TRANSFER_FEE_BPS` constant to standardize fee handling. It improves readability, maintainability, and auditability without changing existing contract behavior. * Delete package-lock.json --------- Co-authored-by: Yunus Abdulmajid <[email protected]>
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
2 participants
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.
Closes #323
Summary
Adds module-level
//!documentation to the top ofcontract/contracts/event_registry/src/lib.rs.What's included
event-registrycrate does and its role on the platform.persistent-storage strategy.
EventRegistry ↔ TicketPayment interaction model (purchase flow,
refund flow, payment info query).