Skip to main content

ForgeBaseLiquidityManager.sol

Methods

DEFAULT_ADMIN_ROLE()

Solidity

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

NameTypeDescription
_0bytes32undefined

STEER_FRACTION_OF_FEE()

Solidity

function STEER_FRACTION_OF_FEE() external view returns (uint256)
Details

Total fraction of fees going towards Steer (as opposed to going towards strategist)

Returns

NameTypeDescription
_0uint256undefined

TOTAL_FEE()

Fee info

Solidity

function TOTAL_FEE() external view returns (uint256)
Details

Fee rates, each multiplied by 10,000 (a TOTAL_FEE of 100 means a 1% cut of total uniswap fees)Total fraction of fees not going towards LPs, multiplied by 10,000

Returns

NameTypeDescription
_0uint256undefined

accruedSteerFees0()

Solidity

function accruedSteerFees0() external view returns (uint256)
Details

Fees currently owed to Steer

Returns

NameTypeDescription
_0uint256undefined

accruedSteerFees1()

Solidity

function accruedSteerFees1() external view returns (uint256)

Returns

NameTypeDescription
_0uint256undefined

accruedStrategistFees0()

Solidity

function accruedStrategistFees0() external view returns (uint256)
Details

Fees currently owed to strategist

Returns

NameTypeDescription
_0uint256undefined

accruedStrategistFees1()

Solidity

function accruedStrategistFees1() external view returns (uint256)

Returns

NameTypeDescription
_0uint256undefined

allowance(address,address)

Solidity

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

See {IERC20-allowance}.

Parameters

NameTypeDescription
owneraddressundefined
spenderaddressundefined

Returns

NameTypeDescription
_0uint256undefined

approve(address,uint256)

Solidity

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

See {IERC20-approve}. Requirements: - spender cannot be the zero address.

Parameters

NameTypeDescription
spenderaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

balanceOf(address)

Solidity

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

See {IERC20-balanceOf}.

Parameters

NameTypeDescription
accountaddressundefined

Returns

NameTypeDescription
_0uint256undefined

decimals()

Solidity

function decimals() external view returns (uint8)
Details

Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5,05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless {setupDecimals} is called. NOTE: This information is only used for _display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.

Returns

NameTypeDescription
_0uint8undefined

decreaseAllowance(address,uint256)

Solidity

function decreaseAllowance(address spender, uint256 subtractedValue) external nonpayable returns (bool)
Details

Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.

Parameters

NameTypeDescription
spenderaddressundefined
subtractedValueuint256undefined

Returns

NameTypeDescription
_0boolundefined

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 amount0Used, uint256 amount1Used)
Details

These tokens sit in the vault and are not used for liquidity on Uniswap until the next rebalance. function requirements: Either amount0Desired or amount1Desired must be > 0 or it will revert with 'CROSS'

Parameters

NameTypeDescription
amount0Desireduint256Max amount of token0 to deposit
amount1Desireduint256Max amount of token1 to deposit
amount0Minuint256Revert if resulting amount0Used is less than this
amount1Minuint256Revert if resulting amount1Used is less than this
toaddressRecipient of shares

Returns

NameTypeDescription
sharesuint256Number of shares minted
amount0Useduint256Amount of token0 deposited
amount1Useduint256Amount of token1 deposited

emergencyBurn(int24,int24,uint128)

Removes liquidity in case of emergency.

Solidity

function emergencyBurn(int24 tickLower, int24 tickUpper, uint128 liquidity) external nonpayable returns (uint256 amount0, uint256 amount1)

Parameters

NameTypeDescription
tickLowerint24undefined
tickUpperint24undefined
liquidityuint128undefined

Returns

NameTypeDescription
amount0uint256undefined
amount1uint256undefined

getRoleAdmin(bytes32)

Solidity

function getRoleAdmin(bytes32 role) external view returns (bytes32)
Details

Returns the admin role that controls role. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.

Parameters

NameTypeDescription
rolebytes32undefined

Returns

NameTypeDescription
_0bytes32undefined

getRoleMember(bytes32,uint256)

Solidity

function getRoleMember(bytes32 role, uint256 index) external view returns (address)
Details

Returns one of the accounts that have role. index must be a value between 0 and {getRoleMemberCount}, non-inclusive. Role bearers are not sorted in any particular way, and their ordering may change at any point. WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] for more information.

Parameters

NameTypeDescription
rolebytes32undefined
indexuint256undefined

Returns

NameTypeDescription
_0addressundefined

