Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: hooks callsites #439

Merged
merged 9 commits into from
Dec 8, 2023
Merged

refactor: hooks callsites #439

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cd090af
feat: hooks refactor
marktoda Dec 7, 2023
00ff3a7
fix: tests
marktoda Dec 8, 2023
b1dc83d
Merge remote-tracking branch 'origin/main' into hooks-refactor
marktoda Dec 8, 2023
5f9fe5a
feat: noop -> shouldExecute
marktoda Dec 8, 2023
98636d7
fix: remove shouldCall functions for helper
marktoda Dec 8, 2023
eb200c6
Merge remote-tracking branch 'origin/main' into hooks-refactor
marktoda Dec 8, 2023
d6d0ff8
fix: using for in test
marktoda Dec 8, 2023
5033ef0
Merge remote-tracking branch 'origin/main' into hooks-refactor
marktoda Dec 8, 2023
e7de023
fix: alice comment
marktoda Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .forge-snapshots/before swap hook, already cached dynamic fee.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
193083
194645
2 changes: 1 addition & 1 deletion .forge-snapshots/cached dynamic fee, no hooks.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
148446
146989
2 changes: 1 addition & 1 deletion .forge-snapshots/donate gas with 1 token.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
139060
137608
2 changes: 1 addition & 1 deletion .forge-snapshots/donate gas with 2 tokens.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
186482
185030
2 changes: 1 addition & 1 deletion .forge-snapshots/initialize.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
78563
77056
2 changes: 1 addition & 1 deletion .forge-snapshots/mint with empty hook.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
319005
323483
2 changes: 1 addition & 1 deletion .forge-snapshots/mint with native token.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
201786
200317
2 changes: 1 addition & 1 deletion .forge-snapshots/mint.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
201706
200237
2 changes: 1 addition & 1 deletion .forge-snapshots/mintWithEmptyHookEOAInitiated.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
250901
255379
2 changes: 1 addition & 1 deletion .forge-snapshots/modify position with noop.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
56472
57897
2 changes: 1 addition & 1 deletion .forge-snapshots/poolManager bytecode size.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
26329
25884
2 changes: 1 addition & 1 deletion .forge-snapshots/simple swap with native.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
197331
195874
2 changes: 1 addition & 1 deletion .forge-snapshots/simple swap.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
205899
204442
2 changes: 1 addition & 1 deletion .forge-snapshots/simpleSwapEOAInitiated.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
177187
175730
2 changes: 1 addition & 1 deletion .forge-snapshots/simpleSwapNativeEOAInitiated.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
173849
172392
2 changes: 1 addition & 1 deletion .forge-snapshots/swap against liquidity with native token.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
127924
126467
2 changes: 1 addition & 1 deletion .forge-snapshots/swap against liquidity.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
115415
113958
2 changes: 1 addition & 1 deletion .forge-snapshots/swap burn claim for input.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
134509
133052
2 changes: 1 addition & 1 deletion .forge-snapshots/swap mint output as claim.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
218114
216657
2 changes: 1 addition & 1 deletion .forge-snapshots/swap with dynamic fee.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
192325
193747
2 changes: 1 addition & 1 deletion .forge-snapshots/swap with hooks.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
115393
113936
2 changes: 1 addition & 1 deletion .forge-snapshots/swap with noop.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
49689
51126
2 changes: 1 addition & 1 deletion .forge-snapshots/update dynamic fee in before swap.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
198919
200481
2 changes: 1 addition & 1 deletion lib/forge-gas-snapshot
Open in desktop
Submodule forge-gas-snapshot updated 3 files
+21 −0 LICENSE
+7 −1 README.md
+5 −2 src/utils/UintString.sol
2 changes: 1 addition & 1 deletion lib/forge-std
Open in desktop
Submodule forge-std updated 11 files
+1 −1 package.json
+11 −3 src/StdChains.sol
+2 −2 src/StdCheats.sol
+61 −33 src/StdUtils.sol
+84 −0 src/Vm.sol
+216 −0 src/mocks/MockERC20.sol
+221 −0 src/mocks/MockERC721.sol
+2 −6 test/StdChains.t.sol
+2 −2 test/Vm.t.sol
+441 −0 test/mocks/MockERC20.t.sol
+721 −0 test/mocks/MockERC721.t.sol
93 changes: 11 additions & 82 deletions src/PoolManager.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,32 +119,15 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, Claims {
if (key.currency0 >= key.currency1) revert CurrenciesOutOfOrderOrEqual();
if (!key.hooks.isValidHookAddress(key.fee)) revert Hooks.HookAddressNotValid(address(key.hooks));

(bool set) = Lockers.setCurrentHook(key.hooks);

if (key.hooks.shouldCallBeforeInitialize()) {
if (key.hooks.beforeInitialize(msg.sender, key, sqrtPriceX96, hookData) != IHooks.beforeInitialize.selector)
{
revert Hooks.InvalidHookResponse();
}
}
key.hooks.beforeInitialize(key, sqrtPriceX96, hookData);

PoolId id = key.toId();
(, uint24 protocolFees) = _fetchProtocolFees(key);
uint24 swapFee = key.fee.isDynamicFee() ? _fetchDynamicSwapFee(key) : key.fee.getStaticFee();

tick = pools[id].initialize(sqrtPriceX96, protocolFees, _fetchHookFees(key), swapFee);

if (key.hooks.shouldCallAfterInitialize()) {
if (
key.hooks.afterInitialize(msg.sender, key, sqrtPriceX96, tick, hookData)
!= IHooks.afterInitialize.selector
) {
revert Hooks.InvalidHookResponse();
}
}

// We only want to clear the current hook if it was set in setCurrentHook in this execution frame.
if (set) Lockers.clearCurrentHook();
key.hooks.afterInitialize(key, sqrtPriceX96, tick, hookData);

// On intitalize we emit the key's fee, which tells us all fee settings a pool can have: either a static swap fee or dynamic swap fee and if the hook has enabled swap or withdraw fees.
emit Initialize(id, key.currency0, key.currency1, key.fee, key.tickSpacing, key.hooks);
Expand Down Expand Up @@ -199,21 +182,11 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, Claims {
IPoolManager.ModifyPositionParams memory params,
bytes calldata hookData
) external override noDelegateCall onlyByLocker returns (BalanceDelta delta) {
(bool set) = Lockers.setCurrentHook(key.hooks);

PoolId id = key.toId();
_checkPoolInitialized(id);

if (key.hooks.shouldCallBeforeModifyPosition()) {
bytes4 selector = key.hooks.beforeModifyPosition(msg.sender, key, params, hookData);
// Sentinel return value used to signify that a NoOp occurred.
if (key.hooks.isValidNoOpCall(selector)) {
// We only want to clear the current hook if it was set in setCurrentHook in this execution frame.
if (set) Lockers.clearCurrentHook();
return BalanceDeltaLibrary.MAXIMUM_DELTA;
} else if (selector != IHooks.beforeModifyPosition.selector) {
revert Hooks.InvalidHookResponse();
}
if (key.hooks.beforeModifyPosition(key, params, hookData)) {
return BalanceDeltaLibrary.MAXIMUM_DELTA;
}

Pool.FeeAmounts memory feeAmounts;
Expand Down Expand Up @@ -244,17 +217,7 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, Claims {
}
}

if (key.hooks.shouldCallAfterModifyPosition()) {
if (
key.hooks.afterModifyPosition(msg.sender, key, params, delta, hookData)
!= IHooks.afterModifyPosition.selector
) {
revert Hooks.InvalidHookResponse();
}
}

// We only want to clear the current hook if it was set in setCurrentHook in this execution frame.
if (set) Lockers.clearCurrentHook();
key.hooks.afterModifyPosition(key, params, delta, hookData);

emit ModifyPosition(id, msg.sender, params.tickLower, params.tickUpper, params.liquidityDelta);
}
Expand All @@ -267,21 +230,11 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, Claims {
onlyByLocker
returns (BalanceDelta delta)
{
(bool set) = Lockers.setCurrentHook(key.hooks);

PoolId id = key.toId();
_checkPoolInitialized(id);

if (key.hooks.shouldCallBeforeSwap()) {
bytes4 selector = key.hooks.beforeSwap(msg.sender, key, params, hookData);
// Sentinel return value used to signify that a NoOp occurred.
if (key.hooks.isValidNoOpCall(selector)) {
// We only want to clear the current hook if it was set in setCurrentHook in this execution frame.
if (set) Lockers.clearCurrentHook();
return BalanceDeltaLibrary.MAXIMUM_DELTA;
} else if (selector != IHooks.beforeSwap.selector) {
revert Hooks.InvalidHookResponse();
}
if (key.hooks.beforeSwap(key, params, hookData)) {
return BalanceDeltaLibrary.MAXIMUM_DELTA;
}

uint256 feeForProtocol;
Expand Down Expand Up @@ -309,14 +262,7 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, Claims {
}
}

if (key.hooks.shouldCallAfterSwap()) {
if (key.hooks.afterSwap(msg.sender, key, params, delta, hookData) != IHooks.afterSwap.selector) {
revert Hooks.InvalidHookResponse();
}
}

// We only want to clear the current hook if it was set in setCurrentHook in this execution frame.
if (set) Lockers.clearCurrentHook();
key.hooks.afterSwap(key, params, delta, hookData);

emit Swap(
id, msg.sender, delta.amount0(), delta.amount1(), state.sqrtPriceX96, state.liquidity, state.tick, swapFee
Expand All @@ -331,35 +277,18 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, Claims {
onlyByLocker
returns (BalanceDelta delta)
{
(bool set) = Lockers.setCurrentHook(key.hooks);

PoolId id = key.toId();
_checkPoolInitialized(id);

if (key.hooks.shouldCallBeforeDonate()) {
bytes4 selector = key.hooks.beforeDonate(msg.sender, key, amount0, amount1, hookData);
// Sentinel return value used to signify that a NoOp occurred.
if (key.hooks.isValidNoOpCall(selector)) {
// We only want to clear the current hook if it was set in setCurrentHook in this execution frame.
if (set) Lockers.clearCurrentHook();
return BalanceDeltaLibrary.MAXIMUM_DELTA;
} else if (selector != IHooks.beforeDonate.selector) {
revert Hooks.InvalidHookResponse();
}
if (key.hooks.beforeDonate(key, amount0, amount1, hookData)) {
marktoda marked this conversation as resolved.
Show resolved Hide resolved
return BalanceDeltaLibrary.MAXIMUM_DELTA;
}

delta = pools[id].donate(amount0, amount1);

_accountPoolBalanceDelta(key, delta);

if (key.hooks.shouldCallAfterDonate()) {
if (key.hooks.afterDonate(msg.sender, key, amount0, amount1, hookData) != IHooks.afterDonate.selector) {
revert Hooks.InvalidHookResponse();
}
}

// We only want to clear the current hook if it was set in setCurrentHook in this execution frame.
if (set) Lockers.clearCurrentHook();
key.hooks.afterDonate(key, amount0, amount1, hookData);
}

/// @inheritdoc IPoolManager
Expand Down
Loading