Skip to content

Commit 7170eec

Browse files
Update docs
1 parent 06cd4fe commit 7170eec

File tree

4 files changed

+40
-42
lines changed

4 files changed

+40
-42
lines changed

docs/modules/api/pages/base.adoc

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
:xref-BaseCustomAccounting-_mint-struct-BaseCustomAccounting-AddLiquidityParams-BalanceDelta-BalanceDelta-uint256-: xref:base.adoc#BaseCustomAccounting-_mint-struct-BaseCustomAccounting-AddLiquidityParams-BalanceDelta-BalanceDelta-uint256-
1919
:xref-BaseCustomAccounting-_burn-struct-BaseCustomAccounting-RemoveLiquidityParams-BalanceDelta-BalanceDelta-uint256-: xref:base.adoc#BaseCustomAccounting-_burn-struct-BaseCustomAccounting-RemoveLiquidityParams-BalanceDelta-BalanceDelta-uint256-
2020
:xref-BaseCustomAccounting-getHookPermissions--: xref:base.adoc#BaseCustomAccounting-getHookPermissions--
21-
:xref-BaseHook-poolManager--: xref:base.adoc#BaseHook-poolManager--
2221
:xref-BaseHook-_validateHookAddress-contract-BaseHook-: xref:base.adoc#BaseHook-_validateHookAddress-contract-BaseHook-
2322
:xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-: xref:base.adoc#BaseHook-beforeInitialize-address-struct-PoolKey-uint160-
2423
:xref-BaseHook-afterInitialize-address-struct-PoolKey-uint160-int24-: xref:base.adoc#BaseHook-afterInitialize-address-struct-PoolKey-uint160-int24-
@@ -37,6 +36,7 @@
3736
:xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-
3837
:xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
3938
:xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
39+
:xref-BaseHook-poolManager-contract-IPoolManager: xref:base.adoc#BaseHook-poolManager-contract-IPoolManager
4040
:xref-IHookEvents-HookSwap-bytes32-address-int128-int128-uint128-uint128-: xref:interfaces.adoc#IHookEvents-HookSwap-bytes32-address-int128-int128-uint128-uint128-
4141
:xref-IHookEvents-HookFee-bytes32-address-uint128-uint128-: xref:interfaces.adoc#IHookEvents-HookFee-bytes32-address-uint128-uint128-
4242
:xref-IHookEvents-HookModifyLiquidity-bytes32-address-int128-int128-: xref:interfaces.adoc#IHookEvents-HookModifyLiquidity-bytes32-address-int128-int128-
@@ -69,7 +69,6 @@
6969
:xref-BaseCustomAccounting-_beforeRemoveLiquidity-address-struct-PoolKey-struct-ModifyLiquidityParams-bytes-: xref:base.adoc#BaseCustomAccounting-_beforeRemoveLiquidity-address-struct-PoolKey-struct-ModifyLiquidityParams-bytes-
7070
:xref-BaseCustomAccounting-_mint-struct-BaseCustomAccounting-AddLiquidityParams-BalanceDelta-BalanceDelta-uint256-: xref:base.adoc#BaseCustomAccounting-_mint-struct-BaseCustomAccounting-AddLiquidityParams-BalanceDelta-BalanceDelta-uint256-
7171
:xref-BaseCustomAccounting-_burn-struct-BaseCustomAccounting-RemoveLiquidityParams-BalanceDelta-BalanceDelta-uint256-: xref:base.adoc#BaseCustomAccounting-_burn-struct-BaseCustomAccounting-RemoveLiquidityParams-BalanceDelta-BalanceDelta-uint256-
72-
:xref-BaseHook-poolManager--: xref:base.adoc#BaseHook-poolManager--
7372
:xref-BaseHook-_validateHookAddress-contract-BaseHook-: xref:base.adoc#BaseHook-_validateHookAddress-contract-BaseHook-
7473
:xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-: xref:base.adoc#BaseHook-beforeInitialize-address-struct-PoolKey-uint160-
7574
:xref-BaseHook-afterInitialize-address-struct-PoolKey-uint160-int24-: xref:base.adoc#BaseHook-afterInitialize-address-struct-PoolKey-uint160-int24-
@@ -87,6 +86,7 @@
8786
:xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-
8887
:xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
8988
:xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
89+
:xref-BaseHook-poolManager-contract-IPoolManager: xref:base.adoc#BaseHook-poolManager-contract-IPoolManager
9090
:xref-IHookEvents-HookSwap-bytes32-address-int128-int128-uint128-uint128-: xref:interfaces.adoc#IHookEvents-HookSwap-bytes32-address-int128-int128-uint128-uint128-
9191
:xref-IHookEvents-HookFee-bytes32-address-uint128-uint128-: xref:interfaces.adoc#IHookEvents-HookFee-bytes32-address-uint128-uint128-
9292
:xref-IHookEvents-HookModifyLiquidity-bytes32-address-int128-int128-: xref:interfaces.adoc#IHookEvents-HookModifyLiquidity-bytes32-address-int128-int128-
@@ -100,8 +100,7 @@
100100
:xref-BaseHook-HookNotImplemented--: xref:base.adoc#BaseHook-HookNotImplemented--
101101
:xref-BaseHook-NotPoolManager--: xref:base.adoc#BaseHook-NotPoolManager--
102102
:xref-BaseHook-onlyPoolManager--: xref:base.adoc#BaseHook-onlyPoolManager--
103-
:xref-BaseHook-constructor--: xref:base.adoc#BaseHook-constructor--
104-
:xref-BaseHook-poolManager--: xref:base.adoc#BaseHook-poolManager--
103+
:xref-BaseHook-constructor-contract-IPoolManager-: xref:base.adoc#BaseHook-constructor-contract-IPoolManager-
105104
:xref-BaseHook-getHookPermissions--: xref:base.adoc#BaseHook-getHookPermissions--
106105
:xref-BaseHook-_validateHookAddress-contract-BaseHook-: xref:base.adoc#BaseHook-_validateHookAddress-contract-BaseHook-
107106
:xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-: xref:base.adoc#BaseHook-beforeInitialize-address-struct-PoolKey-uint160-
@@ -124,12 +123,12 @@
124123
:xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-
125124
:xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
126125
:xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
126+
:xref-BaseHook-poolManager-contract-IPoolManager: xref:base.adoc#BaseHook-poolManager-contract-IPoolManager
127127
:xref-BaseHook-HookNotImplemented--: xref:base.adoc#BaseHook-HookNotImplemented--
128128
:xref-BaseHook-NotPoolManager--: xref:base.adoc#BaseHook-NotPoolManager--
129129
:xref-BaseAsyncSwap-_beforeSwap-address-struct-PoolKey-struct-SwapParams-bytes-: xref:base.adoc#BaseAsyncSwap-_beforeSwap-address-struct-PoolKey-struct-SwapParams-bytes-
130130
:xref-BaseAsyncSwap-_calculateSwapFee-struct-PoolKey-uint256-: xref:base.adoc#BaseAsyncSwap-_calculateSwapFee-struct-PoolKey-uint256-
131131
:xref-BaseAsyncSwap-getHookPermissions--: xref:base.adoc#BaseAsyncSwap-getHookPermissions--
132-
:xref-BaseHook-poolManager--: xref:base.adoc#BaseHook-poolManager--
133132
:xref-BaseHook-_validateHookAddress-contract-BaseHook-: xref:base.adoc#BaseHook-_validateHookAddress-contract-BaseHook-
134133
:xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-: xref:base.adoc#BaseHook-beforeInitialize-address-struct-PoolKey-uint160-
135134
:xref-BaseHook-_beforeInitialize-address-struct-PoolKey-uint160-: xref:base.adoc#BaseHook-_beforeInitialize-address-struct-PoolKey-uint160-
@@ -150,6 +149,7 @@
150149
:xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-
151150
:xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
152151
:xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-: xref:base.adoc#BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-
152+
:xref-BaseHook-poolManager-contract-IPoolManager: xref:base.adoc#BaseHook-poolManager-contract-IPoolManager
153153
:xref-IHookEvents-HookSwap-bytes32-address-int128-int128-uint128-uint128-: xref:interfaces.adoc#IHookEvents-HookSwap-bytes32-address-int128-int128-uint128-uint128-
154154
:xref-IHookEvents-HookFee-bytes32-address-uint128-uint128-: xref:interfaces.adoc#IHookEvents-HookFee-bytes32-address-uint128-uint128-
155155
:xref-IHookEvents-HookModifyLiquidity-bytes32-address-int128-int128-: xref:interfaces.adoc#IHookEvents-HookModifyLiquidity-bytes32-address-int128-int128-
@@ -255,7 +255,6 @@ _Available since v0.1.0_
255255

