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
Understand the project
Review the codebase
SHIELD tokenomics
Deploy contracts
FAssets bridge
Revenue system
Staking boost
Vault specification
Documentation Structure
Protocol (/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)
/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)
/platform)Application architecture and wallet integration.
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)
/api)README.md - API endpoint reference
Legal (/legal)
/legal)Key Resources
Live App: shyield.finance
Technical Overview: replit.md
Design System: design_guidelines.md
Full Index: DOCUMENTATION_INDEX.md
Last Updated: December 2025
Last updated