pool.gno

gnoswap/contract/r/gnoswap/pool/v1/pool.gno at d9d34bd345a36c3eedaccf491c6615b0ac4168cd · gnoswap-labs/gnoswapGitHub

gnoswap/contract/r/gnoswap/pool/pool.gno at d9d34bd345a36c3eedaccf491c6615b0ac4168cd · gnoswap-labs/gnoswapGitHub

Burn

func Burn(
	cur realm,
	token0Path string,
	token1Path string,
	fee uint32,
	tickLower int32,
	tickUpper int32,
	liquidityAmount string,
	positionCaller address
) (string, string)

Burn removes liquidity from a position.

Halt check: reverts while the Withdraw halt scope is active.

Parameters

Name	Type	Description
cur	realm	Current realm context; callers use cross(cur) when crossing into this realm.
token0Path	string	Path of the first token in the pool pair.
token1Path	string	Path of the second token in the pool pair.
fee	uint32	Fee tier identifying the pool.
tickLower	int32	Lower inclusive tick boundary of the position range.
tickUpper	int32	Upper exclusive tick boundary of the position range.
liquidityAmount	string	Decimal liquidity amount to remove from the position.
positionCaller	address	Position-contract address whose position is decreased.

Return Values

Name	Type	Description
amount0	string	Token0 principal credited to the position, as a decimal string; the pool operation leaves it owed until a subsequent collection.
amount1	string	Token1 principal credited to the position, as a decimal string; the pool operation leaves it owed until a subsequent collection.

source

Collect

func Collect(
	cur realm,
	token0Path string,
	token1Path string,
	fee uint32,
	recipient address,
	tickLower int32,
	tickUpper int32,
	amount0Requested string,
	amount1Requested string
) (string, string)

Collect pays tokens owed to a position out to recipient in full. No withdrawal fee is charged on this path; see CollectSwapFee for the fee-bearing path.

Halt check: reverts while the Withdraw halt scope is active.

Parameters

Name	Type	Description
cur	realm	Current realm context; callers use cross(cur) when crossing into this realm.
token0Path	string	Path of the first token in the pool pair.
token1Path	string	Path of the second token in the pool pair.
fee	uint32	Fee tier identifying the pool.
recipient	address	Non-zero address receiving the owed token amounts.
tickLower	int32	Lower inclusive tick boundary of the position range.
tickUpper	int32	Upper exclusive tick boundary of the position range.
amount0Requested	string	Decimal token0 amount requested from the position's accrued principal.
amount1Requested	string	Decimal token1 amount requested from the position's accrued principal.

Return Values

Name	Type	Description
amount0	string	Token0 principal transferred to recipient, as a decimal string.
amount1	string	Token1 principal transferred to recipient, as a decimal string.

source

CollectProtocol

func CollectProtocol(
	cur realm,
	token0Path string,
	token1Path string,
	fee uint32,
	recipient address,
	amount0Requested string,
	amount1Requested string
) (string, string)

CollectProtocol collects protocol fees from a pool.

Halt check: reverts while the Withdraw halt scope is active.

Parameters

Name	Type	Description
cur	realm	Current realm context; callers use cross(cur) when crossing into this realm.
token0Path	string	Path of the first token in the pool pair.
token1Path	string	Path of the second token in the pool pair.
fee	uint32	Fee tier identifying the pool.
recipient	address	Address receiving the collected protocol fees.
amount0Requested	string	Decimal token0 protocol-fee amount requested; collection is capped at the available amount.
amount1Requested	string	Decimal token1 protocol-fee amount requested; collection is capped at the available amount.

Return Values

Name	Type	Description
amount0	string	Token0 protocol fee transferred to recipient, as a decimal string.
amount1	string	Token1 protocol fee transferred to recipient, as a decimal string.

source

CollectSwapFee

func CollectSwapFee(
	cur realm,
	token0Path string,
	token1Path string,
	fee uint32,
	recipient address,
	tickLower int32,
	tickUpper int32,
	amount0Requested string,
	amount1Requested string
) (amount0 string, amount1 string, fee0 string, fee1 string)

CollectSwapFee pays accrued swap fees for a position out to recipient, net of the withdrawal fee.

Halt check: reverts while the Withdraw halt scope is active.

Parameters