256256
[.contract-subindex-inherited]
257257
.BaseHook
258-
* {xref-BaseHook-poolManager--}[`++poolManager()++`]
259258
* {xref-BaseHook-_validateHookAddress-contract-BaseHook-}[`++_validateHookAddress(hook)++`]
260259
* {xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-}[`++beforeInitialize(sender, key, sqrtPriceX96)++`]
261260
* {xref-BaseHook-afterInitialize-address-struct-PoolKey-uint160-int24-}[`++afterInitialize(sender, key, sqrtPriceX96, tick)++`]
@@ -274,6 +273,7 @@ _Available since v0.1.0_
274273
* {xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_beforeDonate(, , , , )++`]
275274
* {xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++afterDonate(sender, key, amount0, amount1, hookData)++`]
276275
* {xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_afterDonate(, , , , )++`]
276+
* {xref-BaseHook-poolManager-contract-IPoolManager}[`++poolManager()++`]
277277

278278
[.contract-subindex-inherited]
279279
.IHooks
@@ -531,7 +531,6 @@ _Available since v0.1.0_
531531

532532
[.contract-subindex-inherited]
533533
.BaseHook
534-
* {xref-BaseHook-poolManager--}[`++poolManager()++`]
535534
* {xref-BaseHook-_validateHookAddress-contract-BaseHook-}[`++_validateHookAddress(hook)++`]
536535
* {xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-}[`++beforeInitialize(sender, key, sqrtPriceX96)++`]
537536
* {xref-BaseHook-afterInitialize-address-struct-PoolKey-uint160-int24-}[`++afterInitialize(sender, key, sqrtPriceX96, tick)++`]
@@ -549,6 +548,7 @@ _Available since v0.1.0_
549548
* {xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_beforeDonate(, , , , )++`]
550549
* {xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++afterDonate(sender, key, amount0, amount1, hookData)++`]
551550
* {xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_afterDonate(, , , , )++`]
551+
* {xref-BaseHook-poolManager-contract-IPoolManager}[`++poolManager()++`]
552552

