Shield Finance Documentation
Welcome to the Shield Finance documentation. This is the primary entry point for all project documentation.
Read the Whitepaper (PDF) — Complete technical documentation covering protocol architecture, yield mechanics, and SHIELD tokenomics.
Quick Navigation
Section titled “Quick Navigation”| Goal | Document |
|---|---|
| Understand the project | Whitepaper (PDF) |
| Review the codebase | REVIEWERS.md |
| Claim airdrop | AIRDROP_CLAIM_GUIDE.md |
| SHIELD tokenomics | SHIELD_TOKENOMICS.md |
| Deploy contracts | SHIELD_DEPLOYMENT.md |
| FAssets bridge | FASSETS_GUIDE.md |
| Revenue system | REVENUE_SYSTEM_SPEC.md |
| Staking boost | STAKING_BOOST_SPEC.md |
| Vault specification | SHXRP_VAULT_SPECIFICATION.md |
Documentation Structure
Section titled “Documentation Structure”Protocol (/protocol)
Section titled “Protocol (/protocol)”Core smart contract and tokenomics documentation.
- SHIELD_TOKENOMICS.md - Token economics, revenue split (50/40/10)
- SHIELD_DEPLOYMENT.md - Contract deployment steps
- STAKING_BOOST_SPEC.md - APY boost mechanics
- REVENUE_SYSTEM_SPEC.md - BuybackBurn & RevenueRouter
- SHIELD_SECURITY_CHECKLIST.md - Pre-audit checklist
Integration (/integration)
Section titled “Integration (/integration)”External service integration guides.
- FASSETS_GUIDE.md - XRP → FXRP bridging (canonical)
- FIRELIGHT_INTEGRATION.md - Yield strategies
- LP_LOCKING_GUIDE.md - Liquidity management
Platform (/platform)
Section titled “Platform (/platform)”Application architecture and wallet integration.
- AIRDROP_CLAIM_GUIDE.md - Airdrop eligibility & claiming
- SMART_ACCOUNTS_SPEC.md - ERC-4337 specification
- wallet-integration.md - Wallet connection
- xaman-integration.md - XRPL wallet
- swap.md - Multi-asset swap feature
API (/api)
Section titled “API (/api)”- README.md - API endpoint reference
Legal (/legal)
Section titled “Legal (/legal)”Key Resources
Section titled “Key Resources”- Live App: shyield.finance
- Technical Overview: replit.md
- Design System: design_guidelines.md
- Full Index: DOCUMENTATION_INDEX.md
Last Updated: December 2025