Name	Type	Description
cur	realm	Current realm context; callers use cross(cur) when crossing into this realm.
token0Path	string	Path of the first token in the pool pair.
token1Path	string	Path of the second token in the pool pair.
fee	uint32	Fee tier identifying the pool.
recipient	address	Non-zero address receiving the collected token amounts after withdrawal-fee deduction.
tickLower	int32	Lower inclusive tick boundary of the position range.
tickUpper	int32	Upper exclusive tick boundary of the position range.
amount0Requested	string	Decimal token0 amount requested; the configured maximum value requests all token0 fees owed.
amount1Requested	string	Decimal token1 amount requested; the configured maximum value requests all token1 fees owed.

Return Values

Name	Type	Description
amount0	string	Collected token0 amount before withdrawal-fee deduction, as a decimal string.
amount1	string	Collected token1 amount before withdrawal-fee deduction, as a decimal string.
fee0	string	Withdrawal fee withheld from token0, as a decimal string.
fee1	string	Withdrawal fee withheld from token1, as a decimal string.

source

IncreaseObservationCardinalityNext

func IncreaseObservationCardinalityNext(
	cur realm,
	token0Path string,
	token1Path string,
	fee uint32,
	cardinalityNext uint16
)

IncreaseObservationCardinalityNext increases the observation cardinality for a pool.

Halt check: reverts while the Pool halt scope is active.

Parameters

Name	Type	Description
cur	realm	Current realm context; callers use cross(cur) when crossing into this realm.
token0Path	string	Path of the first token in the pool pair.
token1Path	string	Path of the second token in the pool pair.
fee	uint32	Fee tier identifying the pool.
cardinalityNext	uint16	Requested maximum number of oracle observations retained for the pool.

source

Mint

func Mint(
	cur realm,
	token0Path string,
	token1Path string,
	fee uint32,
	tickLower int32,
	tickUpper int32,
	liquidityAmount string,
	positionCaller address
) (string, string)

Mint adds liquidity to a position.

Halt check: reverts while the Pool halt scope is active.

Parameters

Name	Type	Description
cur	realm	Current realm context; callers use cross(cur) when crossing into this realm.
token0Path	string	Path of the first token in the pool pair.
token1Path	string	Path of the second token in the pool pair.
fee	uint32	Fee tier identifying the pool.
tickLower	int32	Lower inclusive tick boundary of the position range.
tickUpper	int32	Upper exclusive tick boundary of the position range.
liquidityAmount	string	Decimal liquidity amount to add to the position.
positionCaller	address	Position-contract address whose position receives the liquidity.

Return Values

Name	Type	Description
amount0	string	Token0 amount required for the liquidity addition, as a decimal string.
amount1	string	Token1 amount required for the liquidity addition, as a decimal string.

source

NewDefaultFeeAmountTickSpacing

func NewDefaultFeeAmountTickSpacing() map[uint32]int32

NewDefaultFeeAmountTickSpacing returns the default tick spacing for each supported fee tier.

Return Values

Name	Type	Description
map[uint32]int32	map[uint32]int32	fee-tier to tick-spacing mapping for 100, 500, 3000, and 10000 tiers.

source

NewPoolPositionsTree

func NewPoolPositionsTree() *bptree.BPTree

NewPoolPositionsTree creates a BPTree for storing pool position info (fanout 16), owned by the pool domain realm so leaf-slot writes are not readonly tainted.

Return Values

Name	Type	Description
*bptree.BPTree	*bptree.BPTree	empty position storage tree with fanout 16.

source

NewPoolTicksTree

func NewPoolTicksTree() *bptree.BPTree

NewPoolTicksTree creates a BPTree for storing pool tick info (fanout 32), owned by the pool domain realm so leaf-slot writes are not readonly tainted.

Return Values

Name	Type	Description
*bptree.BPTree	*bptree.BPTree	empty tick storage tree with fanout 32.

source

NewPoolsTree

func NewPoolsTree() *bptree.BPTree

NewPoolsTree creates the BPTree used to store pools by pool path.

Return Values

Name	Type	Description
*bptree.BPTree	*bptree.BPTree	empty pool storage tree with fanout 32.

source

Types

Pool

type Pool struct

Pool describes a single pool's state. A pool is identified with a unique key (token0, token1, fee), where token0 < token1.

source

Methods

BalanceToken0

func (p *Pool) BalanceToken0() int64

BalanceToken0 returns the pool's current token0 balance.

Return Values

Name	Type	Description
int64	int64	token0 balance available in the pool.

source

BalanceToken1

func (p *Pool) BalanceToken1() int64

BalanceToken1 returns the pool's current token1 balance.

Return Values

Name	Type	Description
int64	int64	token1 balance available in the pool.

source

Balances

func (p *Pool) Balances() TokenPair

Balances returns the pool's current token balances.

Return Values

