Overview
Table of contents
Enumerations
Classes
- FullMath
- LiquidityMath
- Multicall
- NoTickDataProvider
- NonfungiblePositionManager
- Payments
- Pool
- Position
- PositionLibrary
- Route
- SelfPermit
- SqrtPriceMath
- Staker
- SwapMath
- SwapQuoter
- SwapRouter
- Tick
- TickLibrary
- TickList
- TickListDataProvider
- TickMath
- Trade
Interfaces
- AllowedPermitArguments
- BestTradeOptions
- ClaimOptions
- CollectOptions
- CommonAddLiquidityOptions
- FeeOptions
- IncentiveKey
- IncreaseSpecificOptions
- MethodParameters
- MintSpecificOptions
- NFTPermitOptions
- QuoteOptions
- RemoveLiquidityOptions
- SafeTransferOptions
- StandardPermitArguments
- SwapOptions
- TickConstructorArgs
- TickDataProvider
- WithdrawOptions
Type Aliases
Variables
Functions
- computePoolAddress
- encodeRouteToPath
- encodeSqrtRatioX96
- isSorted
- maxLiquidityForAmounts
- mostSignificantBit
- nearestUsableTick
- priceToClosestTick
- subIn256
- tickToPrice
- toHex
- tradeComparator
Type Aliases
AddLiquidityOptions
Ƭ AddLiquidityOptions: MintOptions
| IncreaseOptions
Defined in
nonfungiblePositionManager.ts:77
FullWithdrawOptions
Ƭ FullWithdrawOptions: ClaimOptions
& WithdrawOptions
Defined in
IncreaseOptions
Ƭ IncreaseOptions: CommonAddLiquidityOptions
& IncreaseSpecificOptions
Defined in
nonfungiblePositionManager.ts:75
MintOptions
Ƭ MintOptions: CommonAddLiquidityOptions
& MintSpecificOptions
Defined in
nonfungiblePositionManager.ts:74
PermitOptions
Ƭ PermitOptions: StandardPermitArguments
| AllowedPermitArguments
Defined in
Variables
ADDRESS_ZERO
• Const
ADDRESS_ZERO: "0x0000000000000000000000000000000000000000"
Defined in
FACTORY_ADDRESS
• Const
FACTORY_ADDRESS: "0xeAa20BEA58979386A7d37BAeb4C1522892c74640"
Defined in
POOL_INIT_CODE_HASH
• Const
POOL_INIT_CODE_HASH: "0x4a995152ad4a45ce61f15e514146bc642453130f5c3ef14b85098e9c6266c43d"
Defined in
TICK_SPACINGS
• Const
TICK_SPACINGS: { [amount in FeeAmount]: number }
The default factory tick spacings by fee amount.
Defined in
Functions
computePoolAddress
▸ computePoolAddress(__namedParameters
): string
Computes a pool address
Parameters
Name | Type |
---|---|
__namedParameters | Object |
__namedParameters.factoryAddress | string |
__namedParameters.fee | FeeAmount |
__namedParameters.initCodeHashManualOverride? | string |
__namedParameters.tokenA | Token |
__namedParameters.tokenB | Token |
Returns
string
The pool address
Defined in
utils/computePoolAddress.ts:16
encodeRouteToPath
▸ encodeRouteToPath(route
, exactOutput
): string
Converts a route to a hex encoded path
Parameters
Name | Type | Description |
---|---|---|
route | Route <Currency , Currency > | the v3 path to convert to an encoded path |
exactOutput | boolean | whether the route should be encoded in reverse, for making exact output swaps |
Returns
string
Defined in
encodeSqrtRatioX96
▸ encodeSqrtRatioX96(amount1
, amount0
): JSBI
Returns the sqrt ratio as a Q64.96 corresponding to a given ratio of amount1 and amount0
Parameters
Name | Type | Description |
---|---|---|
amount1 | BigintIsh | The numerator amount i.e., the amount of token1 |
amount0 | BigintIsh | The denominator amount i.e., the amount of token0 |
Returns
JSBI
The sqrt ratio
Defined in
utils/encodeSqrtRatioX96.ts:11
isSorted
▸ isSorted<T
>(list
, comparator
): boolean
Determines if a tick list is sorted
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
list | T [] | The tick list |
comparator | (a : T , b : T ) => number | The comparator |
Returns
boolean
true if sorted
Defined in
maxLiquidityForAmounts
▸ maxLiquidityForAmounts(sqrtRatioCurrentX96
, sqrtRatioAX96
, sqrtRatioBX96
, amount0
, amount1
, useFullPrecision
): JSBI
Computes the maximum amount of liquidity received for a given amount of token0, token1, and the prices at the tick boundaries.
Parameters
Name | Type | Description |
---|---|---|
sqrtRatioCurrentX96 | default | the current price |
sqrtRatioAX96 | default | price at lower boundary |
sqrtRatioBX96 | default | price at upper boundary |
amount0 | BigintIsh | token0 amount |
amount1 | BigintIsh | token1 amount |
useFullPrecision | boolean | if false, liquidity will be maximized according to what the router can calculate, not what core can theoretically support |
Returns
JSBI
Defined in
utils/maxLiquidityForAmounts.ts:68
mostSignificantBit
▸ mostSignificantBit(x
): number
Parameters
Name | Type |
---|---|
x | default |
Returns
number
Defined in
utils/mostSignificantBit.ts:12
nearestUsableTick
▸ nearestUsableTick(tick
, tickSpacing
): number
Returns the closest tick that is nearest a given tick and usable for the given tick spacing
Parameters
Name | Type | Description |
---|---|---|
tick | number | the target tick |
tickSpacing | number | the spacing of the pool |
Returns
number
Defined in
priceToClosestTick
▸ priceToClosestTick(price
): number
Returns the first tick for which the given price is greater than or equal to the tick price
Parameters
Name | Type | Description |
---|---|---|
price | Price <Token , Token > | for which to return the closest tick that represents a price less than or equal to the input price, i.e. the price of the returned tick is less than or equal to the input price |
Returns
number
Defined in
utils/priceTickConversions.ts:29
subIn256
▸ subIn256(x
, y
): JSBI
Parameters
Name | Type |
---|---|
x | default |
y | default |
Returns
JSBI
Defined in
tickToPrice
▸ tickToPrice(baseToken
, quoteToken
, tick
): Price
<Token
, Token
>
Returns a price object corresponding to the input tick and the base/quote token Inputs must be tokens because the address order is used to interpret the price represented by the tick
Parameters
Name | Type | Description |
---|---|---|
baseToken | Token | the base token of the price |
quoteToken | Token | the quote token of the price |
tick | number | the tick for which to return the price |
Returns
Price
<Token
, Token
>
Defined in
utils/priceTickConversions.ts:14
toHex
▸ toHex(bigintIsh
): string
Converts a big int to a hex string
Parameters
Name | Type |
---|---|
bigintIsh | BigintIsh |
Returns
string
The hex encoded calldata
Defined in
tradeComparator
▸ tradeComparator<TInput
, TOutput
, TTradeType
>(a
, b
): number
Trades comparator, an extension of the input output comparator that also considers other dimensions of the trade in ranking them
Type parameters
Name | Type | Description |
---|---|---|
TInput | extends Currency | The input token, either Ether or an ERC-20 |
TOutput | extends Currency | The output token, either Ether or an ERC-20 |
TTradeType | extends TradeType | The trade type, either exact input or exact output |
Parameters
Name | Type | Description |
---|---|---|
a | Trade <TInput , TOutput , TTradeType > | The first trade to compare |
b | Trade <TInput , TOutput , TTradeType > | The second trade to compare |
Returns
number
A sorted ordering for two neighboring elements in a trade array