Cloak API
Operational behavior
The behaviors your integration needs to account for in production.
The user signs the deposit
Cloak returns a transaction that moves tokens from the user's wallet into the pool. Your app must ask the user to sign and submit it.
| What to plan for | What to do |
|---|---|
| Versioned transactions | Confirm that your wallet layer supports Solana v0 transactions. See Signing. |
| SOL for the deposit | Keep about 0.002 SOL available beyond the transfer amount for the deposit transaction. |
| Transaction expiry | Request a new transaction with refresh if the user does not sign in time. |
Refresh is safe
A refreshed transaction represents the same deposit. If two versions are submitted, only one can succeed, so refreshing cannot create a duplicate deposit.
Poll for status
Poll order status every few seconds until final is true. The optional deposit callback can reduce detection time, but it is not required.
Use the quoted delivery estimate
Delivery time varies with network conditions and service load. Display the quote's duration rather than hard-coding an estimate.
Planning a high-volume launch?
Describe privacy accurately
Cloak breaks the direct on-chain link between sender and recipient, but it does not make blockchain activity invisible. See the privacy model for approved wording and limitations.