Name	Type	Description
TokenPair	TokenPair	token0 and token1 balances tracked by the pool.

source

Clone

func (p *Pool) Clone() *Pool

Clone copies a pool's own fields and leaves its collections nil: ticks, tickBitmaps, and positions are not copied. Oracle observations are stored separately from Pool.

The copy is shallow because the read-only pool view clones every entry a caller reads, so copying the collections would walk the whole tick tree for each entry on a page. Read them through their own lookups instead: GetTickInfo / GetInitializedTicksInRange for ticks, GetTickBitmaps for the bitmaps, GetPoolPositions for positions, and GetSlot0 / GetObservationAt for oracle metadata and entries. A caller that needs a working copy of a collection -- DrySwap is the only one -- assembles it from those getters.

Return Values

Name	Type	Description
*Pool	*Pool	shallow pool copy with scalar state and cloned numeric values; nil when the receiver is nil.

source

DeleteTick

func (p *Pool) DeleteTick(
	tick int32
)

DeleteTick removes the tick state for the given tick index.

Parameters

Name	Type	Description
tick	int32	tick index to remove.

source

DeleteTickBitmap

func (p *Pool) DeleteTickBitmap(
	wordPos int16
)

DeleteTickBitmap deletes the tick bitmap for the given word position.

Parameters

Name	Type	Description
wordPos	int16	signed bitmap word position to remove.

source

Fee

func (p *Pool) Fee() uint32

Fee returns the pool's fee tier.

Return Values

Name	Type	Description
uint32	uint32	fee tier used by swaps in this pool.

source

FeeGrowthGlobal0X128

func (p *Pool) FeeGrowthGlobal0X128() *u256.Uint

FeeGrowthGlobal0X128 returns cumulative token0 fee growth per unit of liquidity.

Return Values

Name	Type	Description
*u256.Uint	*u256.Uint	token0 fee-growth accumulator scaled by 2^128.

source

FeeGrowthGlobal1X128

func (p *Pool) FeeGrowthGlobal1X128() *u256.Uint

FeeGrowthGlobal1X128 returns cumulative token1 fee growth per unit of liquidity.

Return Values

Name	Type	Description
*u256.Uint	*u256.Uint	token1 fee-growth accumulator scaled by 2^128.

source

GetPosition

func (p *Pool) GetPosition(
	key string
) (PositionInfo, error)

GetPosition returns the position information for key.

Parameters

Name	Type	Description
key	string	encoded lower/upper tick-range key to look up.

Return Values

Name	Type	Description
PositionInfo	PositionInfo	stored aggregate position for the key.
error	error	non-nil when the key is absent or contains a value of the wrong type.

source

GetTick

func (p *Pool) GetTick(
	tick int32
) (TickInfo, error)

GetTick returns the state stored for a tick.

Parameters

Name	Type	Description
tick	int32	tick index to look up.

Return Values

Name	Type	Description
TickInfo	TickInfo	stored tick state.
error	error	non-nil when the tick is absent; a present value of the wrong type causes a panic.

source

HasTick

func (p *Pool) HasTick(
	tick int32
) bool

HasTick reports whether a tick entry exists in the pool's tick tree.

Parameters

Name	Type	Description
tick	int32	tick index to check.

Return Values

Name	Type	Description
bool	bool	true when the encoded tick is present; false otherwise.

source

IterateTicks

func (p *Pool) IterateTicks(
	startTick int32,
	endTick int32,
	fn func(int32, TickInfo) bool
)

IterateTicks visits pool ticks in the inclusive range [startTick, endTick]. Iteration stops when the callback returns true.

Parameters

Name	Type	Description
startTick	int32	first tick index in the inclusive range.
endTick	int32	last tick index in the inclusive range.
fn	func(int32, TickInfo) bool	callback receiving each decoded tick and its state; return true to stop iteration.

source

Liquidity

func (p *Pool) Liquidity() *u256.Uint

Liquidity returns the pool's active liquidity for the current tick range.

Return Values

Name	Type	Description
*u256.Uint	*u256.Uint	active liquidity amount.

source

PoolPath

func (p *Pool) PoolPath() string

Pool Getters methods PoolPath returns the canonical pool path derived from token0, token1, and the fee tier.

Return Values

Name	Type	Description
string	string	pool identifier assembled from the pool's token paths and fee.

source

Positions

func (p *Pool) Positions() *bptree.BPTree

Positions returns the tree containing aggregate position state by range key.

Return Values

Name	Type	Description
*bptree.BPTree	*bptree.BPTree	pool position storage tree.

source

