v1 state

assertIsNotExpired

assertIsNotExpired ensures the transaction deadline has not passed.

assertSingleSwap

assertIsValidSqrtPriceLimitX96

assertIsValidSingleSwapRouteArrPath

assertIsValidRoutePaths

assertIsExistsPools

assertIsRouterImplementation

assertHopFullyConsumed

assertHopFullyConsumed reverts when an exact-in hop consumed less input than specified.

validateHopFullyConsumed

SINGLE_HOP_ROUTE

POOL_SEPARATOR

swap can be done by multiple pools to separate each pool, we use POOL\_SEPARATOR

RouterOperation

executeSwapOperation

executeSwapOperation validates and processes a swap operation.

BaseSwapParams

baseSwapOperation

common swap operation

SwapRouteParams

SwapRouteParams contains all parameters needed for swap route execution

buildRouteEventAttrs

createSwapOperation

createSwapOperation creates the appropriate swap operation based on swap type.

routerImplAddr

init.19

errSlippage

errInvalidRoutesAndQuotes

errExpired

errInvalidInput

errInvalidPoolFeeTier

errInvalidSwapFee

errInvalidSwapType

errInvalidPoolPath

errUnAuthorizedCaller

errHopsOutOfRange

errSameTokenSwap

errInvalidRoutePath

errInvalidRouteFirstToken

errInvalidRouteLastToken

errInvalidSwapAmount

errRouteHopDisconnected

errInsufficientBalance

errSpoofedRealm

errInsufficientLiquidity

addDetailToError

addDetailToError adds detail to an error message.

makeErrorWithDetails

makeErrorWithDetails creates an error with additional context.

ExactInSwapOperation

NewExactInSwapOperation

NewExactInSwapOperation creates an exact-input operation for router execution. Parameters: - r: router implementation used to execute pool swaps - pp: exact-input amount and route settings Returns: - operation: initialized ExactInSwapOperation

ExactOutSwapOperation

ExactOutSwapOperation handles swaps where the output amount is specified.

NewExactOutSwapOperation

NewExactOutSwapOperation creates an exact-output operation for router execution. Parameters: - r: router implementation used to execute pool swaps - pp: exact-output amount and route settings Returns: - operation: initialized ExactOutSwapOperation

defaultSwapFeeBPS

// 0.15%

init.46

registerRouterV1

initStoreData

routerV1

NewRouterV1

NewRouterV1 creates a router v1 implementation backed by routerStore. Parameters: - routerStore: storage implementation used for swap-fee and pending protocol-fee state Returns: - router: initialized IRouter implementation backed by routerStore

calculateRouterFee

calculateExactOutWithRouterFee

calculate amount to fetch from pool including router fee poolAmount = userAmount / (1 - feeRate) = userAmount \* 10000 / (10000 - swapFeeBPS)

maxSwapFeeBPS

errExactInAmountMismatch

ErrorMessages define all error message templates used throughout the router

errExactOutAmountExceeded

ErrorMessages define all error message templates used throughout the router

errInvalidRouteLength

ErrorMessages define all error message templates used throughout the router

errRoutesQuotesMismatch

ErrorMessages define all error message templates used throughout the router

errInvalidQuote

ErrorMessages define all error message templates used throughout the router

errInvalidQuoteValue

ErrorMessages define all error message templates used throughout the router

errQuoteExceedsMax

ErrorMessages define all error message templates used throughout the router

errQuoteSumExceedsMax

ErrorMessages define all error message templates used throughout the router

errInvalidQuoteSum

ErrorMessages define all error message templates used throughout the router

errExactInTooFewReceived

ErrorMessages define all error message templates used throughout the router

errExactOutTooMuchSpent

ErrorMessages define all error message templates used throughout the router

errEmptyRoutes

ErrorMessages define all error message templates used throughout the router

SwapValidator

SwapValidator provides validation methods for swap operations

RouteParser

RouteParser handles parsing and validation of routes and quotes

