Skip to content

feat(amm): Introduce getPoolUsingMarketId public view accessor with Natspec documentation #119

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 3 commits into from
Oct 4, 2025
Merged

feat(amm): Introduce getPoolUsingMarketId public view accessor with Natspec documentation #119

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
568f773
feat: Add View Function Natspec Section Header
Neros0 Oct 4, 2025
165bfa9
feat: Add getPoolUsingMarketId External View Function
Neros0 Oct 4, 2025
bf37498
feat: Add getPoolUsingMarketId External View Function Natspec Comments
Neros0 Oct 4, 2025
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
18 changes: 18 additions & 0 deletions src/onchain/TestAMMContract.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,4 +434,22 @@ contract Test_AMMContract is Ownable {

emit TokensSwapped(_marketId, inputToken, outputToken, _amountIn, amountOut);
}

//////////////////////////////////////////////////////////////
// VIEW FUNCTIONS //
//////////////////////////////////////////////////////////////

/**
* @notice Retrieves complete pool data for a given market ID
* @dev Returns the PoolData struct containing all pool information
*
* @param marketId Unique identifier for the prediction market
*
* @return pool Complete PoolData struct with all pool information
*
* @custom:lookup Primary method for getting pool information by market ID
*/
function getPoolUsingMarketId(bytes32 marketId) external view returns (PoolData memory) {
return marketIdToPool[marketId];
}
}
Loading