Skip to content

feat: Add getAmountOut External View Function for Swap Previews #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Neros0 merged 1 commit into from
Oct 7, 2025
Merged

feat: Add getAmountOut External View Function for Swap Previews #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/onchain/TestAMMContract.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,25 @@ contract Test_AMMContract is Ownable {
return (pool.reserveA, pool.reserveB);
}

/**
* @notice Calculates the expected output amount for a given input in a swap
* @dev Uses the constant product formula to calculate swap output without executing the trade.
* Useful for UI previews and slippage calculations.
*
* @param marketId Unique identifier for the prediction market
* @param amountIn Amount of input tokens for the hypothetical swap
* @param zeroForOne Direction of swap: true for tokenA→tokenB, false for tokenB→tokenA
*
* @return amountOut Expected amount of output tokens that would be received
*
* Requirements:
* - Pool must exist and be initialized
* - Pool must have sufficient liquidity
* - amountIn must be greater than zero
*
* @custom:preview This is a view function that doesn't modify state
* @custom:formula Uses same constant product calculation as the actual swap function
*/
function getAmountOut(bytes32 marketId, uint256 amountIn, bool zeroForOne)
external
view
Expand Down
Loading