NewRouteParser

NewRouteParser creates a parser for comma-separated route and quote strings. Returns: - parser: new RouteParser instance

validateRoutesAndQuotes

validateRoutesAndQuotes is a convenience function that parses and validates routes in one call.

MaxQuotePercentage

QuoteConstraints defines the valid range for swap quote percentages

MinQuotePercentage

QuoteConstraints defines the valid range for swap quote percentages

PERCENTAGE_DENOMINATOR

QuoteConstraints defines the valid range for swap quote percentages

ErrUnknownSwapType

ErrorMessages for DrySwapRoute operations

ErrInvalidPositiveAmount

ErrorMessages for DrySwapRoute operations

ErrInvalidQuoteRange

ErrorMessages for DrySwapRoute operations

SwapProcessor

SwapProcessor handles the execution of swap operations

getPathIndex

getPathIndex returns the path index based on swap type and number of hops.

MIN_SQRT_RATIO_PLUS_ONE

MAX_SQRT_RATIO_MINUS_ONE

calculateSqrtPriceLimitToStr

calculateSqrtPriceLimitToStr returns the price-limit string for a swap operation. A non-zero caller limit is formatted as-is; a zero limit uses the global TickMath boundary for the swap direction.

rawUnknown

rawExactIn

rawExactOut

zeroAddress

SwapType

Unknown

ExactIn

ExactOut

trySwapTypeFromStr

trySwapTypeFromStr attempts to convert a string into a SwapType. It validates and converts string representations of swap types into their corresponding enum values.

SingleSwapParams

SingleSwapParams contains parameters for executing a single pool swap. It represents the simplest form of swap that occurs within a single liquidity pool.

SwapParams

SwapParams contains parameters for executing a multi-hop swap operation.

newSwapParams

newSwapParams creates a new SwapParams instance with the provided parameters.

SwapResult

SwapResult encapsulates the outcome of a swap operation.

SwapParamsI

SwapParamsI defines the common interface for swap parameters.

SwapCallbackData

SwapCallbackData contains the callback data required for swap execution. This type is used to pass necessary information during the swap callback process, ensuring proper token transfers and pool data updates.

newSwapCallbackData

newSwapCallbackData creates a new SwapCallbackData from a SwapParamsI.

newDrySwapCallbackData

newDrySwapCallbackData creates callback data for a dry swap. The payer is deliberately the zero address because dry swaps do not execute callbacks or token transfers.

ExactInParams

ExactInParams contains parameters for exact input swaps.

NewExactInParams

NewExactInParams creates parameters for an exact-input swap. Parameters: - baseParams: shared token, route, quote, price-limit, and deadline settings - amountIn: exact input amount in token units; must be positive before execution - amountOutMin: minimum acceptable output amount in token units Returns: - params: exact-input parameters combining baseParams and amount limits

ExactOutParams

ExactOutParams contains parameters for exact output swaps.

NewExactOutParams

NewExactOutParams creates parameters for an exact-output swap. Parameters: - baseParams: shared token, route, quote, price-limit, and deadline settings - amountOut: requested output amount in token units; must be positive before execution - amountInMax: maximum acceptable input amount in token units Returns: - params: exact-output parameters combining baseParams and amount limits

calculateSwapAmountByQuote

calculateSwapAmountByQuote calculates swap amount based on quote percentage.

assertHopsInRange

assertHopsInRange ensures the number of hops is within the valid range of 1-3.

getDataForSinglePath

getDataForSinglePath extracts token addresses and fee from a single pool path. IMPORTANT: This function returns tokens in the order they appear in the route string, which represents the swap direction (tokenIn:tokenOut:fee), NOT the canonical pool ordering.

getDataForSinglePathWithError

getDataForSinglePathWithError extracts token addresses and fee from a single pool path with error handling.

getDataForMultiPath

getDataForMultiPath extracts token addresses and fee from a multi-hop path at specified index.

i256MinMax