getRoleMemberCount(bytes32)

Solidity

function getRoleMemberCount(bytes32 role) external view returns (uint256)
Details

Returns the number of accounts that have role. Can be used together with {getRoleMember} to enumerate all bearers of a role.

Parameters

NameTypeDescription
rolebytes32undefined

Returns

NameTypeDescription
_0uint256undefined

getTotalAmounts()

Solidity

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

Returns

NameTypeDescription
_0uint256undefined
_1uint256undefined

grantRole(bytes32,address)

Solidity

function grantRole(bytes32 role, address account) external nonpayable
Details

Grants role to account. If account had not been already granted role, emits a {RoleGranted} event. Requirements: - the caller must have role's admin role.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

hasRole(bytes32,address)

Solidity

function hasRole(bytes32 role, address account) external view returns (bool)
Details

Returns true if account has been granted role.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

Returns

NameTypeDescription
_0boolundefined

increaseAllowance(address,uint256)

Solidity

function increaseAllowance(address spender, uint256 addedValue) external nonpayable returns (bool)
Details

Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.

Parameters

NameTypeDescription
spenderaddressundefined
addedValueuint256undefined

Returns

NameTypeDescription
_0boolundefined

initialize(address,address,address,bytes)

Solidity

function initialize(address _vaultManager, address, address _steer, bytes _params) external nonpayable
Details

Initializes vault

Parameters

NameTypeDescription
_vaultManageraddressis the address which will manage the vault being created, pass orchestrator address if the vault is meant to be managed by the orchestrator
_1addressundefined
_steeraddressThe steer multisig address, responsible for some governance functions.
_paramsbytesAll other parameters this vault will use

maxTickChange()

Solidity

function maxTickChange() external view returns (int24)
Details

For depositing Roughly corresponds to a 5% diff between current price and twap price

Returns

NameTypeDescription
_0int24undefined

name()

Solidity

function name() external view returns (string)
Details

Returns the name of the token.

Returns

NameTypeDescription
_0stringundefined

pause()

Solidity

function pause() external nonpayable
Details

Pause and unpause

paused()

Solidity

function paused() external view returns (bool)
Details

Returns true if the contract is paused, and false otherwise.

Returns

NameTypeDescription
_0boolundefined

poke()

Solidity

function poke() external nonpayable

pool()

Address of Uniswap V3 pool

Solidity

function pool() external view returns (contract IUniswapV3Pool)

Returns

NameTypeDescription
_0contract IUniswapV3Poolundefined

renounceRole(bytes32,address)

Solidity

function renounceRole(bytes32 role, address account) external nonpayable
Details

Revokes role from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been granted role, emits a {RoleRevoked} event. Requirements: - the caller must be account.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

revokeRole(bytes32,address)

Solidity

function revokeRole(bytes32 role, address account) external nonpayable
Details

Revokes role from account. If account had been granted role, emits a {RoleRevoked} event. Requirements: - the caller must have role's admin role.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

steerCollectFees(uint256,uint256,address)

Used to collect accumulated protocol fees.

Solidity

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

Parameters

NameTypeDescription
amount0uint256undefined
amount1uint256undefined
toaddressundefined

strategistCollectFees(uint256,uint256,address)

Used to collect accumulated protocol fees.

Solidity

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

Parameters

NameTypeDescription
amount0uint256undefined
amount1uint256undefined
toaddressundefined

supportsInterface(bytes4)

Used by periphery to verify vault is depositable.

Solidity

function supportsInterface(bytes4 interfaceId) external view returns (bool)

Parameters

NameTypeDescription
interfaceIdbytes4undefined

Returns

NameTypeDescription
_0boolundefined

symbol()

Solidity

function symbol() external view returns (string)
Details

Returns the symbol of the token, usually a shorter version of the name.

Returns

NameTypeDescription
_0stringundefined

token0()

Addresses of Token0 and Token1

Solidity

function token0() external view returns (contract IERC20)

Returns

NameTypeDescription
_0contract IERC20undefined

token1()

Solidity

function token1() external view returns (contract IERC20)

Returns

NameTypeDescription
_0contract IERC20undefined

totalSupply()

Solidity

function totalSupply() external view returns (uint256)
Details

See {IERC20-totalSupply}.

Returns

NameTypeDescription
_0uint256undefined

transfer(address,uint256)

Solidity

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

See {IERC20-transfer}. Requirements: - recipient cannot be the zero address. - the caller must have a balance of at least amount.

