Renaming, cleanup and add manifest example.

This commit is contained in:
kayibal
2023-11-06 12:56:55 +00:00
parent 18f0cf1b45
commit 3425b8b123
5 changed files with 47 additions and 11 deletions

View File

@@ -2,9 +2,9 @@
pragma solidity ^0.8.13;
import "openzeppelin-contracts/contracts/interfaces/IERC20.sol";
import "interfaces/IPairFunctionsTypes.sol";
import "interfaces/ISwapAdapterTypes.sol";
/// @title IPairFunctions
/// @title ISwapAdapterTypes
/// @dev Implement this interface to support propeller routing through your pairs.
/// @dev Before implementing the interface we need to introduce three function for a
/// @dev given pair: The swap(x), gas(x) and price(x) functions:
@@ -18,7 +18,7 @@ import "interfaces/IPairFunctionsTypes.sol";
/// @dev During calls to swap and getLimits, the caller can be assumed to
/// @dev have the required sell or buy token balance as well as unlimited approvals
/// @dev to this contract.
interface IPairFunctions is IPairFunctionTypes {
interface ISwapAdapter is ISwapAdapterTypes {
/// @notice Calculates pair prices for specified amounts (optional).
/// @dev The returned prices should include all dex fees, in case the fee
/// @dev is dynamic, the returned price is expected to include the minimum fee.

View File

@@ -3,7 +3,7 @@ pragma solidity ^0.8.13;
import "openzeppelin-contracts/contracts/interfaces/IERC20.sol";
interface IPairFunctionTypes {
interface ISwapAdapterTypes {
/// @dev The SwapSide enum represents possible sides of a trade: Sell or Buy.
/// @dev E.g. if SwapSide is Sell, the sell amount is interpreted to be fixed.
enum SwapSide {