Docs/soroban contracts overview

[Chigybillionz]

closes #364

✅ Summary

This PR replaces the boilerplate contract documentation with a project-specific overview tailored to the current smart contracts implementation.

---

🧩 What was done

📚 Contract Catalog

Updated contract/README.md to clearly document:

• event_registry

  • Purpose of the contract
  • Key storage keys used
  • Main/public functions with descriptions

• ticket_payment

  • Payment flow and logic
  • Integration with Stellar assets

---

🛠️ Build & Test Instructions

• Added steps for running tests using:

  cargo test

• Documented deployment process using scripts in the /scripts directory

---

🗄️ Storage Model

• Explained how storage.rs is used for managing on-chain state
• Clarified how data is structured and accessed within contracts

---

📡 Events

• Documented emitted events from events.rs
• Explained their purpose and when they are triggered

---

⚙️ Tech Setup Clarification

• Clarified usage of Rust (Cargo) vs Scarb
• Ensured developers understand the correct toolchain for this project

---

🎯 Acceptance Criteria Met

• ✅ contract/README.md reflects actual contracts in /contracts
• ✅ Public functions for event_registry are documented
• ✅ Build, test, and deployment steps are included
• ✅ Storage and event systems are explained
• ✅ Tech stack differences clarified

---

[vercel]

@Chigybillionz 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.

[drips-wave]

@Chigybillionz 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! 🚀

Learn more about application limits

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
agora-web	Ready	Preview, Comment	Mar 30, 2026 10:57am