Skip to main content
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.

​
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, then 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.