diff --git a/.gitmodules b/.gitmodules index 888d42d..690924b 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,6 @@ [submodule "lib/forge-std"] path = lib/forge-std url = https://github.com/foundry-rs/forge-std +[submodule "lib/openzeppelin-contracts"] + path = lib/openzeppelin-contracts + url = https://github.com/OpenZeppelin/openzeppelin-contracts diff --git a/README.md b/README.md index 9265b45..2fe9f95 100644 --- a/README.md +++ b/README.md @@ -64,3 +64,4 @@ $ forge --help $ anvil --help $ cast --help ``` +# V2-Core-08 diff --git a/foundry.toml b/foundry.toml index 25b918f..1552fce 100644 --- a/foundry.toml +++ b/foundry.toml @@ -2,5 +2,5 @@ src = "src" out = "out" libs = ["lib"] - +solc = "0.8.20" # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts new file mode 160000 index 0000000..dbb6104 --- /dev/null +++ b/lib/openzeppelin-contracts @@ -0,0 +1 @@ +Subproject commit dbb6104ce834628e473d2173bbc9d47f81a9eec3 diff --git a/remappings.txt b/remappings.txt new file mode 100644 index 0000000..2c2800d --- /dev/null +++ b/remappings.txt @@ -0,0 +1,5 @@ +@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/ +ds-test/=lib/openzeppelin-contracts/lib/forge-std/lib/ds-test/src/ +erc4626-tests/=lib/openzeppelin-contracts/lib/erc4626-tests/ +forge-std/=lib/forge-std/src/ +openzeppelin-contracts/=lib/openzeppelin-contracts/ diff --git a/src/UniswapV2ERC20.sol b/src/UniswapV2ERC20.sol new file mode 100644 index 0000000..6a5e4b5 --- /dev/null +++ b/src/UniswapV2ERC20.sol @@ -0,0 +1,56 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Pausable.sol"; +import "@openzeppelin/contracts/access/Ownable.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20FlashMint.sol"; + +contract UniswapV2ERC20 is + ERC20, + ERC20Burnable, + ERC20Pausable, + Ownable, + ERC20Permit, + ERC20Votes + // ERC20FlashMint +{ + constructor( + address initialOwner + ) + ERC20("Uniswap V2", "UNI-V2") + Ownable(initialOwner) + ERC20Permit("Uniswap V2") + {} + + function pause() public onlyOwner { + _pause(); + } + + function unpause() public onlyOwner { + _unpause(); + } + + function mint(address to, uint256 amount) public onlyOwner { + _mint(to, amount); + } + + // The following functions are overrides required by Solidity. + + function _update( + address from, + address to, + uint256 value + ) internal override(ERC20, ERC20Pausable, ERC20Votes) { + super._update(from, to, value); + } + + function nonces( + address owner + ) public view override(ERC20Permit, Nonces) returns (uint256) { + return super.nonces(owner); + } +} diff --git a/src/UniswapV2Factory.sol b/src/UniswapV2Factory.sol new file mode 100644 index 0000000..ccc5053 --- /dev/null +++ b/src/UniswapV2Factory.sol @@ -0,0 +1,63 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +import "./interfaces/IUniswapV2Factory.sol"; +import "./UniswapV2Pair.sol"; + +contract UniswapV2Factory is IUniswapV2Factory { + address public feeTo; + address public feeToSetter; + + mapping(address => mapping(address => address)) public getPair; + address[] public allPairs; + + // event PairCreated( + // address indexed token0, + // address indexed token1, + // address pair, + // uint + // ); + + constructor(address _feeToSetter) { + feeToSetter = _feeToSetter; + } + + function allPairsLength() external view returns (uint) { + return allPairs.length; + } + + function createPair( + address tokenA, + address tokenB + ) external returns (address pair) { + require(tokenA != tokenB, "UniswapV2: IDENTICAL_ADDRESSES"); + (address token0, address token1) = tokenA < tokenB + ? (tokenA, tokenB) + : (tokenB, tokenA); + require(token0 != address(0), "UniswapV2: ZERO_ADDRESS"); + require( + getPair[token0][token1] == address(0), + "UniswapV2: PAIR_EXISTS" + ); // single check is sufficient + bytes memory bytecode = type(UniswapV2Pair).creationCode; + bytes32 salt = keccak256(abi.encodePacked(token0, token1)); + assembly { + pair := create2(0, add(bytecode, 32), mload(bytecode), salt) + } + IUniswapV2Pair(pair).initialize(token0, token1); + getPair[token0][token1] = pair; + getPair[token1][token0] = pair; // populate mapping in the reverse direction + allPairs.push(pair); + emit PairCreated(token0, token1, pair, allPairs.length); + } + + function setFeeTo(address _feeTo) external { + require(msg.sender == feeToSetter, "UniswapV2: FORBIDDEN"); + feeTo = _feeTo; + } + + function setFeeToSetter(address _feeToSetter) external { + require(msg.sender == feeToSetter, "UniswapV2: FORBIDDEN"); + feeToSetter = _feeToSetter; + } +} diff --git a/src/UniswapV2Pair.sol b/src/UniswapV2Pair.sol new file mode 100644 index 0000000..ebf99cd --- /dev/null +++ b/src/UniswapV2Pair.sol @@ -0,0 +1,304 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +import "./interfaces/IUniswapV2Pair.sol"; +import "./UniswapV2ERC20.sol"; +import "./libraries/SafeMath.sol"; +import "./libraries/UQ112x112.sol"; +import "./libraries/Math.sol"; +import "./interfaces/IUniswapV2Factory.sol"; +import "./interfaces/IUniswapV2Callee.sol"; + +contract UniswapV2Pair is IUniswapV2Pair, UniswapV2ERC20 { + using SafeMath for uint; + using UQ112x112 for uint224; + + uint public constant MINIMUM_LIQUIDITY = 10 ** 3; + bytes4 private constant SELECTOR = + bytes4(keccak256(bytes("transfer(address,uint256)"))); + + address public factory; + address public token0; + address public token1; + + uint112 private reserve0; // uses single storage slot, accessible via getReserves + uint112 private reserve1; // uses single storage slot, accessible via getReserves + uint32 private blockTimestampLast; // uses single storage slot, accessible via getReserves + + uint public price0CumulativeLast; + uint public price1CumulativeLast; + uint public kLast; // reserve0 * reserve1, as of immediately after the most recent liquidity event + + uint private unlocked = 1; + modifier lock() { + require(unlocked == 1, "UniswapV2: LOCKED"); + unlocked = 0; + _; + unlocked = 1; + } + + function getReserves() + public + view + returns ( + uint112 _reserve0, + uint112 _reserve1, + uint32 _blockTimestampLast + ) + { + _reserve0 = reserve0; + _reserve1 = reserve1; + _blockTimestampLast = blockTimestampLast; + } + + function _safeTransfer(address token, address to, uint value) private { + (bool success, bytes memory data) = token.call( + abi.encodeWithSelector(SELECTOR, to, value) + ); + require( + success && (data.length == 0 || abi.decode(data, (bool))), + "UniswapV2: TRANSFER_FAILED" + ); + } + + event Mint(address indexed sender, uint amount0, uint amount1); + event Burn( + address indexed sender, + uint amount0, + uint amount1, + address indexed to + ); + event Swap( + address indexed sender, + uint amount0In, + uint amount1In, + uint amount0Out, + uint amount1Out, + address indexed to + ); + event Sync(uint112 reserve0, uint112 reserve1); + + constructor() UniswapV2ERC20(msg.sender) { + factory = msg.sender; + } + + // called once by the factory at time of deployment + function initialize(address _token0, address _token1) external { + require(msg.sender == factory, "UniswapV2: FORBIDDEN"); // sufficient check + token0 = _token0; + token1 = _token1; + } + + // update reserves and, on the first call per block, price accumulators + function _update( + uint balance0, + uint balance1, + uint112 _reserve0, + uint112 _reserve1 + ) private { + require( + // balance0 <= uint112(-1) && balance1 <= uint112(-1), + // 使用 uint112 的最大值来替代 -1 + balance0 <= type(uint112).max && balance1 <= type(uint112).max, + "UniswapV2: OVERFLOW" + ); + uint32 blockTimestamp = uint32(block.timestamp % 2 ** 32); + uint32 timeElapsed = blockTimestamp - blockTimestampLast; // overflow is desired + if (timeElapsed > 0 && _reserve0 != 0 && _reserve1 != 0) { + // * never overflows, and + overflow is desired + price0CumulativeLast += + uint(UQ112x112.encode(_reserve1).uqdiv(_reserve0)) * + timeElapsed; + price1CumulativeLast += + uint(UQ112x112.encode(_reserve0).uqdiv(_reserve1)) * + timeElapsed; + } + reserve0 = uint112(balance0); + reserve1 = uint112(balance1); + blockTimestampLast = blockTimestamp; + emit Sync(reserve0, reserve1); + } + + // if fee is on, mint liquidity equivalent to 1/6th of the growth in sqrt(k) + function _mintFee( + uint112 _reserve0, + uint112 _reserve1 + ) private returns (bool feeOn) { + address feeTo = IUniswapV2Factory(factory).feeTo(); + feeOn = feeTo != address(0); + uint _kLast = kLast; // gas savings + if (feeOn) { + if (_kLast != 0) { + // uint rootK = Math.sqrt(uint(_reserve0).mul(_reserve1)); + // 计算平方根的功能通常需要自定义实现或使用库函数 + uint256 rootK = Math.sqrt(_reserve0 * _reserve1); + uint rootKLast = Math.sqrt(_kLast); + if (rootK > rootKLast) { + // uint numerator = totalSupply.mul(rootK.sub(rootKLast)); + // uint256 numerator = totalSupply * (rootK - rootKLast); + // 计算分子 + uint256 numerator = totalSupply() * (rootK - rootKLast); + + // 计算分母 + uint256 denominator = rootK * 5 + rootKLast; + + // uint denominator = rootK.mul(5).add(rootKLast); + // 计算流动性 + uint liquidity = numerator / denominator; + if (liquidity > 0) _mint(feeTo, liquidity); + } + } + } else if (_kLast != 0) { + kLast = 0; + } + } + + // this low-level function should be called from a contract which performs important safety checks + function mint(address to) external lock returns (uint liquidity) { + (uint112 _reserve0, uint112 _reserve1, ) = getReserves(); // gas savings + uint balance0 = IERC20(token0).balanceOf(address(this)); + uint balance1 = IERC20(token1).balanceOf(address(this)); + // uint amount0 = balance0.sub(_reserve0); + uint amount0 = balance0 - _reserve0; + // uint amount1 = balance1.sub(_reserve1); + uint amount1 = balance1 - _reserve1; + + bool feeOn = _mintFee(_reserve0, _reserve1); + uint _totalSupply = totalSupply(); // gas savings, must be defined here since totalSupply can update in _mintFee + if (_totalSupply == 0) { + // liquidity = Math.sqrt(amount0.mul(amount1)).sub(MINIMUM_LIQUIDITY); + uint256 sqrtValue = Math.sqrt(amount0 * amount1); + liquidity = sqrtValue - MINIMUM_LIQUIDITY; + _mint(address(0), MINIMUM_LIQUIDITY); // permanently lock the first MINIMUM_LIQUIDITY tokens + } else { + liquidity = Math.min( + amount0.mul(_totalSupply) / _reserve0, + amount1.mul(_totalSupply) / _reserve1 + ); + } + require(liquidity > 0, "UniswapV2: INSUFFICIENT_LIQUIDITY_MINTED"); + _mint(to, liquidity); + + _update(balance0, balance1, _reserve0, _reserve1); + if (feeOn) kLast = uint(reserve0).mul(reserve1); // reserve0 and reserve1 are up-to-date + emit Mint(msg.sender, amount0, amount1); + } + + // this low-level function should be called from a contract which performs important safety checks + function burn( + address to + ) external lock returns (uint amount0, uint amount1) { + (uint112 _reserve0, uint112 _reserve1, ) = getReserves(); // gas savings + address _token0 = token0; // gas savings + address _token1 = token1; // gas savings + uint balance0 = IERC20(_token0).balanceOf(address(this)); + uint balance1 = IERC20(_token1).balanceOf(address(this)); + // uint liquidity = balanceOf[address(this)]; + uint liquidity = balanceOf(address(this)); + + bool feeOn = _mintFee(_reserve0, _reserve1); + uint _totalSupply = totalSupply(); // gas savings, must be defined here since totalSupply can update in _mintFee + amount0 = liquidity.mul(balance0) / _totalSupply; // using balances ensures pro-rata distribution + amount1 = liquidity.mul(balance1) / _totalSupply; // using balances ensures pro-rata distribution + require( + amount0 > 0 && amount1 > 0, + "UniswapV2: INSUFFICIENT_LIQUIDITY_BURNED" + ); + _burn(address(this), liquidity); + _safeTransfer(_token0, to, amount0); + _safeTransfer(_token1, to, amount1); + balance0 = IERC20(_token0).balanceOf(address(this)); + balance1 = IERC20(_token1).balanceOf(address(this)); + + _update(balance0, balance1, _reserve0, _reserve1); + if (feeOn) kLast = uint(reserve0).mul(reserve1); // reserve0 and reserve1 are up-to-date + emit Burn(msg.sender, amount0, amount1, to); + } + + // this low-level function should be called from a contract which performs important safety checks + function swap( + uint amount0Out, + uint amount1Out, + address to, + bytes calldata data + ) external lock { + require( + amount0Out > 0 || amount1Out > 0, + "UniswapV2: INSUFFICIENT_OUTPUT_AMOUNT" + ); + (uint112 _reserve0, uint112 _reserve1, ) = getReserves(); // gas savings + require( + amount0Out < _reserve0 && amount1Out < _reserve1, + "UniswapV2: INSUFFICIENT_LIQUIDITY" + ); + + uint balance0; + uint balance1; + { + // scope for _token{0,1}, avoids stack too deep errors + address _token0 = token0; + address _token1 = token1; + require(to != _token0 && to != _token1, "UniswapV2: INVALID_TO"); + if (amount0Out > 0) _safeTransfer(_token0, to, amount0Out); // optimistically transfer tokens + if (amount1Out > 0) _safeTransfer(_token1, to, amount1Out); // optimistically transfer tokens + if (data.length > 0) + IUniswapV2Callee(to).uniswapV2Call( + msg.sender, + amount0Out, + amount1Out, + data + ); + balance0 = IERC20(_token0).balanceOf(address(this)); + balance1 = IERC20(_token1).balanceOf(address(this)); + } + uint amount0In = balance0 > _reserve0 - amount0Out + ? balance0 - (_reserve0 - amount0Out) + : 0; + uint amount1In = balance1 > _reserve1 - amount1Out + ? balance1 - (_reserve1 - amount1Out) + : 0; + require( + amount0In > 0 || amount1In > 0, + "UniswapV2: INSUFFICIENT_INPUT_AMOUNT" + ); + { + // scope for reserve{0,1}Adjusted, avoids stack too deep errors + uint balance0Adjusted = balance0.mul(1000).sub(amount0In.mul(3)); + uint balance1Adjusted = balance1.mul(1000).sub(amount1In.mul(3)); + require( + balance0Adjusted.mul(balance1Adjusted) >= + uint(_reserve0).mul(_reserve1).mul(1000 ** 2), + "UniswapV2: K" + ); + } + + _update(balance0, balance1, _reserve0, _reserve1); + emit Swap(msg.sender, amount0In, amount1In, amount0Out, amount1Out, to); + } + + // force balances to match reserves + function skim(address to) external lock { + address _token0 = token0; // gas savings + address _token1 = token1; // gas savings + _safeTransfer( + _token0, + to, + IERC20(_token0).balanceOf(address(this)).sub(reserve0) + ); + _safeTransfer( + _token1, + to, + IERC20(_token1).balanceOf(address(this)).sub(reserve1) + ); + } + + // force reserves to match balances + function sync() external lock { + _update( + IERC20(token0).balanceOf(address(this)), + IERC20(token1).balanceOf(address(this)), + reserve0, + reserve1 + ); + } +} diff --git a/src/interfaces/IUniswapV2Callee.sol b/src/interfaces/IUniswapV2Callee.sol new file mode 100644 index 0000000..f55989d --- /dev/null +++ b/src/interfaces/IUniswapV2Callee.sol @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +interface IUniswapV2Callee { + function uniswapV2Call( + address sender, + uint amount0, + uint amount1, + bytes calldata data + ) external; +} diff --git a/src/interfaces/IUniswapV2Factory.sol b/src/interfaces/IUniswapV2Factory.sol new file mode 100644 index 0000000..be86c1f --- /dev/null +++ b/src/interfaces/IUniswapV2Factory.sol @@ -0,0 +1,33 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +interface IUniswapV2Factory { + event PairCreated( + address indexed token0, + address indexed token1, + address pair, + uint + ); + + function feeTo() external view returns (address); + + function feeToSetter() external view returns (address); + + function getPair( + address tokenA, + address tokenB + ) external view returns (address pair); + + function allPairs(uint) external view returns (address pair); + + function allPairsLength() external view returns (uint); + + function createPair( + address tokenA, + address tokenB + ) external returns (address pair); + + function setFeeTo(address) external; + + function setFeeToSetter(address) external; +} diff --git a/src/interfaces/IUniswapV2Pair.sol b/src/interfaces/IUniswapV2Pair.sol new file mode 100644 index 0000000..5979aa5 --- /dev/null +++ b/src/interfaces/IUniswapV2Pair.sol @@ -0,0 +1,101 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +interface IUniswapV2Pair { + // event Approval(address indexed owner, address indexed spender, uint value); + // event Transfer(address indexed from, address indexed to, uint value); + + // function name() external pure returns (string memory); + + // function symbol() external pure returns (string memory); + + // function decimals() external pure returns (uint8); + + // function totalSupply() external view returns (uint); + + // function balanceOf(address owner) external view returns (uint); + + // function allowance( + // address owner, + // address spender + // ) external view returns (uint); + + // function approve(address spender, uint value) external returns (bool); + + // function transfer(address to, uint value) external returns (bool); + + // function transferFrom( + // address from, + // address to, + // uint value + // ) external returns (bool); + + // function DOMAIN_SEPARATOR() external view returns (bytes32); + + // function PERMIT_TYPEHASH() external pure returns (bytes32); + + // function nonces(address owner) external view returns (uint); + + // function permit( + // address owner, + // address spender, + // uint value, + // uint deadline, + // uint8 v, + // bytes32 r, + // bytes32 s + // ) external; + + // event Mint(address indexed sender, uint amount0, uint amount1); + // event Burn( + // address indexed sender, + // uint amount0, + // uint amount1, + // address indexed to + // ); + // event Swap( + // address indexed sender, + // uint amount0In, + // uint amount1In, + // uint amount0Out, + // uint amount1Out, + // address indexed to + // ); + // event Sync(uint112 reserve0, uint112 reserve1); + + function MINIMUM_LIQUIDITY() external pure returns (uint); + + function factory() external view returns (address); + + function token0() external view returns (address); + + function token1() external view returns (address); + + function getReserves() + external + view + returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast); + + function price0CumulativeLast() external view returns (uint); + + function price1CumulativeLast() external view returns (uint); + + function kLast() external view returns (uint); + + function mint(address to) external returns (uint liquidity); + + function burn(address to) external returns (uint amount0, uint amount1); + + function swap( + uint amount0Out, + uint amount1Out, + address to, + bytes calldata data + ) external; + + function skim(address to) external; + + function sync() external; + + function initialize(address, address) external; +} diff --git a/src/libraries/Math.sol b/src/libraries/Math.sol new file mode 100644 index 0000000..50d944a --- /dev/null +++ b/src/libraries/Math.sol @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +// a library for performing various math operations + +library Math { + function min(uint x, uint y) internal pure returns (uint z) { + z = x < y ? x : y; + } + + // babylonian method (https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method) + function sqrt(uint y) internal pure returns (uint z) { + if (y > 3) { + z = y; + uint x = y / 2 + 1; + while (x < z) { + z = x; + x = (y / x + x) / 2; + } + } else if (y != 0) { + z = 1; + } + } +} diff --git a/src/libraries/SafeMath.sol b/src/libraries/SafeMath.sol new file mode 100644 index 0000000..cbdfad8 --- /dev/null +++ b/src/libraries/SafeMath.sol @@ -0,0 +1,18 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +// a library for performing overflow-safe math, courtesy of DappHub (https://github.com/dapphub/ds-math) + +library SafeMath { + function add(uint x, uint y) internal pure returns (uint z) { + require((z = x + y) >= x, "ds-math-add-overflow"); + } + + function sub(uint x, uint y) internal pure returns (uint z) { + require((z = x - y) <= x, "ds-math-sub-underflow"); + } + + function mul(uint x, uint y) internal pure returns (uint z) { + require(y == 0 || (z = x * y) / y == x, "ds-math-mul-overflow"); + } +} diff --git a/src/libraries/UQ112x112.sol b/src/libraries/UQ112x112.sol new file mode 100644 index 0000000..7668446 --- /dev/null +++ b/src/libraries/UQ112x112.sol @@ -0,0 +1,21 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.20; + +// a library for handling binary fixed point numbers (https://en.wikipedia.org/wiki/Q_(number_format)) + +// range: [0, 2**112 - 1] +// resolution: 1 / 2**112 + +library UQ112x112 { + uint224 constant Q112 = 2 ** 112; + + // encode a uint112 as a UQ112x112 + function encode(uint112 y) internal pure returns (uint224 z) { + z = uint224(y) * Q112; // never overflows + } + + // divide a UQ112x112 by a uint112, returning a UQ112x112 + function uqdiv(uint224 x, uint112 y) internal pure returns (uint224 z) { + z = x / uint224(y); + } +}