ProtocolFees

func (p *Pool) ProtocolFees() TokenPair

ProtocolFees returns protocol fees accrued in both pool tokens.

Return Values

Name	Type	Description
TokenPair	TokenPair	token0 and token1 protocol-fee balances.

source

ProtocolFeesToken0

func (p *Pool) ProtocolFeesToken0() int64

ProtocolFeesToken0 returns protocol fees accrued in token0.

Return Values

Name	Type	Description
int64	int64	token0 amount reserved as protocol fees.

source

ProtocolFeesToken1

func (p *Pool) ProtocolFeesToken1() int64

ProtocolFeesToken1 returns protocol fees accrued in token1.

Return Values

Name	Type	Description
int64	int64	token1 amount reserved as protocol fees.

source

SetBalanceToken0

func (p *Pool) SetBalanceToken0(
	token0 int64
)

SetBalanceToken0 updates the pool's tracked token0 balance.

Parameters

Name	Type	Description
token0	int64	new token0 balance.

source

SetBalanceToken1

func (p *Pool) SetBalanceToken1(
	token1 int64
)

SetBalanceToken1 updates the pool's tracked token1 balance.

Parameters

Name	Type	Description
token1	int64	new token1 balance.

source

SetBalances

func (p *Pool) SetBalances(
	balances TokenPair
)

SetBalances replaces the pool's tracked balances for both tokens.

Parameters

Name	Type	Description
balances	TokenPair	token0 and token1 balances to store.

source

SetFee

func (p *Pool) SetFee(
	fee uint32
)

SetFee stores the pool's fee tier.

Parameters

Name	Type	Description
fee	uint32	fee tier to use for swaps in this pool.

source

SetFeeGrowthGlobal0X128

func (p *Pool) SetFeeGrowthGlobal0X128(
	feeGrowthGlobal0X128 *u256.Uint
)

SetFeeGrowthGlobal0X128 stores the token0 fee-growth accumulator.

Parameters

Name	Type	Description
feeGrowthGlobal0X128	*u256.Uint	token0 fee growth per liquidity unit, scaled by 2^128.

source

SetFeeGrowthGlobal1X128

func (p *Pool) SetFeeGrowthGlobal1X128(
	feeGrowthGlobal1X128 *u256.Uint
)

SetFeeGrowthGlobal1X128 stores the token1 fee-growth accumulator.

Parameters

Name	Type	Description
feeGrowthGlobal1X128	*u256.Uint	token1 fee growth per liquidity unit, scaled by 2^128.

source

SetLiquidity

func (p *Pool) SetLiquidity(
	liquidity *u256.Uint
)

SetLiquidity stores the pool's active liquidity for the current tick range.

Parameters

Name	Type	Description
liquidity	*u256.Uint	active liquidity amount to store.

source

SetPosition

func (p *Pool) SetPosition(
	posKey string,
	positionInfo PositionInfo
)

SetPosition stores position information under an encoded range key.

Parameters

Name	Type	Description
posKey	string	encoded lower/upper tick-range key.
positionInfo	PositionInfo	aggregate position state to store.

source

SetPositions

func (p *Pool) SetPositions(
	positions *bptree.BPTree
)

SetPositions replaces the tree containing aggregate position state.

Parameters

Name	Type	Description
positions	*bptree.BPTree	position storage tree to use.

source

SetProtocolFees

func (p *Pool) SetProtocolFees(
	protocolFees TokenPair
)

SetProtocolFees replaces the pool's accrued protocol fees for both tokens.

Parameters

Name	Type	Description
protocolFees	TokenPair	token0 and token1 protocol-fee balances to store.

source

SetProtocolFeesToken0

func (p *Pool) SetProtocolFeesToken0(
	token0 int64
)

SetProtocolFeesToken0 updates the pool's accrued token0 protocol fees.

Parameters

Name	Type	Description
token0	int64	new token0 protocol-fee balance.

source

SetProtocolFeesToken1

func (p *Pool) SetProtocolFeesToken1(
	token1 int64
)

SetProtocolFeesToken1 updates the pool's accrued token1 protocol fees.

Parameters

Name	Type	Description
token1	int64	new token1 protocol-fee balance.

source

SetSlot0

func (p *Pool) SetSlot0(
	slot0 Slot0
)

SetSlot0 replaces the pool's current price, tick, lock, and oracle cursor state.

Parameters

Name	Type	Description
slot0	Slot0	slot0 state to store.

source

SetTick

func (p *Pool) SetTick(
	tick int32,
	tickInfo TickInfo
)

