Start here when you are looking for ILN protocol, contract, service, or contributor documentation.
| Document | Description |
|---|---|
| Developer Quickstart | Rust, Stellar CLI, contract build, tests, and testnet deployment. |
| Local Development Guide | Full local stack setup for contracts, Docker services, SDK, CLI, indexer, and notifications. |
| First Invoice Tutorial | End-to-end invoice lifecycle walkthrough. |
| Glossary | Protocol terminology for DeFi, invoice factoring, Stellar, and ILN-specific concepts. |
| Document | Description |
|---|---|
| Architecture | Actors, money flow, state machine, and component boundaries. |
| Contract ABI | Public contract functions and error codes. |
| Events | Contract event topics and payloads. |
| Governance | Proposal lifecycle, voting, quorum, and timelocks. |
| Multi-Token Support | SAC, USDC, XLM, and supported token configuration. |
| Storage Layout | Contract storage keys and data structures. |
| Document | Description |
|---|---|
| Security Policy | Vulnerability classes, reporting, response timelines, severity, and safe harbor. |
| Threat Model | Trust assumptions, risks, and mitigations. |
| Access Control | Roles and authorization rules. |
| Upgrade Guide | Contract upgrade procedure and safeguards. |
| Mainnet Launch Checklist | Launch-readiness checklist with owners, statuses, and sign-off. |
| Pre-Audit Checklist | Audit preparation tasks. |
| Document | Description |
|---|---|
| SDK Integration Guide | TypeScript examples for contract interactions. |
| SDK README | Package usage for @iln/sdk. |
| Oracle Design | Optional payer-verification oracle model. |
| Oracle Integration | Deploying and registering compatible oracles. |
| Document | Description |
|---|---|
| Architecture Decision Records | ADR list and decision history. |
| CI/CD | Continuous integration and deployment workflows. |
| Code Freeze Procedure | Release freeze process. |
| Benchmarks | Gas and resource usage tracking. |