i256MinMax returns the absolute values of x and y in min-max order.

validateRoutePaths

validateRoutePaths validates multiple route paths to ensure they all start with inputToken and end with outputToken. This function processes comma-separated route paths and validates each path individually. Validates: - Each route path starts with the specified inputToken - Each route path ends with the specified outputToken - Route path format consistency (prevents swap-direction vs alphabetical pool ordering confusion) Parameters: - routePathArrString: comma-separated route paths (e.g., "gno.land/r/gnoland/wugnot.wugnot:gno.land/r/gnoswap/gns.GNS:500,gno.land/r/gnoland/wugnot.wugnot:gno.land/r/gnoswap/gns.GNS:3000") - inputToken: expected first token in all route paths - outputToken: expected last token in all route paths Examples: - Single route: "tokenA:tokenB:500" with inputToken="tokenA", outputToken="tokenB" - Multi-route: "tokenA:tokenB:500,tokenA:tokenC:3000\*POOL\*tokenC:tokenB:500" with inputToken="tokenA", outputToken="tokenB" Returns error if any route path validation fails.

validateRoutePath

validateRoutePath validates a single route path to ensure it starts with inputToken and ends with outputToken. This function handles both single-hop and multi-hop route paths. Validates: - Route path starts with the specified inputToken - Route path ends with the specified outputToken - Proper token ordering in swap direction (not alphabetical pool ordering) Route Path Formats: - single-hop: "tokenA:tokenB:fee" (direct swap between two tokens) - multi-hop: "tokenA:tokenB:fee1\*POOL\*tokenB:tokenC:fee2" (swap through intermediate tokens) Parameters: - routePath: single route path string (e.g., "gno.land/r/gnoland/wugnot.wugnot:gno.land/r/gnoswap/gns.GNS:500") - inputToken: expected first token in the route path - outputToken: expected last token in the route path Examples: - single-hop: "tokenA:tokenB:500" with inputToken="tokenA", outputToken="tokenB" - multi-hop: "tokenA:tokenB:3000\*POOL\*tokenB:tokenC:500" with inputToken="tokenA", outputToken="tokenC" Returns error with specific details if validation fails.

validatePoolPathHopContinuity

splitSingleChar

splitSingleChar splits a string by a single character separator. This function is optimized for splitting strings with a single-byte separator and is more memory efficient than strings.Split for this use case.

parsePoolPathsByRoutePathArr

parsePoolPathsByRoutePathArr parses route path array string and returns a slice of pool paths. This function converts route paths (which maintain swap direction) into canonical pool paths (which use alphabetical token ordering). The function processes comma-separated route paths and extracts individual pool information from each route, ensuring tokens are ordered alphabetically for consistent pool identification. Parameters: - routePathArr: comma-separated route paths string containing single or multi-hop routes Format examples: - Single route: "tokenA:tokenB:500" - Multiple routes: "tokenA:tokenB:500,tokenC:tokenD:3000" - Multi-hop routes: "tokenA:tokenB:500\*POOL\*tokenB:tokenC:3000" Returns: - \[]string: slice of canonical pool paths with alphabetically ordered tokens - error: parsing error if any route path is invalid Example: input: "gno.land/r/gnoland/wugnot.wugnot:gno.land/r/gnoswap/gns.GNS:500,gno.land/r/gnoland/wugnot.wugnot:gno.land/r/gnoswap/gns.GNS:3000" output: ["gno.land/r/gnoswap/gns.GNS:gno.land/r/gnoland/wugnot.wugnot:500", "gno.land/r/gnoswap/gns.GNS:gno.land/r/gnoland/wugnot.wugnot:3000"]

BuildSingleHopRoutePath

BuildSingleHopRoutePath formats one route-direction single-hop path. Parameters: - tokenA: input token contract path - tokenB: output token contract path - fee: pool fee tier appended as a decimal value Returns: - routePath: tokenA:tokenB:fee formatted route string; panics for empty or identical tokens