Skip to content

Commit

Permalink
Resolve comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
gnarlycow committed Jul 29, 2024
1 parent 0052822 commit d000e72
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,14 @@ To run the tests:
forge test
```

## Inline Assembly

The libraries in this repository make use of [in-line assembly](https://docs.soliditylang.org/en/latest/assembly.html) for fine-grained control and optimizations. Knowledge of ABI encoding is required to understand how to calculate calldata length and parameter offsets. Helpful links:

- [ABI Specification](https://docs.soliditylang.org/en/latest/abi-spec.html#formal-specification-of-the-encoding)
- [HashEx Online ABI Encoder Tool](https://abi.hashex.org)
- [Solidity Memory Layout](https://docs.soliditylang.org/en/latest/internals/layout_in_memory.html)

## Contributions

Contributions are welcome. Please ensure that any modifications pass all tests before submitting a pull request.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@aperture_finance/uni-v3-lib",
"description": "A suite of Solidity libraries that have been imported and rewritten from Uniswap's v3-core and v3-periphery",
"version": "3.0.0",
"version": "3.0.1",
"author": "Aperture Finance",
"homepage": "https://aperture.finance/",
"license": "GPL-2.0-or-later",
Expand Down Expand Up @@ -51,4 +51,4 @@
"endOfLine": "lf",
"printWidth": 120
}
}
}
3 changes: 2 additions & 1 deletion test/Base.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ import {TickBitmap} from "src/TickBitmap.sol";
import {TickMath} from "src/TickMath.sol";
import {ICommonNonfungiblePositionManager} from "src/interfaces/ICommonNonfungiblePositionManager.sol";

// Partial interface for the SlipStream factory.
// Partial interface for the SlipStream factory. SlipStream factory is named "CLFactory" and "CL" presumably stands for concentrated liquidity.
// https://github.com/velodrome-finance/slipstream/blob/main/contracts/core/interfaces/ICLFactory.sol
interface ISlipStreamCLFactory {
/// @notice Returns the pool address for a given pair of tokens and a tick spacing, or address 0 if it does not exist
/// @dev tokenA and tokenB may be passed in either token0/token1 or token1/token0 order
Expand Down

0 comments on commit d000e72

Please # to comment.