Updated contract docs for pull request - #132
Closed
duelinggalois wants to merge 1 commit into
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
duelinggalois
force-pushed
the
release/core-v1/update-contract-docs-action-published
branch
from
March 31, 2026 04:22
45df00e to
1a84a1b
Compare
duelinggalois
force-pushed
the
release/core-v1/update-contract-docs-action-published
branch
from
June 15, 2026 21:21
1a84a1b to
50ddf93
Compare
There was a problem hiding this comment.
Pull request overview
Updates the generated Solidity contract documentation in docs/developer-guide/contracts/** to reflect the latest core-v1 changes (new/removed state variables, updated function signatures, new library docs, and refreshed “Git Source” commit links).
Changes:
- Refresh “Git Source” links to a new
core-v1commit across many contract/interface/library docs. - Update docs to match new contract/library APIs (e.g., active-liquidity calculations, saturation/TWAP additions, liquidation refactors, new errors).
- Add new documentation page for
PriceExtremesand expand/adjust documentation text for several complex math/validation sections.
Reviewed changes
Copilot reviewed 53 out of 53 changed files in this pull request and generated 18 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/developer-guide/contracts/utils/deployHelper.sol/function.deployFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/tokens/TokenController.sol/contract.TokenController.md | Updates state var visibility/docs and function signatures; adds new variables and explanations. |
| docs/developer-guide/contracts/tokens/HookRegistry.sol/contract.HookRegistry.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/tokens/ERC4626DepositToken.sol/contract.ERC4626DepositToken.md | Updates override references and facade descriptions; source link refreshed. |
| docs/developer-guide/contracts/tokens/ERC4626DebtToken.sol/contract.ERC4626DebtToken.md | Updates facade descriptions and approve signature; source link refreshed. |
| docs/developer-guide/contracts/tokens/ERC20LiquidityToken.sol/contract.ERC20LiquidityToken.md | Updates override reference links and source link. |
| docs/developer-guide/contracts/tokens/ERC20DebtLiquidityToken.sol/contract.ERC20DebtLiquidityToken.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/tokens/ERC20DebtBase.sol/abstract.ERC20DebtBase.md | Updates approve signature documentation and source link. |
| docs/developer-guide/contracts/tokens/ERC20Base.sol/struct.ERC20BaseConfig.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/tokens/ERC20Base.sol/abstract.ERC20Base.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/SaturationAndGeometricTWAPState.sol/contract.SaturationAndGeometricTWAPState.md | Adds new state/functions and refines parameter/return docs; source link refreshed. |
| docs/developer-guide/contracts/proxy/PairLockedLoans.sol/contract.PairLockedLoans.md | Adds _initialize docs and new error; source link refreshed. |
| docs/developer-guide/contracts/proxy/PairFrozen.sol/contract.PairFrozen.md | Adds _initialize docs; source link refreshed. |
| docs/developer-guide/contracts/proxy/PairBlockLendingFundRemoval.sol/contract.PairBlockLendingFundRemoval.md | Renames/replaces doc content to match new restricted implementation and adds new error. |
| docs/developer-guide/contracts/proxy/PairBeaconProxy.sol/interface.IPairInitializable.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/proxy/PairBeaconProxy.sol/contract.PairBeaconProxy.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/proxy/PairBeaconProxy.sol/contract.InitializablePair.md | Adds onlyProxySelfCall modifier docs and access error; updates reInitialize signature docs. |
| docs/developer-guide/contracts/proxy/BeaconController.sol/interface.IBeaconController.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/proxy/BeaconController.sol/contract.BeaconController.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/libraries/Validation.sol/library.Validation.md | Updates constants/signatures/docs; includes complex math sections (with formatting issues noted). |
| docs/developer-guide/contracts/libraries/Uint16Set.sol/library.Uint16Set.md | Updates remove() docs/signature and return naming (with inconsistencies noted). |
| docs/developer-guide/contracts/libraries/TokenSymbol.sol/library.TokenSymbol.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/libraries/TickMath.sol/library.TickMath.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/libraries/Saturation.sol/library.Saturation.md | Major doc updates for saturation math/API and new constants (with multiple LaTeX formatting issues noted). |
| docs/developer-guide/contracts/libraries/QuadraticSwapFees.sol/library.QuadraticSwapFees.md | Updates fee-model math docs (with LaTeX formatting issues noted). |
| docs/developer-guide/contracts/libraries/PriceExtremes.sol/library.PriceExtremes.md | New library documentation page added. |
| docs/developer-guide/contracts/libraries/PartialLiquidations.sol/library.PartialLiquidations.md | Expanded partial-liquidation derivations and helper docs (with LaTeX formatting issues noted). |
| docs/developer-guide/contracts/libraries/Liquidation.sol/library.Liquidation.md | Updates leverage/saturation liquidation API docs and derivations (with LaTeX formatting issues noted). |
| docs/developer-guide/contracts/libraries/Interest.sol/library.Interest.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/libraries/GeometricTWAP.sol/library.GeometricTWAP.md | Updates mid-term tick API docs and constants (with LaTeX formatting issue noted). |
| docs/developer-guide/contracts/libraries/Convert.sol/library.Convert.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/libraries/constants.sol/constants.constants.md | Updates constants docs (with LaTeX formatting issue noted). |
| docs/developer-guide/contracts/interfaces/tokens/ITokenController.sol/interface.ITokenController.md | Updates event fields and adds new error docs. |
| docs/developer-guide/contracts/interfaces/tokens/ITokenController.sol/constants.ITokenController.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/tokens/IHookRegistry.sol/interface.IHookRegistry.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/tokens/IERC20DebtToken.sol/interface.IERC20DebtToken.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/tokens/IAmmalgamERC20.sol/interface.IAmmalgamERC20.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/ISaturationAndGeometricTWAPState.sol/interface.ISaturationAndGeometricTWAPState.md | Adds new methods and updates existing signatures/parameter docs. |
| docs/developer-guide/contracts/interfaces/IAmmalgamPair.sol/interface.IAmmalgamPair.md | Updates source link and adds validateOnUpdate docs. |
| docs/developer-guide/contracts/interfaces/factories/ITokenFactory.sol/interface.ITokenFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/factories/IFactoryCallback.sol/interface.IFactoryCallback.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/factories/IAmmalgamFactory.sol/interface.IBeaconCallback.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/factories/IAmmalgamFactory.sol/interface.IAmmalgamFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/callbacks/ITransferValidator.sol/interface.ITransferValidator.md | Adds tokens() docs and updates source link. |
| docs/developer-guide/contracts/interfaces/callbacks/IAmmalgamCallee.sol/interface.ISwapCallback.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/callbacks/IAmmalgamCallee.sol/interface.ICallback.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/interfaces/callbacks/IAmmalgamCallee.sol/interface.IBorrowCallback.md | Updates parameter descriptions and source link. |
| docs/developer-guide/contracts/factories/ERC4626DepositTokenFactory.sol/contract.ERC4626DepositTokenFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/factories/ERC4626DebtTokenFactory.sol/contract.ERC4626DebtTokenFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/factories/ERC20LiquidityTokenFactory.sol/contract.ERC20LiquidityTokenFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/factories/ERC20DebtLiquidityTokenFactory.sol/contract.ERC20DebtLiquidityTokenFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/factories/AmmalgamFactory.sol/contract.AmmalgamFactory.md | Updates source link to new upstream commit. |
| docs/developer-guide/contracts/AmmalgamPair.sol/contract.AmmalgamPair.md | Updates docs for new variables/helpers and refines liquidation documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| \begin{align*} | ||
| reserveIn &= L \cdot \sqrt{p} \\ | ||
| reserveOut &= \frac{L}{ \sqrt{p} } \\ | ||
| reserveOut &= \frac`L`{ \sqrt{p} } \\ |
Comment on lines
+274
to
+277
| { \frac`L`{ \sqrt{p} } - \frac{ 2 \cdot L_{out} }{\sqrt{p} } } \\ | ||
| L_{in} | ||
| &= \frac{ L \cdot \sqrt{p} \cdot \frac{ 2 \cdot L_{out} }{ \sqrt{p} } } | ||
| { 2 \cdot \sqrt{p} \cdot \left(\frac{L}{ \sqrt{p} } - \frac{ 2 \cdot L_{out} }{\sqrt{p} }\right)} \\ | ||
| { 2 \cdot \sqrt{p} \cdot \left(\frac`L`{ \sqrt{p} } - \frac{ 2 \cdot L_{out} }{\sqrt{p} }\right)} \\ |
Comment on lines
+18
to
20
| x = L \cdot B^`T_0` - L \cdot B^`T_1` \\ | ||
| y = \frac`L`{ B^`T_1`} - \frac`L``B^{T_0`} | ||
| \end{align*} |
| If saturation with respect to our starting $L$ is smaller, that amount of debt can be | ||
| liquidated in one swap in the given ticks. Otherwise it is too big and can not. Note that we | ||
| assume $$t_1 \text{ and } t_0 \in \mathbb{Z}$$ and $$t_0 + 1 = t_1$$. Then our definition of | ||
| assume $$t_1 \text{ and } t_0 \in \mathbb`Z`$$ and $$t_0 + 1 = t_1$$. Then our definition of |
Comment on lines
+154
to
+157
| n \cdot \frac{2(X_{0}-X_`R`)+X_{in}}`X_{R`} | ||
| &\text{if } X_0 \ge X_R \text{ \& } X_{in} + 2 X_{0} \le X_`R`\left(\frac`M_Q +\ 2n`{n}\right) \\ | ||
| M_Q \left( 2 - X_R \frac`M_Q`{n\left( X_{in} + 2 (X_0 - X_R) \right)} \right) | ||
| &\text {if } X_0 \ge X_R \text{ \& } X_{in} + 2X_{0} \ge X_`R`\left(\frac`M_Q+\ 2n`{n}\right) \\ |
Comment on lines
+155
to
+159
| \frac`B``D` | ||
| - \frac`AL - 1``AL` | ||
| \right) | ||
| \text { if } \frac{B}{D} > | ||
| \frac{AL - 1}{AL} \\ | ||
| \text { if } \frac`B``D` > | ||
| \frac`AL - 1``AL` \\ |
| remove a key. | ||
|
|
||
| *key to remove must exist.* | ||
| *If the key does not exist, this function is a no-op and returns true.* |
| |Name|Type|Description| | ||
| |----|----|-----------| | ||
| |`keyDidNotExist`|`bool`|whether the key already did not yet exist in the set| | ||
| |`isSetEmpty`|`bool`|whether the key did not exist or the set still has items after removal| |
| ### ownerMint | ||
|
|
||
| *override [ERC20Base-ownerMint](/docs/developer-guide/contracts/tokens/ERC4626DebtToken.sol/contract.ERC4626DebtToken.md#ownermint).* | ||
| *override [ERC20Base-ownerMint](/docs/developer-guide/contracts/tokens/ERC4626DepositToken.sol/contract.ERC4626DepositToken.md#ownermint).* |
| ### ownerBurn | ||
|
|
||
| *override [ERC20Base-ownerBurn](/docs/developer-guide/contracts/tokens/ERC4626DebtToken.sol/contract.ERC4626DebtToken.md#ownerburn).* | ||
| *override [ERC20Base-ownerBurn](/docs/developer-guide/contracts/tokens/ERC4626DepositToken.sol/contract.ERC4626DepositToken.md#ownerburn).* |
Contributor
|
co-pilot is calling out the same issue I see, here's an exmaple of how it renders on the webpage: seems like it's this line in script/docs/docs_transform.sh: AI is suggesting this regex should fix: 
|
eswarasai
deleted the
release/core-v1/update-contract-docs-action-published
branch
June 22, 2026 08:46
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull request generated automatically from core-v1 pull request