Arrakis Developer Docs
Search
⌃K
Comment on page

ArrakisV2Helper

Helper contract for querying common information about ArrakisV2 vaults

Constant/Immutable Properties

name
type
description
factory
address
UniswapV3Factory contract address

External Functions

totalUnderlying

inspect the total amount of token0 and token1 underlying all the ArrakisV2 vault shares in circulation. The total underlying always includes any token0/token1 that is:
  1. 1.
    Tokens sitting idle in the vault contract
  2. 2.
    Tokens invested as liquidity in UniswapV3 positions
  3. 3.
    Uncollected fees from any UniswapV3 positions

parameters :

name
type
description
vault
address
ArrakisV2 vault address

returns :

name
type
description
amount0
uint256
Total amount of token0 underlying vault shares
amount1
uint256
Total amount of token1 underlying vault shares

totalUnderlyingWithFees

Same as totalUnderlying with additional return values fee0 and fee1 which denote the portion of total underlying that comes from current uncollected fees.

parameters :

name
type
description
vault
address
ArrakisV2 vault address

returns :

name
type
description
amount0
uint256
Total amount of token0 underlying vault shares
amount1
uint256
Total amount of token1 underlying vault shares
fee0
uint256
Total amount of uncollected uniswap fees in token0
fee1
uint256
Total amount of uncollected uniswap fees in token1

totalUnderlyingWithFeesAndLeftover

Same as totalUnderlyingWithFees with additional return values leftover0 and leftover1 which denote the portion of total underlying which is sitting idle in vault contract balance.

parameters :

name
type
description
vault
address
ArrakisV2 vault address

returns :

name
type
description
underlying
UnderlyingOutput
struct with totalUnderlying, fee, and leftover information

totalLiquidity

abc

parameters :

name
type
description
vault
address
ArrakisV2 vault address

returns :

name
type
description
liquidities
PositionLiquidity[]
ranges with liquidity amounts

token0AndToken1ByRange

returns breakdown of token holdings by liquidity position

parameters :

name
type
description
vault
address
ArrakisV2 vault address

returns :

name
type
description
amount0s
Amount[]
amount token0 per range
amount1s
Amount[]
amount token1 per range

token0AndToken1PlusFeesByRange

returns breakdown of token holdings by liquidity position, and uncollected fees by liquidity position

parameters :

name
type
description
vault
address
ArrakisV2 vault address

returns :

name
type
description
amount0s
Amount[]
amount token0 per range
amount1s
Amount[]
amount token1 per range
fee0s
Amount[]
uncollected fee amount token0 per range
fee1s
Amount[]
uncollected fee amount token1 per range
Arrakis V2 Core - Previous
ArrakisV2Resolver
Next - Arrakis V2 Core
Contract Addresses
Last modified 9mo ago