QuickLendX Protocol

QuickLendX is a monorepo containing the complete protocol stack for decentralized invoice financing on Stellar Soroban.

## Packages

- `quicklendx-contracts/`: Smart contracts and contract tests for the QuickLendX protocol.
- `quicklendx-backend/`: Backend services, API schema, and server implementation.
- `quicklendx-frontend/`: Next.js frontend application for user interaction.

## Getting Started

### Smart Contracts

```bash
cd quicklendx-contracts
cargo build
cargo test

Backend

cd quicklendx-backend
npm ci
npm run dev

Frontend

cd quicklendx-frontend
npm ci
npm run dev

Documentation

• docs/ : Project-wide design, implementation, and audit documentation. • docs/VESTING.md /docs/VESTING.md: Vesting model, edge cases, and admin protections. • docs/contracts/platform-fee-ops.md /docs/contracts/platform-fee-ops.md: Admin operations playbook for managing fee rates, treasury rotation, and revenue splits. • docs/RUNBOOK_INCIDENT_RESPONSE.md : Operator playbook for unexpected contract behavior and incident-mode recovery. • docs/INVESTOR_TIER.md : How the investor risk score, tier, and investment limit are computed — math, thresholds, and worked examples. • quicklendx-contracts/README.md : Smart contract-specific documentation. • quicklendx-contracts/docs/contracts/deterministic-time.md : Smart contract deterministic ledger time semantics. • quicklendx-backend/README.md : Backend-specific documentation. • backend/docs/REPLAY_RUNBOOK.md : Step-by-step operator runbook for replaying ingestion from a specific ledger — covers reorg recovery, gap backfill, force rebuild after schema migration, and troubleshooting stuck runs. • quicklendx-frontend/README.md : Frontend-specific documentation. • docs/PLATFORM_FEES.md : Fee schedule and tenant override documentation.

Contribution

Please follow the repository guidelines in AGENTS.md and include tests for any behavior changes.

Frontend

cd quicklendx-frontend
npm ci
npm run dev

Documentation

• docs/: Project-wide design, implementation, and audit documentation.
• Platform Fee & Treasury Split Operations Guide: Admin operations playbook for managing fee rates, treasury rotation, and revenue splits.
• docs/RUNBOOK_INCIDENT_RESPONSE.md: Operator playbook for unexpected contract behavior and incident-mode recovery.
• Dispute Lifecycle: Who can open, who resolves, timeout behaviour, and fund implications.
• docs/INVESTOR_TIER.md: How the investor risk score, tier, and investment limit are computed — math, thresholds, and worked examples.
• docs/KYC.md: Business KYC vs investor KYC, what each gates.
• quicklendx-contracts/README.md: Smart contract-specific documentation.
• quicklendx-contracts/docs/contracts/deterministic-time.md: Smart contract deterministic ledger time semantics.
• quicklendx-backend/README.md: Backend-specific documentation.
• backend/docs/REPLAY_RUNBOOK.md: Step-by-step operator runbook for replaying ingestion from a specific ledger — covers reorg recovery, gap backfill, force rebuild after schema migration, and troubleshooting stuck runs.
• quicklendx-frontend/README.md: Frontend-specific documentation.
• docs/PLATFORM_FEES.md: Fee schedule and tenant override documentation.
• docs/CURRENCY_WHITELIST.md: How tokens are added to and removed from the currency whitelist — contributor guide covering entrypoints, auth model, enforcement points, and test patterns.

Contribution

Please follow the repository guidelines in AGENTS.md and include tests for any behavior changes.