SetTick stores tick state under its encoded tick key.

Parameters

Name	Type	Description
tick	int32	tick index to store.
tickInfo	TickInfo	tick state associated with the index.

source

SetTickBitmap

func (p *Pool) SetTickBitmap(
	wordPos int16,
	tickBitmap string
)

SetTickBitmap stores one initialized-tick bitmap word.

Parameters

Name	Type	Description
wordPos	int16	signed bitmap word position.
tickBitmap	string	encoded bitmap bits for that word.

source

SetTickBitmaps

func (p *Pool) SetTickBitmaps(
	tickBitmaps map[int16]string
)

SetTickBitmaps replaces the map of initialized-tick bitmap words.

Parameters

Name	Type	Description
tickBitmaps	map[int16]string	bitmap words keyed by signed word position.

source

SetTickSpacing

func (p *Pool) SetTickSpacing(
	tickSpacing int32
)

SetTickSpacing stores the permitted spacing between initialized ticks.

Parameters

Name	Type	Description
tickSpacing	int32	tick spacing to configure for the pool.

source

SetTicks

func (p *Pool) SetTicks(
	ticks *bptree.BPTree
)

SetTicks replaces the tree containing pool tick state.

Parameters

Name	Type	Description
ticks	*bptree.BPTree	tick storage tree to use.

source

SetToken0Path

func (p *Pool) SetToken0Path(
	token0Path string
)

Pool Setters methods SetToken0Path stores the path of the pool's token0 asset.

Parameters

Name	Type	Description
token0Path	string	token0 asset path to store.

source

SetToken1Path

func (p *Pool) SetToken1Path(
	token1Path string
)

SetToken1Path stores the path of the pool's token1 asset.

Parameters

Name	Type	Description
token1Path	string	token1 asset path to store.

source

Slot0

func (p *Pool) Slot0() Slot0

Slot0 returns the pool's current price, tick, lock, and oracle cursor state.

Return Values

Name	Type	Description
Slot0	Slot0	current slot0 state, including the price and observation metadata.

source

Slot0FeeProtocol

func (p *Pool) Slot0FeeProtocol() uint8

Slot0FeeProtocol returns the packed protocol-fee denominators from slot0.

Return Values

Name	Type	Description
uint8	uint8	packed token0/token1 protocol-fee denominator configuration.

source

Slot0SqrtPriceX96

func (p *Pool) Slot0SqrtPriceX96() *u256.Uint

Slot0SqrtPriceX96 returns the current square-root price in Q96 fixed-point form.

Return Values

Name	Type	Description
*u256.Uint	*u256.Uint	stored sqrt(token1/token0) price scaled by 2^96.

source

Slot0Tick

func (p *Pool) Slot0Tick() int32

Slot0Tick returns the current pool tick.

Return Values

Name	Type	Description
int32	int32	tick corresponding to the current pool price.

source

Slot0Unlocked

func (p *Pool) Slot0Unlocked() bool

Slot0Unlocked reports whether the pool is currently available for reentrant operations.

Return Values

Name	Type	Description
bool	bool	true when the pool is unlocked; false while its swap lock is held.

source

TickBitmaps

func (p *Pool) TickBitmaps() map[int16]string

TickBitmaps returns the map of initialized-tick bitmap words.

Return Values

Name	Type	Description
map[int16]string	map[int16]string	bitmap words keyed by signed word position.

source

TickSpacing

func (p *Pool) TickSpacing() int32

TickSpacing returns the permitted spacing between initialized ticks.

Return Values

Name	Type	Description
int32	int32	tick spacing configured for the pool.

source

Ticks

func (p *Pool) Ticks() *bptree.BPTree

Ticks returns the tree containing tick state keyed by encoded tick.

Return Values

Name	Type	Description
*bptree.BPTree	*bptree.BPTree	pool tick storage tree.

source

Token0Path

func (p *Pool) Token0Path() string

Token0Path returns the path of the pool's token0 asset.

Return Values

Name	Type	Description
string	string	token0 path stored in the pool.

source

Token1Path

func (p *Pool) Token1Path() string

Token1Path returns the path of the pool's token1 asset.

Return Values

Name	Type	Description
string	string	token1 path stored in the pool.

source

Constructors

• func NewPool(token0Path string, token1Path string, fee uint32, sqrtPriceX96 *u256.Uint, tickSpacing int32, tick int32, slot0FeeProtocol uint8) *Pool (source)

PositionInfo

type PositionInfo struct

PositionInfo stores aggregate liquidity, fee-growth checkpoints, and tokens owed for one pool-scoped lower/upper tick key.