Parameters

NameTypeDescription
recipientaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

transferFrom(address,address,uint256)

Solidity

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

See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender and recipient cannot be the zero address. - sender must have a balance of at least amount. - the caller must have allowance for sender's tokens of at least amount.

Parameters

NameTypeDescription
senderaddressundefined
recipientaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

twapInterval()

Solidity

function twapInterval() external view returns (uint32)
Details

Number of seconds to get the time-weighted average over

Returns

NameTypeDescription
_0uint32undefined

uniswapV3MintCallback(uint256,uint256,bytes)

Solidity

function uniswapV3MintCallback(uint256 amount0, uint256 amount1, bytes) external nonpayable
Details

Callback for Uniswap V3 pool.

Parameters

NameTypeDescription
amount0uint256undefined
amount1uint256undefined
_2bytesundefined

uniswapV3SwapCallback(int256,int256,bytes)

Solidity

function uniswapV3SwapCallback(int256 amount0Wanted, int256 amount1Wanted, bytes) external nonpayable
Details

Callback for Uniswap V3 pool.

Parameters

NameTypeDescription
amount0Wantedint256undefined
amount1Wantedint256undefined
_2bytesundefined

unpause()

Solidity

function unpause() external nonpayable

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

NameTypeDescription
sharesuint256Shares burned by sender
amount0Minuint256Revert if resulting amount0 is smaller than this
amount1Minuint256Revert if resulting amount1 is smaller than this
toaddressRecipient of tokens

Returns

NameTypeDescription
amount0uint256Amount of token0 sent to recipient
amount1uint256Amount of token1 sent to recipient

Events

Approval

Solidity

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

Parameters

NameTypeDescription
owner indexedaddressundefined
spender indexedaddressundefined
valueuint256undefined

Deposit

Solidity

event Deposit(address indexed sender, address indexed to, uint256 shares, uint256 amount0, uint256 amount1)
Details

Deposit info

Parameters

NameTypeDescription
sender indexedaddressThe address which provided the tokens
to indexedaddressThe receiver of vault shares from this deposit, generally the same as sender
sharesuint256The number of shares that have been minted by this deposit
amount0uint256The amount of t0 that was used to mint the shares
amount1uint256The amount of t1 that was used to mint the shares

FeesEarned

Solidity

event FeesEarned(uint256 amount0Earned, uint256 amount1Earned)
Details

Info on protocol fees earned. Triggers whenever a withdraw or a tend happens.

Parameters

NameTypeDescription
amount0Earneduint256Total t0 fees earned, including fees going to steer and strategist.
amount1Earneduint256Total t1 fees earned, including fees going to steer and strategist.

Paused

Solidity

event Paused(address account)

Parameters

NameTypeDescription
accountaddressundefined

RoleAdminChanged

Solidity

event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)

Parameters

NameTypeDescription
role indexedbytes32undefined
previousAdminRole indexedbytes32undefined
newAdminRole indexedbytes32undefined

RoleGranted

Solidity

event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)

Parameters

NameTypeDescription
role indexedbytes32undefined
account indexedaddressundefined
sender indexedaddressundefined

RoleRevoked

Solidity

event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)

Parameters

NameTypeDescription
role indexedbytes32undefined
account indexedaddressundefined
sender indexedaddressundefined

Snapshot

Solidity

event Snapshot(uint160 sqrtPriceX96, uint256 totalAmount0, uint256 totalAmount1, uint256 totalSupply)
Details

Pool/vault info as of the end of a tend

Parameters

NameTypeDescription
sqrtPriceX96uint160Current pool price
totalAmount0uint256The total user-owned token0, including funds held in the vault and funds deposited into the pool
totalAmount1uint256undefined
totalSupplyuint256The total number of shares in this vault.

Transfer

Solidity

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

Parameters

NameTypeDescription
from indexedaddressundefined
to indexedaddressundefined
valueuint256undefined

Unpaused

Solidity

event Unpaused(address account)

Parameters

NameTypeDescription
accountaddressundefined

Withdraw

Solidity

event Withdraw(address indexed sender, address indexed to, uint256 shares, uint256 amount0, uint256 amount1)
Details

Withdraw info

Parameters

NameTypeDescription
sender indexedaddressmsg.sender and the owner of the shares being burned
to indexedaddressThe receiver of the tokens earned via the burn
sharesuint256The number of shares being burned
amount0uint256The amount of t0 earned via the burn
amount1uint256The amount of t1 earned via the burn