# Shield Finance Documentation

Welcome to the Shield Finance documentation. This is the primary entry point for all project documentation.

[**Read the Whitepaper (PDF)**](https://shyield.finance/whitepaper.pdf) — Complete technical documentation covering protocol architecture, yield mechanics, and SHIELD tokenomics.

***

## Quick Navigation

| Goal                   | Document                                                                                  |
| ---------------------- | ----------------------------------------------------------------------------------------- |
| Understand the project | [Whitepaper (PDF)](https://shyield.finance/whitepaper.pdf)                                |
| Review the codebase    | [REVIEWERS.md](https://github.com/shield-xrpfinance/shieldfinance/blob/main/REVIEWERS.md) |
| Claim airdrop          | [AIRDROP\_CLAIM\_GUIDE.md](https://docs.shyield.finance/platform/airdrop_claim_guide)     |
| SHIELD tokenomics      | [SHIELD\_TOKENOMICS.md](https://docs.shyield.finance/protocol/shield_tokenomics)          |
| Deploy contracts       | [SHIELD\_DEPLOYMENT.md](https://docs.shyield.finance/protocol/shield_deployment)          |
| FAssets bridge         | [FASSETS\_GUIDE.md](https://docs.shyield.finance/integration/fassets_guide)               |
| Revenue system         | [REVENUE\_SYSTEM\_SPEC.md](https://docs.shyield.finance/protocol/revenue_system_spec)     |
| Staking boost          | [STAKING\_BOOST\_SPEC.md](https://docs.shyield.finance/protocol/staking_boost_spec)       |
| Vault specification    | [SHXRP\_VAULT\_SPECIFICATION.md](https://docs.shyield.finance/shxrp_vault_specification)  |

***

## Documentation Structure

### Protocol (`/protocol`)

Core smart contract and tokenomics documentation.

* [SHIELD\_TOKENOMICS.md](https://docs.shyield.finance/protocol/shield_tokenomics) - Token economics, revenue split (50/40/10)
* [SHIELD\_DEPLOYMENT.md](https://docs.shyield.finance/protocol/shield_deployment) - Contract deployment steps
* [STAKING\_BOOST\_SPEC.md](https://docs.shyield.finance/protocol/staking_boost_spec) - APY boost mechanics
* [REVENUE\_SYSTEM\_SPEC.md](https://docs.shyield.finance/protocol/revenue_system_spec) - BuybackBurn & RevenueRouter
* [SHIELD\_SECURITY\_CHECKLIST.md](https://docs.shyield.finance/protocol/shield_security_checklist) - Pre-audit checklist

### Integration (`/integration`)

External service integration guides.

* [FASSETS\_GUIDE.md](https://docs.shyield.finance/integration/fassets_guide) - XRP → FXRP bridging (canonical)
* [FIRELIGHT\_INTEGRATION.md](https://docs.shyield.finance/integration/firelight_integration) - Yield strategies
* [LP\_LOCKING\_GUIDE.md](https://docs.shyield.finance/integration/lp_locking_guide) - Liquidity management

### Platform (`/platform`)

Application architecture and wallet integration.

* [AIRDROP\_CLAIM\_GUIDE.md](https://docs.shyield.finance/platform/airdrop_claim_guide) - Airdrop eligibility & claiming
* [SMART\_ACCOUNTS\_SPEC.md](https://docs.shyield.finance/platform/smart_accounts_spec) - ERC-4337 specification
* [wallet-integration.md](https://docs.shyield.finance/platform/wallet-integration) - Wallet connection
* [xaman-integration.md](https://docs.shyield.finance/platform/xaman-integration) - XRPL wallet
* [swap.md](https://docs.shyield.finance/platform/swap) - Multi-asset swap feature

### API (`/api`)

* [README.md](https://docs.shyield.finance/api) - API endpoint reference

### Legal (`/legal`)

* [Privacy Policy](https://docs.shyield.finance/legal/privacy-policy) | [Terms of Service](https://docs.shyield.finance/legal/terms-of-service) | [Cookie Policy](https://docs.shyield.finance/legal/cookie-policy)

***

## Key Resources

* **Live App:** [shyield.finance](https://shyield.finance)
* **Technical Overview:** [replit.md](https://github.com/shield-xrpfinance/shieldfinance/blob/main/replit.md)
* **Design System:** [design\_guidelines.md](https://github.com/shield-xrpfinance/shieldfinance/blob/main/design_guidelines.md)
* **Full Index:** [DOCUMENTATION\_INDEX.md](https://docs.shyield.finance/documentation_index)

***

*Last Updated: December 2025*