From 6d1a1e27c154f4bf98bdec269437d876ff073c40 Mon Sep 17 00:00:00 2001 From: saucepoint Date: Fri, 27 Sep 2024 10:30:52 -0400 Subject: [PATCH] discard duplicates --- .../v4/reference/core/types/BalanceDelta.md | 9 -- .../reference/core/types/BeforeSwapDelta.md | 11 --- .../v4/reference/core/types/Currency.md | 91 ------------------- .../v4/reference/core/types/PoolKey.md | 17 ---- 4 files changed, 128 deletions(-) delete mode 100644 docs/contracts/v4/reference/core/types/BalanceDelta.md delete mode 100644 docs/contracts/v4/reference/core/types/BeforeSwapDelta.md delete mode 100644 docs/contracts/v4/reference/core/types/Currency.md delete mode 100644 docs/contracts/v4/reference/core/types/PoolKey.md diff --git a/docs/contracts/v4/reference/core/types/BalanceDelta.md b/docs/contracts/v4/reference/core/types/BalanceDelta.md deleted file mode 100644 index c65e67d9c..000000000 --- a/docs/contracts/v4/reference/core/types/BalanceDelta.md +++ /dev/null @@ -1,9 +0,0 @@ -# neq -[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/types/BalanceDelta.sol) -| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc) - - -```solidity -function neq(BalanceDelta a, BalanceDelta b) pure returns (bool); -``` - diff --git a/docs/contracts/v4/reference/core/types/BeforeSwapDelta.md b/docs/contracts/v4/reference/core/types/BeforeSwapDelta.md deleted file mode 100644 index 97607a4c3..000000000 --- a/docs/contracts/v4/reference/core/types/BeforeSwapDelta.md +++ /dev/null @@ -1,11 +0,0 @@ -# toBeforeSwapDelta -[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/types/BeforeSwapDelta.sol) -| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc) - - -```solidity -function toBeforeSwapDelta(int128 deltaSpecified, int128 deltaUnspecified) - pure - returns (BeforeSwapDelta beforeSwapDelta); -``` - diff --git a/docs/contracts/v4/reference/core/types/Currency.md b/docs/contracts/v4/reference/core/types/Currency.md deleted file mode 100644 index f231fea14..000000000 --- a/docs/contracts/v4/reference/core/types/Currency.md +++ /dev/null @@ -1,91 +0,0 @@ -# CurrencyLibrary -[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/types/Currency.sol) -| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc) - -*This library allows for transferring and holding native tokens and ERC20 tokens* - - -## State Variables -### ADDRESS_ZERO -A constant to represent the native currency - - -```solidity -Currency public constant ADDRESS_ZERO = Currency.wrap(address(0)); -``` - - -## Functions -### transfer - - -```solidity -function transfer(Currency currency, address to, uint256 amount) internal; -``` - -### balanceOfSelf - - -```solidity -function balanceOfSelf(Currency currency) internal view returns (uint256); -``` - -### balanceOf - - -```solidity -function balanceOf(Currency currency, address owner) internal view returns (uint256); -``` - -### isAddressZero - - -```solidity -function isAddressZero(Currency currency) internal pure returns (bool); -``` - -### toId - - -```solidity -function toId(Currency currency) internal pure returns (uint256); -``` - -### fromId - - -```solidity -function fromId(uint256 id) internal pure returns (Currency); -``` - -## Errors -### Wrap__NativeTransferFailed -Thrown when a native transfer fails - - -```solidity -error Wrap__NativeTransferFailed(address recipient, bytes reason); -``` - -**Parameters** - -|Name|Type|Description| -|----|----|-----------| -|`recipient`|`address`|| -|`reason`|`bytes`|bubbled up revert reason| - -### Wrap__ERC20TransferFailed -Thrown when an ERC20 transfer fails - - -```solidity -error Wrap__ERC20TransferFailed(address token, bytes reason); -``` - -**Parameters** - -|Name|Type|Description| -|----|----|-----------| -|`token`|`address`|| -|`reason`|`bytes`|bubbled up revert reason| - diff --git a/docs/contracts/v4/reference/core/types/PoolKey.md b/docs/contracts/v4/reference/core/types/PoolKey.md deleted file mode 100644 index 46c824553..000000000 --- a/docs/contracts/v4/reference/core/types/PoolKey.md +++ /dev/null @@ -1,17 +0,0 @@ -# PoolKey -[Git Source](https://github.com/uniswap/v4-core/blob/1141642f8ba4665a50660886a8a8401526677045/src/types/PoolKey.sol) -| Generated with [forge doc](https://book.getfoundry.sh/reference/forge/forge-doc) - -Returns the key for identifying a pool - - -```solidity -struct PoolKey { - Currency currency0; - Currency currency1; - uint24 fee; - int24 tickSpacing; - IHooks hooks; -} -``` -