-
Notifications
You must be signed in to change notification settings - Fork 130
Deprecated initialize_admin path documentation and guardrails #726
Copy link
Copy link
Open
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programadminDesign / UX backlog: adminDesign / UX backlog: admindeprecationAuto label for contract issues: deprecationAuto label for contract issues: deprecationpriority-lowAuto label for contract issues: priority-lowAuto label for contract issues: priority-lowsmart-contractsAuto label for contract issues: smart-contractsAuto label for contract issues: smart-contractstestingAuto label for contract issues: testingAuto label for contract issues: testing
Description
Description
Clarify migration from initialize_admin to initialize; add warnings in docs and tests.
Requirements and context
- Must be secure, tested, and documented
- Should be efficient and easy to review
- Align with existing Soroban contract patterns in
quicklendx-contracts
Suggested execution
- Fork the repo and create a branch
git checkout -b feature/initialize-admin-deprecation- Implement changes
- Write contract:
src/lib.rs,src/admin.rs - Write comprehensive tests:
src/test_admin.rs - Add documentation:
docs/contracts/admin.md - Include NatSpec-style comments (Rust doc comments on public items)
- Validate security assumptions
Test and commit
- Run tests
- Cover edge cases
- Include test output and security notes
Example commit message
docs: clarify initialize_admin deprecation
Guidelines
- Minimum 95 percent test coverage
- Clear documentation
- Timeframe: 96 hours
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programadminDesign / UX backlog: adminDesign / UX backlog: admindeprecationAuto label for contract issues: deprecationAuto label for contract issues: deprecationpriority-lowAuto label for contract issues: priority-lowAuto label for contract issues: priority-lowsmart-contractsAuto label for contract issues: smart-contractsAuto label for contract issues: smart-contractstestingAuto label for contract issues: testingAuto label for contract issues: testing