553553
[.contract-subindex-inherited]
554554
.IHooks
@@ -678,11 +678,11 @@ Calculate the amount of tokens to use and liquidity shares to mint for an add li
678678
Set the hook permissions, specifically `beforeInitialize`, `beforeAddLiquidity`, `beforeRemoveLiquidity`,
679679
`beforeSwap`, and `beforeSwapReturnDelta`
680680

681+
:poolManager: pass:normal[xref:#BaseHook-poolManager-contract-IPoolManager[`++poolManager++`]]
681682
:HookNotImplemented: pass:normal[xref:#BaseHook-HookNotImplemented--[`++HookNotImplemented++`]]
682683
:NotPoolManager: pass:normal[xref:#BaseHook-NotPoolManager--[`++NotPoolManager++`]]
683-
:constructor: pass:normal[xref:#BaseHook-constructor--[`++constructor++`]]
684+
:constructor: pass:normal[xref:#BaseHook-constructor-contract-IPoolManager-[`++constructor++`]]
684685
:onlyPoolManager: pass:normal[xref:#BaseHook-onlyPoolManager--[`++onlyPoolManager++`]]
685-
:poolManager: pass:normal[xref:#BaseHook-poolManager--[`++poolManager++`]]
686686
:getHookPermissions: pass:normal[xref:#BaseHook-getHookPermissions--[`++getHookPermissions++`]]
687687
:_validateHookAddress: pass:normal[xref:#BaseHook-_validateHookAddress-contract-BaseHook-[`++_validateHookAddress++`]]
688688
:beforeInitialize: pass:normal[xref:#BaseHook-beforeInitialize-address-struct-PoolKey-uint160-[`++beforeInitialize++`]]
@@ -738,8 +738,7 @@ _Available since v0.1.0_
738738
[.contract-index]
739739
.Functions
740740
--
741-
* {xref-BaseHook-constructor--}[`++constructor()++`]
742-
* {xref-BaseHook-poolManager--}[`++poolManager()++`]
741+
* {xref-BaseHook-constructor-contract-IPoolManager-}[`++constructor(_poolManager)++`]
743742
* {xref-BaseHook-getHookPermissions--}[`++getHookPermissions()++`]
744743
* {xref-BaseHook-_validateHookAddress-contract-BaseHook-}[`++_validateHookAddress(hook)++`]
745744
* {xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-}[`++beforeInitialize(sender, key, sqrtPriceX96)++`]
@@ -762,6 +761,7 @@ _Available since v0.1.0_
762761
* {xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_beforeDonate(, , , , )++`]
763762
* {xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++afterDonate(sender, key, amount0, amount1, hookData)++`]
764763
* {xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_afterDonate(, , , , )++`]
764+
* {xref-BaseHook-poolManager-contract-IPoolManager}[`++poolManager()++`]
765765

766766
[.contract-subindex-inherited]
767767
.IHooks
@@ -784,17 +784,11 @@ _Available since v0.1.0_
784784
==== `[.contract-item-name]#++onlyPoolManager++#++()++` [.item-kind]#modifier#
785785

786786
[.contract-item]
787-
[[BaseHook-constructor--]]
788-
==== `[.contract-item-name]#++constructor++#++()++` [.item-kind]#internal#
787+
[[BaseHook-constructor-contract-IPoolManager-]]
788+
==== `[.contract-item-name]#++constructor++#++(contract IPoolManager _poolManager)++` [.item-kind]#internal#
789789

790790
Check that the hook address matches the expected permissions and flags.
791791

792-
[.contract-item]
793-
[[BaseHook-poolManager--]]
794-
==== `[.contract-item-name]#++poolManager++#++() → contract IPoolManager++` [.item-kind]#public#
795-
796-
The pool manager singleton contract.
797-
798792
[.contract-item]
799793
[[BaseHook-getHookPermissions--]]
800794
==== `[.contract-item-name]#++getHookPermissions++#++() → struct Hooks.Permissions permissions++` [.item-kind]#public#
@@ -919,6 +913,10 @@ flag must be set to true in the `getHookPermissions` function.
919913
Hook implementation for `afterDonate`, to be overridden by the inheriting hook. The
920914
flag must be set to true in the `getHookPermissions` function.
921915

916+
[.contract-item]
917+
[[BaseHook-poolManager-contract-IPoolManager]]
918+
==== `[.contract-item-name]#++poolManager++#++() → contract IPoolManager++` [.item-kind]#public#
919+
922920
[.contract-item]
923921
[[BaseHook-HookNotImplemented--]]
924922
==== `[.contract-item-name]#++HookNotImplemented++#++()++` [.item-kind]#error#
@@ -977,7 +975,6 @@ _Available since v0.1.0_
977975

978976
[.contract-subindex-inherited]
979977
.BaseHook
980-
* {xref-BaseHook-poolManager--}[`++poolManager()++`]
981978
* {xref-BaseHook-_validateHookAddress-contract-BaseHook-}[`++_validateHookAddress(hook)++`]
982979
* {xref-BaseHook-beforeInitialize-address-struct-PoolKey-uint160-}[`++beforeInitialize(sender, key, sqrtPriceX96)++`]
983980
* {xref-BaseHook-_beforeInitialize-address-struct-PoolKey-uint160-}[`++_beforeInitialize(, , )++`]
@@ -998,6 +995,7 @@ _Available since v0.1.0_
998995
* {xref-BaseHook-_beforeDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_beforeDonate(, , , , )++`]
999996
* {xref-BaseHook-afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++afterDonate(sender, key, amount0, amount1, hookData)++`]
1000997
* {xref-BaseHook-_afterDonate-address-struct-PoolKey-uint256-uint256-bytes-}[`++_afterDonate(, , , , )++`]
998+
* {xref-BaseHook-poolManager-contract-IPoolManager}[`++poolManager()++`]
1001999

10021000
[.contract-subindex-inherited]
10031001
.IHooks

0 commit comments

Comments
 (0)