Skip to main content
These docs serve two readers. If you trade in the Shield Swap app, Get started points you to the Trade pages, where the Web App view at the top of each page holds the app steps and the Developers view holds the SDK and CLI steps. If you are building against Shield Swap, use the shortest path that matches the state and risk your system must own.

​
Trading in the app

Start with Get started, then Setup and Fund. Quote, Swap, and Swap history and recovery each hold their app steps under the Web App view. Minting a position and the pages that follow it cover liquidity in the app.

​
Application integrators

Begin with indexed REST data. Use the Typescript SDK or direct program calls 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.
  • Public market data does not require credentials. Routes and wallet-specific data require an authenticated session or 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.