TrustLedger Documentation¶
Home · Top · Table of Contents
Table of Contents¶
- Start Here
- Operations
- Tooling and Reference
- Meta
- Reports
- Compatibility Pages
- Authors and Contributors
- Legal
Kevin K. Le (LinkedIn) — Founder, Founding Engineer, and Current Lead Engineer; Software Engineer at the Oregon Blockchain Group, University of Oregon.
Kellen Snider — Founding Engineer; Software Engineer at the Oregon Blockchain Group, University of Oregon. His vision, ideas, and dedication during TrustLedger's Ethereum development were invaluable to the codebase we build on today.
See
CREDITS.md.
This page is the documentation entry point for developers, reviewers, operators, and frontend contributors working on TrustLedger.
Start Here¶
Home · Top · Table of Contents
| Document | Use It For |
|---|---|
| Architecture | System components, data flow, and network support. |
| Smart Contracts | Contract-by-contract reference for Solidity APIs. |
| Escrow Lifecycle | Proposal, funding, work, approval, dispute, warranty, and rating flows. |
| Arbitration | Juror selection, commit-reveal voting, appeals, rewards, and slashing. |
| Deployment | Local and Ethereum Sepolia deployment with current scripts. |
| Testing | Foundry, Hardhat, frontend, fork, lint, and CI test commands. |
| Environment | Required and optional environment variables. |
| Sepolia Faucets | Current Sepolia ETH faucet options, rate limits, and debugging tips. |
| CI/CD | GitHub Actions workflow triggers, jobs, secrets, and gotchas. |
| Frontend | Next.js app structure, wallet config, API routes, and services. |
| Analytics | Privacy-safe wallet metrics, visual generation, and native kernels. |
| Audit Readiness | Auditor package, threat model, invariants, and remediation tracker. |
| GitHub Models | AI helper scripts, prompt evaluation, and workflow notes. |
| TypeScript SDK | ABI, TypeChain, helper exports, and TypeScript usage. |
| Security | Access control, escrow risks, arbitration risks, and audit status. |
| GitHub Rulesets | Server-side rules for blocking sensitive files and secret pushes. |
| Legal And Compliance | Legal document inventory, review triggers, and jurisdiction caveats. |
| Contributing | Setup, style, linting, docs, and PR expectations. |
| Core Layer | Config, cache, errors, flags, events, and permission primitives. |
| Oracle | Chainlink VRF integration, randomness requests, and fulfillment flow. |
| Solana | Solana escrow program, USDC support, and Anchor client setup. |
| Wallets | Supported wallets, connection patterns, and WalletConnect config. |
| Admin Dashboard | Admin API endpoints, role checks, and operational tools. |
| Quality Standards | React Doctor, TypeScript strictness, accessibility, and release gates. |
Operations¶
Home · Top · Table of Contents
| Document | Use It For |
|---|---|
| Infrastructure | Topology overview, containers, Kubernetes, and operational runbook. |
| Docker | Image builds, compose stacks, and local dev/CI containers. |
| Kubernetes | Manifests, Kustomize, HPA, secrets, and deployment procedures. |
Tooling and Reference¶
Home · Top · Table of Contents
| Document | Use It For |
|---|---|
| Utilities | Shared helper functions, formatting, and validation utilities. |
| Type Stubs | Hand-written .d.ts stubs for untyped or partially typed packages. |
| SWC and Artifacts | SWC compiler config, generated artifacts, and build output. |
| CodeRabbit | AI code-review config, review profiles, and suppression rules. |
Meta¶
Home · Top · Table of Contents
| Document | Use It For |
|---|---|
| Agent and Task Context | Role-scoped commands, invariants, and quality gates for AI agents. |
| Credits | Authors, contributors, and third-party acknowledgements. |
| Demo | Demo environment setup and walkthrough guide. |
| Presentation | Slide deck and pitch materials. |
Reports¶
Home · Top · Table of Contents
| Document | Use It For |
|---|---|
| Audit Report | Latest security audit findings and remediation status. |
| Coverage Gap Report | Test coverage gaps by module. |
| Dependency Health Report | Dependency freshness and vulnerability summary. |
Compatibility Pages¶
Home · Top · Table of Contents
Some legacy docs are kept because MkDocs, the generated wiki home, or external links may still reference them. When a topic has a canonical page, the legacy page links to the canonical version instead of duplicating stale details.
| Legacy Page | Canonical Page |
|---|---|
| Contract Reference | Smart Contracts |
| FAQ | Topic-specific docs above |
| Miscellaneous | Topic-specific docs above |
Authors and Contributors¶
Home · Top · Table of Contents
- Kevin K. Le — Founder, Founding Engineer, and Current Lead Engineer (LinkedIn)
- Kellen Snider — Founding Engineer (LinkedIn)
See CREDITS.md for the complete acknowledgement list.
Legal¶
Home · Top · Table of Contents
This document is part of TrustLedger, an open-source decentralized escrow and
arbitration protocol. Use of this software and documentation is subject to the
Terms and Conditions,
Privacy Policy, and Risk Disclosure.
See LEGAL.md for the full compliance and licensing overview.