[Docs] Write complete smart contract API reference documentation

[grantfox-oss]

Getting Started

1. Fork the repository: https://github.com/JointSave-org/Joint_Save
2. Clone your fork:

   git clone https://github.com/<your-username>/Joint_Save.git
   cd Joint_Save

3. Create a new branch:

   git checkout -b docs/smart-contract-api-reference

---

Overview

smartcontract/README.md is minimal. There is no complete API reference for the four contracts, making it difficult for developers to integrate with or build on top of JointSave.

Requirements

Expand smartcontract/README.md or create docs/contract-api.md with the following for each of the four contracts:

1. Overview — what it does and when to use it
2. Deployment — how to deploy from WASM hash
3. Functions table — Function Name | Parameters | Returns | Auth Required | Description
4. Events table — Event Topic | Event Body | Emitted When
5. Storage Keys — key, type, lifetime
6. Error conditions — every assert! message and what triggers it
7. Example CLI invocations using stellar contract invoke

Acceptance Criteria

• All 4 contracts fully documented
• Every public function has an entry in the functions table
• Every env.events().publish(...) call documented in the events table
• Every assert! documented in error conditions
• Example CLI invocations for common operations
• README.md and ARCHITECTURE.md link to the new API reference

[Swayymalcolm99]

Hey maintainer can I take this?

[Johnpii1]

Hello Sir,

I came across your project and I’m really interested in contributing.

I have experience with React for building responsive, user-friendly interfaces, and I’m also familiar with smart contracts and blockchain basics. I focus on writing clean, scalable code and improving user experience.

I’m a fast learner and ready to get started immediately. Please let me know the next steps.

Thank you.

Best regards,
Johnpaul

[olathedev]

Hi Maintainer, I'd love to work on this issue. I have experience writing developer-facing documentation for smart contract and API-based projects, and I can systematically document all public functions, events, storage keys, error conditions, and CLI examples while ensuring the new reference is properly linked from the project documentation.

[Georgebingi]

Hi I'm a full stack developer I'll like to work on this issue because It picks my interest and Ive got experience with similar projects I'll have it solved in 24 hours or less

[xJeffx23]

Hello!

My name is Jefferson, and I have been contributing to open-source projects for over a year. I have participated in multiple hackathons and have experience working on blockchain, Stellar/Soroban, and web development projects.

I would like to work on this issue because a complete smart contract API reference is very important for developers who want to integrate with or build on top of JointSave. Clear documentation for functions, events, storage keys, errors, and CLI examples would make the contracts easier to understand, test, and use.

My plan would be to review the four contracts, document every public function, event emission, storage key, and assert condition, then create or expand the API reference with practical stellar contract invoke examples. I would also update the README.md and ARCHITECTURE.md files to link to the new documentation.

I would greatly appreciate the opportunity to contribute to this project. Thank you for your time and consideration!

[grantfox-oss]

🦊 GrantFox — @xJeffx23 has been assigned to this issue as part of the Official Campaign campaign!

Next steps:

1. Open a Pull Request referencing this issue (e.g., Closes #19)
2. Your PR will be reviewed by the JointSave-org maintainers

Good luck! Track your progress on GrantFox.

[grantfox-oss]

🎉 This issue has been marked as completed on GrantFox as part of the Official Campaign campaign!

@xJeffx23's PR #21 was approved and merged by @Sendi0011.

🏆 @xJeffx23: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (48 total points). Track your full progress on GrantFox.

👏 Great work, @xJeffx23! Keep contributing to JointSave-org.