IUniLiquidityManager.sol

Methods

accruedSteerFees0()

Solidity

function accruedSteerFees0() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

accruedSteerFees1()

Solidity

function accruedSteerFees1() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

accruedStrategistFees0()

Solidity

function accruedStrategistFees0() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

accruedStrategistFees1()

Solidity

function accruedStrategistFees1() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

allowance(address,address)

Solidity

function allowance(address owner, address spender) external view returns (uint256)

Details

Returns the remaining number of tokens that spender will be allowed to spend on behalf of owner through {transferFrom}. This is zero by default. This value changes when {approve} or {transferFrom} are called.

Parameters

Name	Type	Description
owner	address	undefined
spender	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

approve(address,uint256)

Solidity

function approve(address spender, uint256 amount) external nonpayable returns (bool)

Details

Sets amount as the allowance of spender over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 Emits an {Approval} event.

Parameters

Name	Type	Description
spender	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

balanceOf(address)

Solidity

function balanceOf(address account) external view returns (uint256)

Details

Returns the amount of tokens owned by account.

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

claimLPTokensFromDeposit()

Solidity

function claimLPTokensFromDeposit() external nonpayable returns (uint256)

Details

Given a prior queued deposit, a user may claim their LP tokens here

Returns

Name	Type	Description
_0	uint256	uint256 amount of LP tokens earned by deposit and claimed

claimWithdrawal()

Solidity

function claimWithdrawal() external nonpayable

Details

given a prior queued withdrawal, a user may claim their withdrawn tokens here

deposit(uint256,uint256,uint256,uint256,address)

Deposits tokens in proportion to the vault's current holdings.

Solidity

function deposit(uint256 amount0Desired, uint256 amount1Desired, uint256 amount0Min, uint256 amount1Min, address to) external nonpayable returns (uint256 shares, uint256 amount0, uint256 amount1)

Details

These tokens sit in the vault and are not used for liquidity on Uniswap until the next rebalance.

Parameters

Name	Type	Description
amount0Desired	uint256	Max amount of token0 to deposit
amount1Desired	uint256	Max amount of token1 to deposit
amount0Min	uint256	Revert if resulting amount0 is less than this
amount1Min	uint256	Revert if resulting amount1 is less than this
to	address	Recipient of shares

Returns

Name	Type	Description
shares	uint256	Number of shares minted
amount0	uint256	Amount of token0 deposited
amount1	uint256	Amount of token1 deposited

getLPTValue()

Solidity

function getLPTValue() external view returns (uint256, uint256)

Returns

Name	Type	Description
_0	uint256	undefined
_1	uint256	undefined

getStrategyTVLinT0()

Solidity

function getStrategyTVLinT0() external view returns (uint256)

Details

returns TVL in terms of T0.

Returns

Name	Type	Description
_0	uint256	undefined

getTotalAmounts()

Solidity

function getTotalAmounts() external view returns (uint256 total0, uint256 total1)

Returns

Name	Type	Description
total0	uint256	undefined
total1	uint256	undefined

getTotalAmountsIncludingFees()

Solidity

function getTotalAmountsIncludingFees() external nonpayable returns (uint256 total0, uint256 total1)

Returns

Name	Type	Description
total0	uint256	undefined
total1	uint256	undefined

harvest()

Solidity

function harvest() external nonpayable

Details

pulls earned fees from uniswap into the vault. Can be called by anyone. Called as part of tend().

initialize(address,address,bytes)

Solidity

function initialize(address _orchestrator, address _steer, bytes _params) external nonpayable

Parameters

Name	Type	Description
_orchestrator	address	undefined
_steer	address	undefined
_params	bytes	undefined

maxTotalSupply()

Solidity

function maxTotalSupply() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

pool()

Solidity

function pool() external view returns (contract IUniswapV3Pool)

Returns

Name	Type	Description
_0	contract IUniswapV3Pool	undefined

queueWithdrawal(uint256)

Solidity

function queueWithdrawal(uint256 _LPTs) external nonpayable

Details

queues a withdrawal

Parameters

Name	Type	Description
_LPTs	uint256	is amount of lp tokens they want to withdraw

steerCollectFees(uint256,uint256,address)

Solidity

function steerCollectFees(uint256 amount0, uint256 amount1, address to) external nonpayable

Parameters

Name	Type	Description
amount0	uint256	undefined
amount1	uint256	undefined
to	address	undefined

steerPullFees()

Solidity

function steerPullFees() external nonpayable

Details

steer-only function to withdraw funds steer has earned from vault proceeds

strategistCollectFees(uint256,uint256,address)

Used to collect accumulated protocol fees.

Solidity

function strategistCollectFees(uint256 amount0, uint256 amount1, address to) external nonpayable

Parameters

Name	Type	Description
amount0	uint256	undefined
amount1	uint256	undefined
to	address	undefined

strategistPullFees()

Solidity

function strategistPullFees() external nonpayable

Details

strategist-only function to withdraw funds strategist has earned from vault proceeds

tend(int256,uint160,tuple)

Solidity

function tend(int256 swapAmount, uint160 sqrtPriceLimitX96, IUniLiquidityManager.LiquidityPositions newPositions) external nonpayable

Parameters

Name	Type	Description
swapAmount	int256	undefined
sqrtPriceLimitX96	uint160	undefined
newPositions	IUniLiquidityManager.LiquidityPositions	undefined

token0()

Solidity

function token0() external view returns (address)

Returns

Name	Type	Description
_0	address	undefined

token1()

Solidity

function token1() external view returns (address)

Returns

Name	Type	Description
_0	address	undefined

totalSupply()

Solidity

function totalSupply() external view returns (uint256)

Details

Returns the amount of tokens in existence.

Returns

Name	Type	Description
_0	uint256	undefined

transfer(address,uint256)

Solidity

function transfer(address recipient, uint256 amount) external nonpayable returns (bool)

Details

Moves amount tokens from the caller's account to recipient. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.

Parameters

Name	Type	Description
recipient	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

transferFrom(address,address,uint256)

Solidity

function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)

Details

Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.

Parameters

Name	Type	Description
sender	address	undefined
recipient	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

update(int24,uint32[])

Solidity

function update(int24 startTick, uint32[] newBins) external nonpayable

Details

can only be called by orchestrator. Tends, and sets new bins.

Parameters

Name	Type	Description
startTick	int24	lowest tick to be included in new bins
newBins	uint32[]	new bins to be used

vaultRegistry()

Solidity

function vaultRegistry() external view returns (address)

Returns

Name	Type	Description
_0	address	undefined

withdraw(uint256,uint256,uint256,address)

Withdraws tokens in proportion to the vault's holdings.

Solidity

function withdraw(uint256 shares, uint256 amount0Min, uint256 amount1Min, address to) external nonpayable returns (uint256 amount0, uint256 amount1)

Parameters

Name	Type	Description
shares	uint256	Shares burned by sender
amount0Min	uint256	Revert if resulting amount0 is smaller than this
amount1Min	uint256	Revert if resulting amount1 is smaller than this
to	address	Recipient of tokens

Returns

Name	Type	Description
amount0	uint256	Amount of token0 sent to recipient
amount1	uint256	Amount of token1 sent to recipient

Events

Approval

Solidity

event Approval(address indexed owner, address indexed spender, uint256 value)

Parameters

Name	Type	Description
owner indexed	address	undefined
spender indexed	address	undefined
value	uint256	undefined

Transfer

Solidity

event Transfer(address indexed from, address indexed to, uint256 value)

Parameters

Name	Type	Description
from indexed	address	undefined
to indexed	address	undefined
value	uint256	undefined