> ## Documentation Index
> Fetch the complete documentation index at: https://shield.fi/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Reading paths

> Start with the pages that match your Shield Swap integration or review role.

These docs are written first for engineers building against Shield Swap. Use the shortest path that matches the state and risk your system must own.

| You are building or reviewing              | Start here                                                                            | Do not miss                                                           |
| ------------------------------------------ | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| Backend, bot, dashboard, or explorer       | [REST API quickstart](../rest/quickstart)                                             | [Authentication](../rest/authentication) and exact integer strings    |
| Wallet or trading application              | [Choose an integration path](../developers/integration-path)                          | Swap plus claim, record replacement, and unknown transaction state    |
| Liquidity interface or market-maker system | [Liquidity provider workflow](../liquidity/lp-workflow)                               | Deployment identity, position records, fee settlement, and tick hints |
| Security reviewer                          | [Security model](../security/security-model)                                          | Dynamic token trust, admin authority, and compiler warning sites      |
| Compliance or risk reviewer                | [Regulator and compliance review](../confidentiality/regulator-and-compliance-review) | Protocol controls versus off-chain policy responsibilities            |

## Application integrators

Begin with indexed REST data. Move to transaction schemas or direct program calls only if the application must submit Shield transactions.

Keep these facts in view:

* A swap and its claim are separate transactions.
* Wallets must reserve input records, preserve change, and store returned records.
* Q128.128 values use `u256::U256` with `hi` and `lo` limbs.
* Pool parsing must not expect legacy `scale0` or `scale1` fields.
* Public position accounting and `PositionNFT` ownership are different state.
* Most API data endpoints require invited access and an API token.

## Traders and wallet teams

The transaction's token IDs, amount, route, output, refund, price movement, and timing remain public. The intended confidentiality property keeps the participant address out of ordinary public market mappings.

Read [Trader workflow](../trading/trader-workflow), then [Failures and recovery](../trading/failures-and-recovery).

## Liquidity teams

Bind every position to one deployment, pool key, token ID, and current `PositionNFT`. The same logical pool in a different deployment is different state.

Fee fractions are attributed when earned using active liquidity. Later liquidity cannot receive prior residual fee dust.

## Reviewers

The protocol exposes controls and encrypted investigator records. It does not supply key custody, case management, retention rules, screening, jurisdictional policy, or deployment evidence.

Treat a deployment as identified only when its network, program ID, edition, checksum, dependencies, admin state, approved tokens, active pools, and pause state have been independently verified.