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

Jump to bottom

V4 tech ref submodules #784

Merged
merged 4 commits into from
Sep 30, 2024
Merged

V4 tech ref submodules #784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0c04e9
v4-as-submodules
saucepoint Sep 30, 2024
c589fd6
generate docs from submodules into docs project directory
saucepoint Sep 30, 2024
67f9643
reuseable function
saucepoint Sep 30, 2024
70109ac
regenerate technical reference
saucepoint Sep 30, 2024
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
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ typechain/

.env

# ignore forge-doc artifacts as they are copied to the proper location
forge-docs/v4-core/*
forge-docs/v4-periphery/*

# Debugging logs
npm-debug.log*
yarn-debug.log*
Expand Down
6 changes: 6 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[submodule "submodules/v4-core"]
path = submodules/v4-core
url = https://github.com/uniswap/v4-core
[submodule "submodules/v4-periphery"]
path = submodules/v4-periphery
url = https://github.com/uniswap/v4-periphery
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/ERC6909.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ERC6909
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/ERC6909.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/ERC6909.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/ERC6909Claims.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ERC6909Claims
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/ERC6909Claims.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/ERC6909Claims.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/Extsload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Extsload
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/Extsload.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/Extsload.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/Exttload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Exttload
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/Exttload.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/Exttload.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/NoDelegateCall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NoDelegateCall
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/NoDelegateCall.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/NoDelegateCall.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Base contract that provides a modifier for preventing delegatecall to methods in a child contract
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/PoolManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# PoolManager
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/PoolManager.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/PoolManager.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/ProtocolFees.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ProtocolFees
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/ProtocolFees.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/ProtocolFees.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IERC20Minimal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IERC20Minimal
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/external/IERC20Minimal.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/external/IERC20Minimal.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Contains a subset of the full ERC20 interface that is used in Uniswap V3
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IERC6909Claims.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IERC6909Claims
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/external/IERC6909Claims.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/external/IERC6909Claims.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Interface for claims over a contract balance, wrapped as a ERC6909
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IExtsload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IExtsload
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IExtsload.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IExtsload.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Interface for functions to access any storage slot in a contract
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IExttload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IExttload
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IExttload.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IExttload.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Interface for functions to access any transient storage slot in a contract
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IHooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IHooks
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IHooks.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IHooks.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

V4 decides whether to invoke specific hooks by inspecting the least significant bits
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IPoolManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IPoolManager
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IPoolManager.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IPoolManager.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IProtocolFeeController.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IProtocolFeeController
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IProtocolFeeController.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IProtocolFeeController.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Interface to fetch the protocol fees for a pool from the protocol fee controller
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IProtocolFees.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IProtocolFees
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IProtocolFees.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/IProtocolFees.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Interface for all protocol-fee related functions in the pool manager
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/interfaces/IUnlockCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IUnlockCallback
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/callback/IUnlockCallback.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/interfaces/callback/IUnlockCallback.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Interface for the callback executed when an address unlocks the pool manager
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/BipsLibrary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BipsLibrary
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/BipsLibrary.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/BipsLibrary.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)


Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/BitMath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BitMath
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/BitMath.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/BitMath.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Author:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/CurrencyDelta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CurrencyDelta
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/CurrencyDelta.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/CurrencyDelta.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

*this library implements the equivalent of a mapping, as transient storage can only be accessed in assembly*
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/CurrencyReserves.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CurrencyReserves
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/CurrencyReserves.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/CurrencyReserves.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)


Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/CustomRevert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CustomRevert
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/CustomRevert.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/CustomRevert.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Contains functions for reverting with custom errors with different argument types efficiently
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/FixedPoint128.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# FixedPoint128
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/FixedPoint128.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/FixedPoint128.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

A library for handling binary fixed point numbers, see https://en.wikipedia.org/wiki/Q_(number_format)
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/FixedPoint96.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# FixedPoint96
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/FixedPoint96.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/FixedPoint96.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

A library for handling binary fixed point numbers, see https://en.wikipedia.org/wiki/Q_(number_format)
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/FullMath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# FullMath
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/FullMath.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/FullMath.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Facilitates multiplication and division that can have overflow of an intermediate value without any loss of precision
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/Hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Hooks
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Hooks.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Hooks.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

V4 decides whether to invoke specific hooks by inspecting the least significant bits
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/LPFeeLibrary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# LPFeeLibrary
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/LPFeeLibrary.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/LPFeeLibrary.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Library of helper functions for a pools LP fee
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/LiquidityMath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# LiquidityMath
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/LiquidityMath.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/LiquidityMath.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)


Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/Lock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Lock
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Lock.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Lock.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

This is a temporary library that allows us to use transient storage (tstore/tload)
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/NonzeroDeltaCount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NonzeroDeltaCount
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/NonzeroDeltaCount.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/NonzeroDeltaCount.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

This is a temporary library that allows us to use transient storage (tstore/tload)
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/ParseBytes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ParseBytes
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/ParseBytes.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/ParseBytes.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Parses bytes returned from hooks and the byte selector used to check return selectors from hooks.
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/Pool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Pool
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Pool.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Pool.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

a library with all actions that can be performed on a pool
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/Position.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Position
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Position.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/Position.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Positions represent an owner address' liquidity between a lower and upper tick boundary
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/ProtocolFeeLibrary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ProtocolFeeLibrary
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/ProtocolFeeLibrary.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/ProtocolFeeLibrary.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

library of functions related to protocol fees
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/SafeCast.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SafeCast
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/SafeCast.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/SafeCast.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Contains methods for safely casting between types
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/SqrtPriceMath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SqrtPriceMath
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/SqrtPriceMath.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/SqrtPriceMath.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Contains the math that uses square root of price as a Q64.96 and liquidity to compute deltas
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/StateLibrary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# StateLibrary
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/StateLibrary.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/StateLibrary.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

A helper library to provide state getters that use extsload
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/SwapMath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SwapMath
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/SwapMath.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/SwapMath.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Contains methods for computing the result of a swap within a single tick price range, i.e., a single tick.
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/TickBitmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# TickBitmap
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/TickBitmap.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/TickBitmap.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Stores a packed mapping of tick index to its initialized state
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/TickMath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# TickMath
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/TickMath.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/TickMath.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Computes sqrt price for ticks of size 1.0001, i.e. sqrt(1.0001^tick) as fixed point Q64.96 numbers. Supports
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/TransientStateLibrary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# TransientStateLibrary
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/TransientStateLibrary.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/TransientStateLibrary.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

A helper library to provide state getters that use exttload
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/libraries/UnsafeMath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# UnsafeMath
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/UnsafeMath.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/libraries/UnsafeMath.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

Contains methods that perform common math functions but do not do any overflow or underflow checks
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/test/ActionsRouter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ActionsRouter
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/ActionsRouter.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/ActionsRouter.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/test/BaseTestHooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BaseTestHooks
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/BaseTestHooks.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/BaseTestHooks.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/test/CurrencyTest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CurrencyTest
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/CurrencyTest.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/CurrencyTest.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)


Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/test/CustomCurveHook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CustomCurveHook
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/CustomCurveHook.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/CustomCurveHook.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/test/DeltaReturningHook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DeltaReturningHook
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/DeltaReturningHook.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/DeltaReturningHook.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/v4/reference/core/test/DynamicFeesTestHook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DynamicFeesTestHook
[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/DynamicFeesTestHook.sol)
[Git Source](https://github.com/Uniswap/docs/blob/1141642f8ba4665a50660886a8a8401526677045/src/test/DynamicFeesTestHook.sol)
| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc)

**Inherits:**
Expand Down
Loading
Loading