Modules§
- plan
- Pure plan functions for the Ramses family.
- pool_
address_ raw - Pure CREATE2 pool address derivation for Ramses-family CL DEXes.
Structs§
- Collect
Fees Params - Parameters for a
collect_feesplan. - Enumeration
- Exact
InParams - Parameters for an
exact_inswap quote/plan. - Exact
OutParams - Parameters for an
exact_outswap quote/plan. - Plan
Fragment - Output of a plan function: a bundle of calls + declared approvals + value.
- Pool
Read Entry - One pool’s read result — resilient per-entry (a single bad pool does not abort the batch).
- Pool
State - Snapshot of a v3 pool’s on-chain state at some block.
- Pool
View Data - Normalized pool snapshot — the exact field set the CLI’s
output::PoolViewrenders. Families that have no fee-tier field (ramses) or recompute fee in the renderer (velodrome) setfee: 0; the CLI render path is unaffected. - Position
Fees - Per-position fee data produced by Phase 2 + fee-growth math.
Noneonpool/feesindicates the corresponding pool read reverted (uninitialized pool, NFPM mismatch, etc.) — entry’s position data still emits, just without fee augmentation. - Position
State - Hydrated state of a Ramses-family NFPM position.
- Position
View Entry - One entry in the output — either decoded values or an error string.
- Quote
- Output of a quote computation. Pure — no chain interaction needed
to produce one given a
PoolState. - Ramses
AddLiquidity Params - Parameters for an
add_liquidityplan on a Ramses-family NFPM. - Ramses
Position View - Faithful Rust mirror of the Ramses-family NFPM 10-field
positions()return tuple, plus the caller-suppliedtoken_idechoed as the first field for round-tripping. - Ramses
Protocol Config - Per-protocol configuration for a Ramses-family DEX.
- Remove
AndCollect Params - Remove
Liquidity Params - Parameters for a
remove_liquidityplan.
Enums§
Constants§
Functions§
- config_
for_ chain - enumerate_
owner_ token_ ids - factory
- init_
code_ hash - multicall
- pending_
emissions - plan_
add_ liquidity - plan_
collect_ fees - plan_
increase_ liquidity - plan_
remove_ liquidity - plan_
remove_ liquidity_ and_ collect - Build an atomic
multicall(decreaseLiquidity, collect, ..unwrap_tail)plan fragment for a Shadow Sonic NFPM position. - plan_
swap_ exact_ in - pool_
address - pool_
deployer - pool_
state - pool_
views - Batch-read Ramses (Shadow) pool snapshots through a single Multicall3.
- populate_
positions_ fees - populate_
ticks - position_
key - Compute the Ramses-family pool position key.
- position_
manager - position_
state - position_
token_ pair - position_
views - position_
views_ with_ nfpm - quote_
exact_ in - quote_
exact_ out - quote_
online_ exact_ in - quoter
- router
- supports
- voter