V4PositionPlanner

@uniswap/v4-sdk / V4PositionPlanner

Defined in: utils/v4PositionPlanner.ts:8

Extends

• V4Planner

Constructors

new V4PositionPlanner()

new V4PositionPlanner(): V4PositionPlanner

Defined in: utils/v4Planner.ts:171

Returns

V4PositionPlanner

Inherited from

V4Planner.constructor

Properties

actions

actions: string

Defined in: utils/v4Planner.ts:168

Inherited from

V4Planner.actions

---

params

params: string[]

Defined in: utils/v4Planner.ts:169

Inherited from

V4Planner.params

Methods

addAction()

addAction(type, parameters): V4Planner

Defined in: utils/v4Planner.ts:176

Parameters

Parameter	Type
type	Actions
parameters	any[]

Returns

V4Planner

Inherited from

V4Planner.addAction

---

addBurn()

addBurn(tokenId, amount0Min, amount1Min, hookData): void

Defined in: utils/v4PositionPlanner.ts:58

Parameters

Parameter	Type	Default value
tokenId	BigintIsh	undefined
amount0Min	BigintIsh	undefined
amount1Min	BigintIsh	undefined
hookData	string	EMPTY_BYTES

Returns

void

---

addDecrease()

addDecrease(tokenId, liquidity, amount0Min, amount1Min, hookData): void

Defined in: utils/v4PositionPlanner.ts:46

Parameters

Parameter	Type	Default value
tokenId	BigintIsh	undefined
liquidity	BigintIsh	undefined
amount0Min	BigintIsh	undefined
amount1Min	BigintIsh	undefined
hookData	string	EMPTY_BYTES

Returns

void

---

addIncrease()

addIncrease(tokenId, liquidity, amount0Max, amount1Max, hookData): void

Defined in: utils/v4PositionPlanner.ts:34

Parameters

Parameter	Type	Default value
tokenId	BigintIsh	undefined
liquidity	BigintIsh	undefined
amount0Max	BigintIsh	undefined
amount1Max	BigintIsh	undefined
hookData	string	EMPTY_BYTES

Returns

void

---

addMint()

addMint(pool, tickLower, tickUpper, liquidity, amount0Max, amount1Max, owner, hookData): void

Defined in: utils/v4PositionPlanner.ts:10

Parameters

Parameter	Type	Default value
pool	Pool	undefined
tickLower	number	undefined
tickUpper	number	undefined
liquidity	BigintIsh	undefined
amount0Max	BigintIsh	undefined
amount1Max	BigintIsh	undefined
owner	string	undefined
hookData	string	EMPTY_BYTES

Returns

void

---

addSettle()

addSettle(currency, payerIsUser, amount?): V4Planner

Defined in: utils/v4Planner.ts:213

Parameters

Parameter	Type
currency	Currency
payerIsUser	boolean
amount?	BigNumber

Returns

V4Planner

Inherited from

V4Planner.addSettle

---

addSettlePair()

addSettlePair(currency0, currency1): void

Defined in: utils/v4PositionPlanner.ts:64

Parameters

Parameter	Type
currency0	Currency
currency1	Currency

Returns

void

---

addSweep()

addSweep(currency, to): void

Defined in: utils/v4PositionPlanner.ts:76

Parameters

Parameter	Type
currency	Currency
to	string

Returns

void

---

addTake()

addTake(currency, recipient, amount?): V4Planner

Defined in: utils/v4Planner.ts:218

Parameters

Parameter	Type
currency	Currency
recipient	string
amount?	BigNumber

Returns

V4Planner

Inherited from

V4Planner.addTake

---

addTakePair()

addTakePair(currency0, currency1, recipient): void

Defined in: utils/v4PositionPlanner.ts:70

Parameters

Parameter	Type
currency0	Currency
currency1	Currency
recipient	string

Returns

void

---

addTrade()

addTrade(trade, slippageTolerance?): V4Planner

Defined in: utils/v4Planner.ts:183

Parameters

Parameter	Type
trade	Trade<Currency, Currency, TradeType>
slippageTolerance?	Percent

Returns

V4Planner

Inherited from

V4Planner.addTrade

---

finalize()

finalize(): string

Defined in: utils/v4Planner.ts:224

Returns

string

Inherited from

V4Planner.finalize