1const (
2	StoreKeySwapFee             StoreKey = "swapFee"             // Swap fee in basis points
3	StoreKeyPendingProtocolFees StoreKey = "pendingProtocolFees" // tokenPath -> amount held locally for protocol_fee
4)

1func DrySwapRoute(
2	inputToken, outputToken string,
3	specifiedAmount string,
4	swapTypeStr string,
5	strRouteArr, quoteArr string,
6	tokenAmountLimit string,
7) (string, string, error)

1func ExactInSingleSwapRoute(cur realm, inputToken string, outputToken string, amountIn string, routeArr string, amountOutMin string, sqrtPriceLimitX96 string, deadline int64, referrer string) (string, string)

1func ExactInSwapRoute(cur realm, inputToken string, outputToken string, amountIn string, routeArr string, quoteArr string, amountOutMin string, deadline int64, referrer string) (string, string)

1func ExactOutSingleSwapRoute(cur realm, inputToken string, outputToken string, amountOut string, routeArr string, amountInMax string, sqrtPriceLimitX96 string, deadline int64, referrer string) (string, string)

1func ExactOutSwapRoute(cur realm, inputToken string, outputToken string, amountOut string, routeArr string, quoteArr string, amountInMax string, deadline int64, referrer string) (string, string)

1func GetImplementationPackagePath() string

1func GetPendingProtocolFees() map[string]int64

1func GetSwapFee() uint64

1func RegisterInitializer(cur realm, initializer func(_ int, rlm realm, routerStore IRouterStore) IRouter)

1func Render(path string) string

1func SetSwapFee(cur realm, fee uint64)

1func SwapCallback(cur realm, token0Path string, token1Path string, amount0Delta int64, amount1Delta int64, payer address) error

1func UpgradeImpl(cur realm, packagePath string)