source

Methods

FeeGrowthInside0LastX128

func (p *PositionInfo) FeeGrowthInside0LastX128() string

FeeGrowthInside0LastX128 returns the token0 fee-growth checkpoint for this position.

Return Values

Name	Type	Description
string	string	token0 inside fee-growth checkpoint scaled by 2^128.

source

FeeGrowthInside1LastX128

func (p *PositionInfo) FeeGrowthInside1LastX128() string

FeeGrowthInside1LastX128 returns the token1 fee-growth checkpoint for this position.

Return Values

Name	Type	Description
string	string	token1 inside fee-growth checkpoint scaled by 2^128.

source

Liquidity

func (p *PositionInfo) Liquidity() string

Liquidity returns aggregate liquidity for this position range.

Return Values

Name	Type	Description
string	string	position liquidity encoded as a decimal string.

source

SetFeeGrowthInside0LastX128

func (p *PositionInfo) SetFeeGrowthInside0LastX128(
	feeGrowthInside0LastX128 string
)

SetFeeGrowthInside0LastX128 updates the token0 fee-growth checkpoint.

Parameters

Name	Type	Description
feeGrowthInside0LastX128	string	token0 inside fee-growth checkpoint scaled by 2^128, encoded as a decimal string.

source

SetFeeGrowthInside1LastX128

func (p *PositionInfo) SetFeeGrowthInside1LastX128(
	feeGrowthInside1LastX128 string
)

SetFeeGrowthInside1LastX128 updates the token1 fee-growth checkpoint.

Parameters

Name	Type	Description
feeGrowthInside1LastX128	string	token1 inside fee-growth checkpoint scaled by 2^128, encoded as a decimal string.

source

SetLiquidity

func (p *PositionInfo) SetLiquidity(
	liquidity string
)

SetLiquidity updates aggregate liquidity for this position range.

Parameters

Name	Type	Description
liquidity	string	position liquidity encoded as a decimal string.

source

SetTokensOwed0

func (p *PositionInfo) SetTokensOwed0(
	tokensOwed0 int64
)

SetTokensOwed0 updates token0 accumulated for this position.

Parameters

Name	Type	Description
tokensOwed0	int64	token0 principal or fee amount awaiting collection.

source

SetTokensOwed1

func (p *PositionInfo) SetTokensOwed1(
	tokensOwed1 int64
)

SetTokensOwed1 updates token1 accumulated for this position.

Parameters

Name	Type	Description
tokensOwed1	int64	token1 principal or fee amount awaiting collection.

source

TokensOwed0

func (p *PositionInfo) TokensOwed0() int64

TokensOwed0 returns token0 accumulated for this position.

Return Values

Name	Type	Description
int64	int64	token0 principal or fee amount awaiting collection.

source

TokensOwed1

func (p *PositionInfo) TokensOwed1() int64

TokensOwed1 returns token1 accumulated for this position.

Return Values

Name	Type	Description
int64	int64	token1 principal or fee amount awaiting collection.

source

Constructors

• func NewDefaultPositionInfo() PositionInfo (source)

• func NewPositionInfo() PositionInfo (source)

Slot0

type Slot0 struct

Slot0 mirrors Uniswap V3's slot0(): current price/tick/protocol-fee/lock state and the oracle cursor/capacity metadata.

source

Methods

Clone

func (s *Slot0) Clone() Slot0

Clone returns a value-type copy of Slot0 that shares no mutable state with the original, so callers cannot reach back into pool internals through the returned sqrtPriceX96 pointer.

Return Values

Name	Type	Description
Slot0	Slot0	value copy with a cloned sqrt-price pointer.

source

FeeProtocol

func (s *Slot0) FeeProtocol() uint8

FeeProtocol returns the packed protocol-fee denominators in slot0.

Return Values

Name	Type	Description
uint8	uint8	packed token0/token1 protocol-fee denominator configuration.

source

ObservationCardinality

func (s *Slot0) ObservationCardinality() uint16

ObservationCardinality returns the number of observation slots currently available.

Return Values

Name	Type	Description
uint16	uint16	current observation capacity.

source

ObservationCardinalityNext

func (s *Slot0) ObservationCardinalityNext() uint16

ObservationCardinalityNext returns the requested future observation capacity.

Return Values

Name	Type	Description
uint16	uint16	next observation capacity to use when the ring grows.

source

ObservationIndex

func (s *Slot0) ObservationIndex() uint16

ObservationIndex returns the index of the most recently written observation.

Return Values

Name	Type	Description
uint16	uint16	current observation ring-buffer index.

