Skip to content

Commit

Permalink
docs: update docs and remove unused errors
Browse files Browse the repository at this point in the history
  • Loading branch information
ChefMist committed Jun 20, 2024
1 parent 54e31f2 commit d622a56
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/pool-cl/VeCakeMembershipHook.sol
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ contract VeCakeMembershipHook is CLBaseHook {
return (this.afterSwap.selector, 0);
}

/// @dev this is POC code, do not use for production!!
/// @dev this is POC code, do not use for production, this is only for POC.
/// Assumption: currency1 is subsidised currency and if veCake user swap token0 for token1, give 5% more token1.
if (param.zeroForOne && veCake.balanceOf(tx.origin) >= 1 ether) {

Expand Down
6 changes: 3 additions & 3 deletions src/pool-cl/VeCakeSwapDiscountHook.sol
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ interface IVeCake {
function balanceOf(address account) external view returns (uint256 balance);
}

/// @notice VeCakeSwapDiscountHook allows veCake to get 50% off swap fee
/// @notice VeCakeSwapDiscountHook provides 50% swap fee discount for veCake holder
/// Idea: 1. PancakeSwap has veCake (vote-escrowed Cake), user obtain veCake by locking cake
/// 2. If the swapper holds veCake, provide 50% swap fee discount
contract VeCakeSwapDiscountHook is CLBaseHook {
using PoolIdLibrary for PoolKey;
using LPFeeLibrary for uint24;

error PoolNotOpenForPublicTradeYet();

IVeCake public veCake;
mapping(PoolId => uint24) public poolIdToLpFee;

Expand Down
2 changes: 2 additions & 0 deletions src/pool-cl/VeCakeWhitelistHook.sol
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ interface IVeCake {
}

/// @notice VeCakeWhitelistHook allows only veCake holder to trade with the pool within the first hour
/// Idea: 1. A PCS partner protocol launch a new protocol by adding liquidity XX-ETH
/// 2. Only veCake holder can buy the token in the first hour and public access will be granted after.
contract VeCakeWhitelistHook is CLBaseHook {
using PoolIdLibrary for PoolKey;

Expand Down

0 comments on commit d622a56

Please sign in to comment.