ForgeBaseLiquidityManager.sol

Methods

DEFAULT_ADMIN_ROLE()

Solidity

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

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

Name	Type	Description
_0	uint256	undefined

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

Name	Type	Description
_0	uint256	undefined

accruedSteerFees0()

Solidity

function accruedSteerFees0() external view returns (uint256)

Details

Fees currently owed to Steer

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)

Details

Fees currently owed to strategist

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

See {IERC20-allowance}.

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

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

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

See {IERC20-balanceOf}.

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

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

Name	Type	Description
_0	uint8	undefined

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

Name	Type	Description
spender	address	undefined
subtractedValue	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

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

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

Returns

Name	Type	Description
shares	uint256	Number of shares minted
amount0Used	uint256	Amount of token0 deposited
amount1Used	uint256	Amount 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

Name	Type	Description
tickLower	int24	undefined
tickUpper	int24	undefined
liquidity	uint128	undefined

Returns

Name	Type	Description
amount0	uint256	undefined
amount1	uint256	undefined

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

Name	Type	Description
role	bytes32	undefined

Returns

Name	Type	Description
_0	bytes32	undefined

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

Name	Type	Description
role	bytes32	undefined
index	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

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

Name	Type	Description
role	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

getTotalAmounts()

Solidity

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

Returns

Name	Type	Description
_0	uint256	undefined
_1	uint256	undefined

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

Name	Type	Description
role	bytes32	undefined
account	address	undefined

hasRole(bytes32,address)

Solidity

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

Details

Returns true if account has been granted role.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

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

Name	Type	Description
spender	address	undefined
addedValue	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

initialize(address,address,address,bytes)

Solidity

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

Details

Initializes vault

Parameters

Name	Type	Description
_vaultManager	address	is the address which will manage the vault being created, pass orchestrator address if the vault is meant to be managed by the orchestrator
_1	address	undefined
_steer	address	The steer multisig address, responsible for some governance functions.
_params	bytes	All 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

Name	Type	Description
_0	int24	undefined

name()

Solidity

function name() external view returns (string)

Details

Returns the name of the token.

Returns

Name	Type	Description
_0	string	undefined

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

Name	Type	Description
_0	bool	undefined

poke()

Solidity

function poke() external nonpayable

pool()

Address of Uniswap V3 pool

Solidity

function pool() external view returns (contract IUniswapV3Pool)

Returns

Name	Type	Description
_0	contract IUniswapV3Pool	undefined

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

Name	Type	Description
role	bytes32	undefined
account	address	undefined

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

Name	Type	Description
role	bytes32	undefined
account	address	undefined

steerCollectFees(uint256,uint256,address)

Used to collect accumulated protocol fees.

Solidity

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

Parameters

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

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

supportsInterface(bytes4)

Used by periphery to verify vault is depositable.

Solidity

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

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

symbol()

Solidity

function symbol() external view returns (string)

Details

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

Returns

Name	Type	Description
_0	string	undefined

token0()

Addresses of Token0 and Token1

Solidity

function token0() external view returns (contract IERC20)

Returns

Name	Type	Description
_0	contract IERC20	undefined

token1()

Solidity

function token1() external view returns (contract IERC20)

Returns

Name	Type	Description
_0	contract IERC20	undefined

totalSupply()

Solidity

function totalSupply() external view returns (uint256)

Details

See {IERC20-totalSupply}.

Returns

Name	Type	Description
_0	uint256	undefined

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

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

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

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

Returns

Name	Type	Description
_0	bool	undefined

twapInterval()

Solidity

function twapInterval() external view returns (uint32)

Details

Number of seconds to get the time-weighted average over

Returns

Name	Type	Description
_0	uint32	undefined

uniswapV3MintCallback(uint256,uint256,bytes)

Solidity

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

Details

Callback for Uniswap V3 pool.

Parameters

Name	Type	Description
amount0	uint256	undefined
amount1	uint256	undefined
_2	bytes	undefined

uniswapV3SwapCallback(int256,int256,bytes)

Solidity

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

Details

Callback for Uniswap V3 pool.

Parameters

Name	Type	Description
amount0Wanted	int256	undefined
amount1Wanted	int256	undefined
_2	bytes	undefined

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

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

Deposit

Solidity

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

Details

Deposit info

Parameters

Name	Type	Description
sender indexed	address	The address which provided the tokens
to indexed	address	The receiver of vault shares from this deposit, generally the same as sender
shares	uint256	The number of shares that have been minted by this deposit
amount0	uint256	The amount of t0 that was used to mint the shares
amount1	uint256	The 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

Name	Type	Description
amount0Earned	uint256	Total t0 fees earned, including fees going to steer and strategist.
amount1Earned	uint256	Total t1 fees earned, including fees going to steer and strategist.

Paused

Solidity

event Paused(address account)

Parameters

Name	Type	Description
account	address	undefined

RoleAdminChanged

Solidity

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

Parameters

Name	Type	Description
role indexed	bytes32	undefined
previousAdminRole indexed	bytes32	undefined
newAdminRole indexed	bytes32	undefined

RoleGranted

Solidity

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

Parameters

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined

RoleRevoked

Solidity

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

Parameters

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined

Snapshot

Solidity

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

Details

Pool/vault info as of the end of a tend

Parameters

Name	Type	Description
sqrtPriceX96	uint160	Current pool price
totalAmount0	uint256	The total user-owned token0, including funds held in the vault and funds deposited into the pool
totalAmount1	uint256	undefined
totalSupply	uint256	The total number of shares in this vault.

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

Unpaused

Solidity

event Unpaused(address account)

Parameters

Name	Type	Description
account	address	undefined

Withdraw

Solidity

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

Details

Withdraw info

Parameters

Name	Type	Description
sender indexed	address	msg.sender and the owner of the shares being burned
to indexed	address	The receiver of the tokens earned via the burn
shares	uint256	The number of shares being burned
amount0	uint256	The amount of t0 earned via the burn
amount1	uint256	The amount of t1 earned via the burn