Welcome to the Grainlify Stellar Contracts documentation. This index provides a centralized entry point for all project documentation, organized by topic.
| Document | Description |
|---|---|
| Architecture | Smart contract architecture for escrow and program escrow contracts |
| Versions | Contract versioning policy and compatibility matrix |
| Contributing | Contribution guidelines and build artifact hygiene |
| Storage and TTL Model | Soroban storage classes, TTL handling, archival risk, and extension guidance |
| Document | Description |
|---|---|
| Bounty Escrow README | Overview of the bounty escrow contract |
| Security | Security model, threat analysis, and mitigations |
| Circuit Breaker | Circuit breaker mechanism and retry-logic documentation |
| Implementation Checklist | Implementation task tracking |
| Analytics Documentation | Analytics views and query functions |
| Analytics Implementation Summary | Analytics module implementation details |
| Incremental Aggregates Implementation Notes | Historical implementation notes for O(1) aggregate counters |
| Feature Completion Report | Feature delivery status report |
| Auto Refund Tests | Auto-refund test documentation |
| CI Checks Summary | CI pipeline checks overview |
| Document | Description |
|---|---|
| Program Escrow README | Overview of the program escrow contract |
| Reentrancy Guard | Reentrancy guard mechanism documentation |
| Analytics Events | Event structures and analytics integration |
| Implementation Summary | Query functions implementation summary |
| Document | Description |
|---|---|
| Event Schema | Comprehensive event schema reference for all contracts |
| Event Versioning | Event payload versioning rules and compatibility |
| Document | Description |
|---|---|
| Governance Integration | Governance integration across contracts |
| Document | Description |
|---|---|
| Query Documentation | Query function reference and usage |
| Query Quick Reference | Quick reference for query functions |
| SDK README | TypeScript SDK overview and usage |
| SDK API Reference | Generated TypeDoc reference for SDK classes, methods, and exported types |
| SDK Error Mapping | SDK error types and mapping |
| Issue #84 Invocation Notes | Historical notes for real Soroban SDK invocation |
| Document | Description |
|---|---|
| Bounty Escrow Security | Security model for the bounty escrow contract |
| Reentrancy Guard | Reentrancy guard for program escrow |
| Circuit Breaker | Circuit breaker safety mechanism |
| Document | Description |
|---|---|
| Admin Tests Summary | Admin function test coverage summary |
| Implementation Summary | Escrow history query implementation summary |
| Feature Delivery Summary | Bounty escrow analytics feature delivery |
| Document | Description |
|---|---|
| Soroban README | Soroban project structure and setup |
| Program Escrow Duplication Audit | Audit of soroban/contracts/program-escrow vs the production program-escrow crate, including TTL-fix parity findings |
| Document | Description |
|---|---|
| Scripts README | Build, deployment, and utility scripts |
| Deployment Runbook | End-to-end deploy, verify, upgrade, rollback, registry, and mainnet safety procedures |
- New contributors: Start with Architecture and Contributing
- Contract developers: Review the contract-specific sections under Contracts
- Frontend/SDK developers: See Queries and SDK
- Security reviewers: Focus on the Security section
- Event consumers: Refer to Events for schema and versioning