1func NewRouterStore(kvStore store.KVStore) IRouterStore

  1type IRouter interface {
  2	// ExactInSwapRoute executes a multi-hop exact-input swap.
  3	//
  4	// Parameters:
  5	//   - _: leading implementation discriminator; callers pass 0
  6	//   - rlm: propagated current realm context used for swap validation and transfers
  7	//   - inputToken: input token contract path
  8	//   - outputToken: output token contract path
  9	//   - amountIn: exact input amount encoded as a decimal string
 10	//   - routeArr: comma-separated route paths, each with up to three pool hops
 11	//   - quoteArr: comma-separated route allocation percentages summing to 100
 12	//   - amountOutMin: minimum net output amount encoded as a decimal string
 13	//   - deadline: Unix timestamp after which the swap is rejected
 14	//   - referrer: optional referral address used for registration
 15	//
 16	// Returns:
 17	//   - amountIn: actual input amount consumed, encoded as a decimal string
 18	//   - amountOut: net output amount after router fee, encoded as a decimal string
 19	ExactInSwapRoute(_ int, rlm realm, inputToken string, outputToken string, amountIn string, routeArr string, quoteArr string, amountOutMin string, deadline int64, referrer string) (string, string)
 20	// ExactInSingleSwapRoute executes an exact-input swap through one pool.
 21	//
 22	// Parameters:
 23	//   - _: leading implementation discriminator; callers pass 0
 24	//   - rlm: propagated current realm context used for swap validation and transfers
 25	//   - inputToken: input token contract path
 26	//   - outputToken: output token contract path
 27	//   - amountIn: exact input amount encoded as a decimal string
 28	//   - routeArr: single-hop route path
 29	//   - amountOutMin: minimum net output amount encoded as a decimal string
 30	//   - sqrtPriceLimitX96: optional Q64.96 square-root price limit encoded as a decimal string
 31	//   - deadline: Unix timestamp after which the swap is rejected
 32	//   - referrer: optional referral address used for registration
 33	//
 34	// Returns:
 35	//   - amountIn: actual input amount consumed, encoded as a decimal string
 36	//   - amountOut: net output amount after router fee, encoded as a decimal string
 37	ExactInSingleSwapRoute(_ int, rlm realm, inputToken string, outputToken string, amountIn string, routeArr string, amountOutMin string, sqrtPriceLimitX96 string, deadline int64, referrer string) (string, string)
 38
 39	// ExactOutSwapRoute executes a multi-hop swap for a requested net output.
 40	//
 41	// Parameters:
 42	//   - _: leading implementation discriminator; callers pass 0
 43	//   - rlm: propagated current realm context used for swap validation and transfers
 44	//   - inputToken: input token contract path
 45	//   - outputToken: output token contract path
 46	//   - amountOut: requested net output amount encoded as a decimal string
 47	//   - routeArr: comma-separated route paths, each with up to three pool hops
 48	//   - quoteArr: comma-separated route allocation percentages summing to 100
 49	//   - amountInMax: maximum input amount encoded as a decimal string
 50	//   - deadline: Unix timestamp after which the swap is rejected
 51	//   - referrer: optional referral address used for registration
 52	//
 53	// Returns:
 54	//   - amountIn: actual input amount consumed, encoded as a decimal string
 55	//   - amountOut: net output amount after router fee, encoded as a decimal string
 56	ExactOutSwapRoute(_ int, rlm realm, inputToken string, outputToken string, amountOut string, routeArr string, quoteArr string, amountInMax string, deadline int64, referrer string) (string, string)
 57	// ExactOutSingleSwapRoute executes an exact-output swap through one pool.
 58	//
 59	// Parameters:
 60	//   - _: leading implementation discriminator; callers pass 0
 61	//   - rlm: propagated current realm context used for swap validation and transfers
 62	//   - inputToken: input token contract path
 63	//   - outputToken: output token contract path
 64	//   - amountOut: requested net output amount encoded as a decimal string
 65	//   - routeArr: single-hop route path
 66	//   - amountInMax: maximum input amount encoded as a decimal string
 67	//   - sqrtPriceLimitX96: optional Q64.96 square-root price limit encoded as a decimal string
 68	//   - deadline: Unix timestamp after which the swap is rejected
 69	//   - referrer: optional referral address used for registration
 70	//
 71	// Returns:
 72	//   - amountIn: actual input amount consumed, encoded as a decimal string
 73	//   - amountOut: net output amount after router fee, encoded as a decimal string
 74	ExactOutSingleSwapRoute(_ int, rlm realm, inputToken string, outputToken string, amountOut string, routeArr string, amountInMax string, sqrtPriceLimitX96 string, deadline int64, referrer string) (string, string)
 75
 76	// DrySwapRoute simulates a route without writing state or transferring tokens.
 77	//
 78	// Parameters:
 79	//   - inputToken: input token contract path
 80	//   - outputToken: output token contract path
 81	//   - specifiedAmount: exact input or output amount encoded as a decimal string
 82	//   - swapTypeStr: swap type string, either EXACT_IN or EXACT_OUT
 83	//   - strRouteArr: comma-separated encoded route paths
 84	//   - quoteArr: comma-separated route allocation percentages summing to 100
 85	//   - tokenAmountLimit: minimum output for EXACT_IN or maximum input for EXACT_OUT
 86	//
 87	// Returns:
 88	//   - amountIn: simulated input amount encoded as a decimal string
 89	//   - amountOut: simulated net output amount encoded as a decimal string
 90	//   - err: nil on success; validation, liquidity, or slippage error on failure
 91	DrySwapRoute(inputToken, outputToken, specifiedAmount, swapTypeStr, strRouteArr, quoteArr, tokenAmountLimit string) (string, string, error)
 92	// SwapCallback pays a pool's positive input delta during a swap.
 93	//
 94	// Parameters:
 95	//   - _: leading callback discriminator; callers pass 0
 96	//   - rlm: propagated current realm context; implementation verifies it is current
 97	//   - token0Path: token-0 contract path in canonical pool order
 98	//   - token1Path: token-1 contract path in canonical pool order
 99	//   - amount0Delta: signed token-0 delta; positive means the pool is owed tokens
100	//   - amount1Delta: signed token-1 delta; positive means the pool is owed tokens
101	//   - payer: address whose balance supplies the positive delta
102	//
103	// Returns:
104	//   - err: nil after payment; error when realm, liquidity delta, or transfer validation fails
105	SwapCallback(_ int, rlm realm, token0Path string, token1Path string, amount0Delta int64, amount1Delta int64, payer address) error
106	// GetSwapFee reads the router fee rate.
107	//
108	// Returns:
109	//   - fee: router fee in basis points
110	GetSwapFee() uint64
111	// SetSwapFee updates the router fee rate.
112	//
113	// Parameters:
114	//   - _: leading call discriminator; callers pass 0
115	//   - rlm: propagated current realm context used for authorized storage writes
116	//   - fee: router fee in basis points
117	SetSwapFee(_ int, rlm realm, fee uint64)
118	// GetPendingProtocolFees reads pending protocol fees keyed by token path.
119	//
120	// Returns:
121	//   - fees: token-path to pending-fee amount map
122	GetPendingProtocolFees() map[string]int64
123	Render(path string) string
124}

 1type IRouterStore interface {
 2	// HasSwapFeeKey reports whether a stored router fee exists.
 3	//
 4	// Returns:
 5	//   - exists: true when the swap-fee key is present
 6	HasSwapFeeKey() bool
 7	// GetSwapFee reads the stored router fee.
 8	//
 9	// Returns:
10	//   - fee: configured router fee in basis points
11	GetSwapFee() uint64
12	// SetSwapFee persists the router fee.
13	//
14	// Parameters:
15	//   - _: leading call discriminator; callers pass 0
16	//   - rlm: propagated current realm context; storage validates current-frame status
17	//   - fee: router fee in basis points
18	//
19	// Returns:
20	//   - err: nil on success; storage or realm-validation error otherwise
21	SetSwapFee(_ int, rlm realm, fee uint64) error
22	// HasPendingProtocolFeesKey reports whether a stored pending-fees map exists.
23	//
24	// Returns:
25	//   - exists: true when the pending-fees key is present
26	HasPendingProtocolFeesKey() bool
27	// GetPendingProtocolFees reads all pending protocol fees.
28	//
29	// Returns:
30	//   - fees: token-path to pending-fee amount map
31	GetPendingProtocolFees() map[string]int64
32	// SetPendingProtocolFees replaces all pending protocol fees.
33	//
34	// Parameters:
35	//   - _: leading call discriminator; callers pass 0
36	//   - rlm: propagated current realm context; storage validates current-frame status
37	//   - fees: token-path to pending-fee amount map to persist
38	//
39	// Returns:
40	//   - err: nil on success; storage or realm-validation error otherwise
41	SetPendingProtocolFees(_ int, rlm realm, fees map[string]int64) error
42	// GetPendingProtocolFee reads one token's pending fee.
43	//
44	// Parameters:
45	//   - tokenPath: token contract path to query
46	//
47	// Returns:
48	//   - amount: pending amount for tokenPath, or zero if absent
49	GetPendingProtocolFee(tokenPath string) int64
50	// SetPendingProtocolFee updates one token's pending fee.
51	//
52	// Parameters:
53	//   - _: leading call discriminator; callers pass 0
54	//   - rlm: propagated current realm context; storage validates current-frame and write authorization
55	//   - tokenPath: token contract path to update
56	//   - amount: pending amount to record
57	//
58	// Returns:
59	//   - err: nil on success; realm or storage authorization error otherwise
60	SetPendingProtocolFee(_ int, rlm realm, tokenPath string, amount int64) error
61	// RemovePendingProtocolFee deletes one token's pending fee.
62	//
63	// Parameters:
64	//   - _: leading call discriminator; callers pass 0
65	//   - rlm: propagated current realm context; storage validates current-frame and write authorization
66	//   - tokenPath: token contract path to remove
67	//
68	// Returns:
69	//   - err: nil on success; realm or storage authorization error otherwise
70	RemovePendingProtocolFee(_ int, rlm realm, tokenPath string) error
71}

1type StoreKey string