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 {

View File

@@ -1,9 +1,9 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import "interfaces/IPairFunctions.sol";
import "interfaces/ISwapAdapter.sol";
contract UniswapV2PairFunctions is IPairFunctions {
contract UniswapV2SwapAdapter is ISwapAdapter {
IUniswapV2Factory immutable factory;
constructor(address factory_) {

View File

@@ -0,0 +1,36 @@
# information about the author helps us reach out in case of issues.
author:
name: Propellerheads.xyz
email: alan@propellerheads.xyz
# Protocol Constants
constants:
protocol_gas: 30000
# minimum capabilities we can expect, individual pools may extend these
capabilities:
- SellSide
- BuySide
- PriceFunction
# The file containing the adapter contract
contract: UniswapV2SwapAdapter.sol
# Deployment instances used to generate chain specific bytecode.
instances:
- chain:
name: mainnet
id: 0
arguments:
- "0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f"
# Specify some automatic test cases in case getPools and
# getTokens are not implemented.
tests:
instances:
- pair_id: "0xB4e16d0168e52d35CaCD2c6185b44281Ec28C9Dc"
sell_token: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
buy_token: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
block: 17000000
chain:
id: 0
name: mainnet

View File

@@ -3,11 +3,11 @@ pragma solidity ^0.8.13;
import "forge-std/Test.sol";
import "openzeppelin-contracts/contracts/interfaces/IERC20.sol";
import "src/uniswap-v2/UniswapV2PairFunctions.sol";
import "interfaces/IPairFunctionsTypes.sol";
import "src/uniswap-v2/UniswapV2SwapAdapter.sol";
import "interfaces/ISwapAdapterTypes.sol";
contract UniswapV2PairFunctionTest is Test, IPairFunctionTypes {
UniswapV2PairFunctions pairFunctions;
contract UniswapV2PairFunctionTest is Test, ISwapAdapterTypes {
UniswapV2SwapAdapter pairFunctions;
IERC20 constant WETH = IERC20(0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2);
IERC20 constant USDC = IERC20(0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48);
address constant USDC_WETH_PAIR = 0xB4e16d0168e52d35CaCD2c6185b44281Ec28C9Dc;
@@ -16,7 +16,7 @@ contract UniswapV2PairFunctionTest is Test, IPairFunctionTypes {
uint256 forkBlock = 17000000;
vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock);
pairFunctions = new
UniswapV2PairFunctions(0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f);
UniswapV2SwapAdapter(0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f);
}
function testPriceFuzz(uint256 amount0, uint256 amount1) public {