Skip to content

docs: fix typo sandwhiching -> sandwiching #132

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

Open
phessophissy wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix typo sandwhiching -> sandwiching #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8b092b
docs: fix typo sandwhiching -> sandwiching
phessophissy Jan 9, 2026
17f1aee
docs: add NatSpec documentation to IConvexBooster interface
phessophissy Jan 9, 2026
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
13 changes: 13 additions & 0 deletions src/interfaces/IConvexBooster.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13;

/// @title IConvexBooster
/// @notice Interface for the Convex Finance Booster contract
/// @dev Used to interact with Convex pools for depositing, withdrawing, and claiming rewards
interface IConvexBooster {
/// @notice Withdraws LP tokens from a Convex pool
/// @param pid The pool ID to withdraw from
/// @param _amount The amount of LP tokens to withdraw
function withdraw(uint256 pid, uint256 _amount) external;

/// @notice Deposits LP tokens into a Convex pool
/// @param pid The pool ID to deposit into
/// @param amount The amount of LP tokens to deposit
/// @param stake Whether to stake the deposit in the rewards contract
function deposit(uint256 pid, uint256 amount, bool stake) external;

/// @notice Claims pending CRV and CVX rewards for a pool and transfers them to the reward contract
/// @param pid The pool ID to claim rewards for
function earmarkRewards(uint256 pid) external;
}
12 changes: 6 additions & 6 deletions src/util/OffchainAbstractHelper.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ abstract contract OffchainAbstractHelper {
@param market Market the caller wishes to borrow from
@param dolaAmount Amount the caller wants to end up with at their disposal
@param dolaForDbr The max amount of debt the caller is willing to end up with
This is a sensitive parameter and should be reasonably low to prevent sandwhiching.
This is a sensitive parameter and should be reasonably low to prevent sandwiching.
A good estimate can be calculated given the approximateDolaAndDbrNeeded function, though should be set slightly higher.
@param minDbr The minDbr the caller wish to borrow for
@param deadline Deadline of the signature
Expand Down Expand Up @@ -88,7 +88,7 @@ abstract contract OffchainAbstractHelper {
@param market Market the caller wish to deposit to and borrow from
@param dolaAmount Amount the caller wants to end up with at their disposal
@param dolaForDbr The max amount of debt the caller is willing to take on to buy dbr
This is a sensitive parameter and should be reasonably low to prevent sandwhiching.
This is a sensitive parameter and should be reasonably low to prevent sandwiching.
A good estimate can be calculated given the approximateDolaAndDbrNeeded function, though should be set slightly higher.
@param minDbr The minDbr the caller wish to borrow for
@param deadline Deadline of the signature
Expand Down Expand Up @@ -126,7 +126,7 @@ abstract contract OffchainAbstractHelper {
@param market Market the caller wish to deposit to and borrow from
@param dolaAmount Amount the caller wants to end up with at their disposal
@param dolaForDbr The max amount of debt the caller is willing to end up with
This is a sensitive parameter and should be reasonably low to prevent sandwhiching.
This is a sensitive parameter and should be reasonably low to prevent sandwiching.
A good estimate can be calculated given the approximateDolaAndDbrNeeded function, though should be set slightly higher.
@param minDbr The minDbr the caller wish to borrow for
@param deadline Deadline of the signature
Expand Down Expand Up @@ -163,7 +163,7 @@ abstract contract OffchainAbstractHelper {
@param market The market the user wishes to repay debt in
@param dolaAmount The maximum amount of dola debt the user is willing to repay
@param minDolaFromDbr The minimum amount of DOLA the caller expects to get in return for selling their DBR.
This is a sensitive parameter and should be provided with reasonably low slippage to prevent sandwhiching.
This is a sensitive parameter and should be provided with reasonably low slippage to prevent sandwiching.
@param dbrAmountToSell The amount of DBR the caller wishes to sell
*/
function sellDbrAndRepayOnBehalf(IMarket market, uint dolaAmount, uint minDolaFromDbr, uint dbrAmountToSell) public {
Expand Down Expand Up @@ -202,7 +202,7 @@ abstract contract OffchainAbstractHelper {
@param market Market the user wishes to repay debt in
@param dolaAmount Maximum amount of dola debt the user is willing to repay
@param minDolaFromDbr Minimum amount of DOLA the caller expects to get in return for selling their DBR
This is a sensitive parameter and should be provided with reasonably low slippage to prevent sandwhiching.
This is a sensitive parameter and should be provided with reasonably low slippage to prevent sandwiching.
@param dbrAmountToSell Amount of DBR the caller wishes to sell
@param collateralAmount Amount of collateral to withdraw
@param deadline Deadline of the signature
Expand Down Expand Up @@ -238,7 +238,7 @@ abstract contract OffchainAbstractHelper {
@param market Market the user wishes to repay debt in
@param dolaAmount Maximum amount of dola debt the user is willing to repay
@param minDolaFromDbr Minimum amount of DOLA the caller expects to get in return for selling their DBR
This is a sensitive parameter and should be provided with reasonably low slippage to prevent sandwhiching.
This is a sensitive parameter and should be provided with reasonably low slippage to prevent sandwiching.
@param dbrAmountToSell Amount of DBR the caller wishes to sell
@param collateralAmount Amount of collateral to withdraw
@param deadline Deadline of the signature
Expand Down