Skip to content

Latest commit

 

History

History
95 lines (76 loc) · 6.99 KB

index.md

File metadata and controls

95 lines (76 loc) · 6.99 KB

Documentation Index

Start here when you are looking for ILN protocol, contract, service, or contributor documentation.

Getting Started

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.

Architecture And Protocol

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.
Reputation Model Reputation and NFT lifecycle guide: initialization, accrual, lazy decay, NFT interaction, source of truth.
Reputation System Reputation mechanics, parameters, events, and FAQ.
Multi-Token Support SAC, USDC, XLM, and supported token configuration.
Token Safety Token admission checks, decimals, SAC authorization, frozen accounts, clawback, and escrowed payouts.
Storage Layout Contract storage keys and data structures.

Security And Operations

Document Description
Security Policy Vulnerability classes, reporting, response timelines, severity, and safe harbor.
Threat Model Trust assumptions, risks, and mitigations.
Governance Security Summary Reviewer-facing synthesis of governance-hardening findings: quadratic voting, delegation bounds, snapshot timing, spam resistance, quorum, and the veto sunset roadmap.
Public Status Page Public, non-sensitive protocol-health page: what is shown/excluded, hosting decision, thresholds, failure behaviour.
Incident Response Runbook Protocol-wide incident coordination: severity, roles, pause() decision authority, communication, and links to every component runbook.
Observability Standards Structured JSON logging format and the correlation-ID scheme across the indexer and notifications services.
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.
Mainnet Launch Notes User-facing testnet-to-mainnet changes, known limitations, and migration notes.
Mainnet Deployment Runbook Dry-run-verified procedure for deploying, verifying, and publishing mainnet contracts.
Pre-Audit Checklist Audit preparation tasks.
Formal Verification (lifecycle) Invoice/governance invariants.
Formal Verification (cross-contract) ILN × distribution × insurance system invariants.
Cross-Contract Proof Obligations Machine-checked registry mapping each cross-contract invariant to its code path and discharging test.

Protocol Economics & Risk

Read in this order when onboarding to protocol economics, LP risk, and governance operations. Deeper attack/insurance models follow the guides.

Order Document Description
1 LP Risk Management Guide Default, yield, lock-up, oracle, and governance risks for LPs; working assumptions and checklist.
2 Governance Operations Playbook Steady-state proposal flow, emergency pause/oracle/insurance paths, parameter-change checklist.
3 Token Economics Paper Value loop, baseline projections, kill-criteria, and testnet validation findings.
4 Oracle Attack Economics Cost/benefit model for payer-oracle manipulation at current parameters.
5 Insurance Pool Design Default-protection pool interface, claims, and integration.
6 Insurance Pool Launch Parameters Recommended premium, coverage tiers, caps, and circuit-breaker values.
— Economics & Risk Review Cadence Who reviews these assumptions, how often, and what each cycle re-validates.

The SCF technical narrative points here instead of duplicating economics content.

Integrations

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.
Oracle Provider Vetting Governance vetting criteria and proposal template for approving oracle providers.
Oracle Attack Economics Cost/benefit model of oracle manipulation at current parameters, with recommendations.

Community, SCF, And Partners

Document Description
Integration Partner Onboarding Stable surfaces, upgrade expectations, support path, and mainnet go-live checklist for external integrators.
Public Audit Findings Summary Template for publishing audit finding ID, severity, public excerpt, status, and remediation links.
SCF Grant Milestone Tracker Maps this batch’s issues to SCF-style deliverables via labels (no duplicated status).
Support Channels Where to report bugs, ask questions, and disclose vulnerabilities.
SCF Technical Narrative Protocol overview and hardening summary for Community Fund reviewers.

Project Process

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.
Support Channels Where to report bugs, ask questions, and request features.