FluidVaultT4Operate

Git Source

Inherits:Internals

Functions

operate

Performs operations on a vault position

This function allows users to modify their vault position by adjusting collateral and debt

function operate(
    uint256 nftId_,
    int256 newColToken0_,
    int256 newColToken1_,
    int256 colSharesMinMax_,
    int256 newDebtToken0_,
    int256 newDebtToken1_,
    int256 debtSharesMinMax_,
    address to_
) external payable _delegateCallCheck returns (uint256, int256, int256);

Parameters

Name	Type	Description
nftId_	uint256	The ID of the NFT representing the vault position
newColToken0_	int256	The change in collateral amount for token0 (positive for deposit, negative for withdrawal)
newColToken1_	int256	The change in collateral amount for token1 (positive for deposit, negative for withdrawal)
colSharesMinMax_	int256	Min or max collateral shares to mint or burn (positive for deposit, negative for withdrawal)
newDebtToken0_	int256	The change in debt amount for token0 (positive for borrowing, negative for repayment)
newDebtToken1_	int256	The change in debt amount for token1 (positive for borrowing, negative for repayment)
debtSharesMinMax_	int256	Min or max debt shares to burn or mint (positive for borrowing, negative for repayment)
to_	address	The address to receive withdrawn collateral or borrowed tokens (if address(0), defaults to msg.sender)

Returns

Name	Type	Description
<none>	uint256	nftId_ The ID of the NFT representing the updated vault position
<none>	int256	supplyAmt_ Final supply amount (negative if withdrawal occurred)
<none>	int256	borrowAmt_ Final borrow amount (negative if repayment occurred)

operatePerfect

Performs operations on a vault position with perfect collateral shares

This function allows users to modify their vault position by adjusting collateral and debt

function operatePerfect(
    uint256 nftId_,
    int256 perfectColShares_,
    int256 colToken0MinMax_,
    int256 colToken1MinMax_,
    int256 perfectDebtShares_,
    int256 debtToken0MinMax_,
    int256 debtToken1MinMax_,
    address to_
) external payable _delegateCallCheck returns (uint256, int256[] memory r_);

Parameters

Name	Type	Description
nftId_	uint256	The ID of the NFT representing the vault position
perfectColShares_	int256	The change in collateral shares (positive for deposit, negative for withdrawal)
colToken0MinMax_	int256	Min or max collateral amount of token0 to withdraw or deposit (positive for deposit, negative for withdrawal)
colToken1MinMax_	int256	Min or max collateral amount of token1 to withdraw or deposit (positive for deposit, negative for withdrawal)
perfectDebtShares_	int256	The change in debt shares (positive for borrowing, negative for repayment)
debtToken0MinMax_	int256	Min or max debt amount for token0 to borrow or payback (positive for borrowing, negative for repayment)
debtToken1MinMax_	int256	Min or max debt amount for token1 to borrow or payback (positive for borrowing, negative for repayment)
to_	address

Returns

Name	Type	Description
<none>	uint256	nftId_ The ID of the NFT representing the updated vault position
r_	int256[]	int256 array of return values: 0 - final col shares amount (can only change on max withdrawal) 1 - token0 deposit or withdraw amount 2 - token1 deposit or withdraw amount 3 - final debt shares amount (can only change on max payback) 4 - token0 borrow or payback amount 5 - token1 borrow or payback amount

constructor

constructor(ConstantViews memory constants_) Internals(constants_);

Structs

SmartOperate

struct SmartOperate {
    uint256 initialEth;
    int256 colShares;
    int256 debtShares;
    uint256 vaultVariables;
}

SmartOperatePerfect

struct SmartOperatePerfect {
    uint256 initialEth;
    int256 newColToken0;
    int256 newColToken1;
    int256 newDebtToken0;
    int256 newDebtToken1;
    uint256 vaultVariables;
}