source

SetFeeProtocol

func (s *Slot0) SetFeeProtocol(
	feeProtocol uint8
)

SetFeeProtocol updates the packed slot0 protocol-fee denominators.

Parameters

Name	Type	Description
feeProtocol	uint8	packed token0/token1 protocol-fee denominator configuration.

source

SetObservationCardinality

func (s *Slot0) SetObservationCardinality(
	observationCardinality uint16
)

SetObservationCardinality updates the current observation capacity.

Parameters

Name	Type	Description
observationCardinality	uint16	current number of observation slots available.

source

SetObservationCardinalityNext

func (s *Slot0) SetObservationCardinalityNext(
	observationCardinalityNext uint16
)

SetObservationCardinalityNext updates the requested future observation capacity.

Parameters

Name	Type	Description
observationCardinalityNext	uint16	next capacity to use when the ring grows.

source

SetObservationIndex

func (s *Slot0) SetObservationIndex(
	observationIndex uint16
)

SetObservationIndex updates the index of the most recently written observation.

Parameters

Name	Type	Description
observationIndex	uint16	observation ring-buffer index to store.

source

SetSqrtPriceX96

func (s *Slot0) SetSqrtPriceX96(
	sqrtPriceX96 *u256.Uint
)

SetSqrtPriceX96 updates the slot0 sqrt price.

Parameters

Name	Type	Description
sqrtPriceX96	*u256.Uint	sqrt(token1/token0) price scaled by 2^96; it is cloned before storage.

source

SetTick

func (s *Slot0) SetTick(
	tick int32
)

SetTick updates the current slot0 tick.

Parameters

Name	Type	Description
tick	int32	current pool tick to store.

source

SetUnlocked

func (s *Slot0) SetUnlocked(
	unlocked bool
)

SetUnlocked updates the slot0 reentrancy-lock state.

Parameters

Name	Type	Description
unlocked	bool	true to mark the pool unlocked, false to mark it locked.

source

SqrtPriceX96

func (s *Slot0) SqrtPriceX96() *u256.Uint

SqrtPriceX96 returns a copy of the current sqrt price in Q96 fixed-point form.

Return Values

Name	Type	Description
*u256.Uint	*u256.Uint	cloned sqrt(token1/token0) price scaled by 2^96.

source

Tick

func (s *Slot0) Tick() int32

Tick returns the current pool tick recorded in slot0.

Return Values

Name	Type	Description
int32	int32	current tick.

source

Unlocked

func (s *Slot0) Unlocked() bool

Unlocked reports whether the pool's reentrancy lock is open.

Return Values

Name	Type	Description
bool	bool	true when unlocked and false while the pool is locked.

source

Constructors

• func GetSlot0(poolPath string) Slot0 (source)

• func NewSlot0(sqrtPriceX96 *u256.Uint, tick int32, feeProtocol uint8, unlocked bool) Slot0 (source)

TickInfo

type TickInfo struct

TickInfo stores information about a specific tick in the pool. TIcks represent discrete price points that can be used as boundaries for positions.

source

Methods

Clone

func (t *TickInfo) Clone() TickInfo

Clone returns an independent value copy of this tick's stored state.

Return Values

Name	Type	Description
TickInfo	TickInfo	copied liquidity, fee-growth, time, and initialization fields.

source

FeeGrowthOutside0X128

func (t *TickInfo) FeeGrowthOutside0X128() string

FeeGrowthOutside0X128 returns token0 fee growth on the side of this tick opposite the current tick.

Return Values

Name	Type	Description
string	string	token0 outside fee-growth accumulator scaled by 2^128.

source

FeeGrowthOutside1X128

func (t *TickInfo) FeeGrowthOutside1X128() string

FeeGrowthOutside1X128 returns token1 fee growth on the side of this tick opposite the current tick.

Return Values

Name	Type	Description
string	string	token1 outside fee-growth accumulator scaled by 2^128.

source

Initialized

func (t *TickInfo) Initialized() bool

Initialized reports whether this tick has active initialized state.

Return Values

Name	Type	Description
bool	bool	true when the tick is initialized; false otherwise.

source

LiquidityGross

func (t *TickInfo) LiquidityGross() string

TickInfo Getters methods LiquidityGross returns total position liquidity referencing this tick.

Return Values

Name	Type	Description
string	string	gross liquidity encoded as a decimal string.

source

LiquidityNet

func (t *TickInfo) LiquidityNet() string

LiquidityNet returns net liquidity applied when this tick is crossed.

Return Values

