> For the complete documentation index, see [llms.txt](https://docs.shyield.finance/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shyield.finance/readme.md).

# 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](/platform/airdrop_claim_guide.md)                              |
| SHIELD tokenomics      | [SHIELD\_TOKENOMICS.md](/protocol/shield_tokenomics.md)                                   |
| Deploy contracts       | [SHIELD\_DEPLOYMENT.md](/protocol/shield_deployment.md)                                   |
| FAssets bridge         | [FASSETS\_GUIDE.md](/integration/fassets_guide.md)                                        |
| Revenue system         | [REVENUE\_SYSTEM\_SPEC.md](/protocol/revenue_system_spec.md)                              |
| Staking boost          | [STAKING\_BOOST\_SPEC.md](/protocol/staking_boost_spec.md)                                |
| Vault specification    | [SHXRP\_VAULT\_SPECIFICATION.md](/shxrp_vault_specification.md)                           |

***

## Documentation Structure

### Protocol (`/protocol`)

Core smart contract and tokenomics documentation.

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

### Integration (`/integration`)

External service integration guides.

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

### Platform (`/platform`)

Application architecture and wallet integration.

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

### API (`/api`)

* [README.md](/api.md) - API endpoint reference

### Legal (`/legal`)

* [Privacy Policy](/legal/privacy-policy.md) | [Terms of Service](/legal/terms-of-service.md) | [Cookie Policy](/legal/cookie-policy.md)

***

## 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](/documentation_index.md)

***

*Last Updated: December 2025*