Merge pull request #92 from propeller-heads/ah/docs/clarification-limits

docs: Document the meaning of limits array
This commit is contained in:
Alan Höng
2024-10-23 10:45:36 +01:00
committed by GitHub

View File

@@ -74,7 +74,9 @@ interface ISwapAdapter is ISwapAdapterTypes {
/// @param poolId The ID of the trading pool. /// @param poolId The ID of the trading pool.
/// @param sellToken The token being sold. /// @param sellToken The token being sold.
/// @param buyToken The token being bought. /// @param buyToken The token being bought.
/// @return limits An array of limits. /// @return limits An array of size two indicating the limit amount for the sell
/// token (maximum the pool is willing to buy in sell token) as well as the limit
/// amount of the buy token (maximum the pool is willing to sell in buy token).
function getLimits(bytes32 poolId, address sellToken, address buyToken) function getLimits(bytes32 poolId, address sellToken, address buyToken)
external external
returns (uint256[] memory limits); returns (uint256[] memory limits);