Name	Type	Description
string	string	signed net liquidity encoded as a decimal string.

source

SecondsOutside

func (t *TickInfo) SecondsOutside() uint32

SecondsOutside returns the time spent on the side of this tick opposite the current tick.

Return Values

Name	Type	Description
uint32	uint32	seconds accumulated outside the tick.

source

SecondsPerLiquidityOutsideX128

func (t *TickInfo) SecondsPerLiquidityOutsideX128() string

SecondsPerLiquidityOutsideX128 returns seconds per liquidity outside this tick.

Return Values

Name	Type	Description
string	string	outside seconds-per-liquidity accumulator scaled by 2^128.

source

SetFeeGrowthOutside0X128

func (t *TickInfo) SetFeeGrowthOutside0X128(
	feeGrowthOutside0X128 string
)

SetFeeGrowthOutside0X128 stores token0 outside fee growth for this tick.

Parameters

Name	Type	Description
feeGrowthOutside0X128	string	token0 outside fee growth scaled by 2^128, encoded as a decimal string.

source

SetFeeGrowthOutside1X128

func (t *TickInfo) SetFeeGrowthOutside1X128(
	feeGrowthOutside1X128 string
)

SetFeeGrowthOutside1X128 stores token1 outside fee growth for this tick.

Parameters

Name	Type	Description
feeGrowthOutside1X128	string	token1 outside fee growth scaled by 2^128, encoded as a decimal string.

source

SetInitialized

func (t *TickInfo) SetInitialized(
	initialized bool
)

SetInitialized updates whether this tick is initialized.

Parameters

Name	Type	Description
initialized	bool	true to mark the tick initialized, false otherwise.

source

SetLiquidityGross

func (t *TickInfo) SetLiquidityGross(
	liquidityGross string
)

TickInfo Setters methods SetLiquidityGross stores total position liquidity referencing this tick.

Parameters

Name	Type	Description
liquidityGross	string	gross liquidity encoded as a decimal string.

source

SetLiquidityNet

func (t *TickInfo) SetLiquidityNet(
	liquidityNet string
)

SetLiquidityNet stores the net liquidity change applied when crossing this tick.

Parameters

Name	Type	Description
liquidityNet	string	signed net liquidity encoded as a decimal string.

source

SetSecondsOutside

func (t *TickInfo) SetSecondsOutside(
	secondsOutside uint32
)

SetSecondsOutside stores the seconds accumulated outside this tick.

Parameters

Name	Type	Description
secondsOutside	uint32	elapsed seconds outside the tick.

source

SetSecondsPerLiquidityOutsideX128

func (t *TickInfo) SetSecondsPerLiquidityOutsideX128(
	secondsPerLiquidityOutsideX128 string
)

SetSecondsPerLiquidityOutsideX128 stores outside seconds-per-liquidity growth.

Parameters

Name	Type	Description
secondsPerLiquidityOutsideX128	string	outside seconds per liquidity scaled by 2^128, encoded as a decimal string.

source

SetTickCumulativeOutside

func (t *TickInfo) SetTickCumulativeOutside(
	tickCumulativeOutside int64
)

SetTickCumulativeOutside stores cumulative tick value outside this tick.

Parameters

Name	Type	Description
tickCumulativeOutside	int64	cumulative tick value on the opposite side.

source

TickCumulativeOutside

func (t *TickInfo) TickCumulativeOutside() int64

TickCumulativeOutside returns cumulative tick value on the side opposite the current tick.

Return Values

Name	Type	Description
int64	int64	outside cumulative tick value.

source

Constructors

• func GetTickInfo(poolPath string, tick int32) (TickInfo, error) (source)

• func NewTickInfo() TickInfo (source)

TokenPair

type TokenPair struct

source

Methods

SetToken0

func (p *TokenPair) SetToken0(
	token0 int64
)

SetToken0 updates the token0 amount in the pair.

Parameters

Name	Type	Description
token0	int64	token0 amount to store.

source

SetToken1

func (p *TokenPair) SetToken1(
	token1 int64
)

SetToken1 updates the token1 amount in the pair.

Parameters

Name	Type	Description
token1	int64	token1 amount to store.

source

Token0

func (p *TokenPair) Token0() int64

Token0 returns the token0 amount in the pair.

Return Values

Name	Type	Description
int64	int64	stored token0 amount.

source

Token1

func (p *TokenPair) Token1() int64

Token1 returns the token1 amount in the pair.

Return Values

Name	Type	Description
int64	int64	stored token1 amount.

source

Constructors

• func NewTokenPair() TokenPair (source)