Automated Market Marke Types
Module providing types and state classes for AMM pools.
AbstractCommonStableSwapPoolState
Bases: AbstractStableSwapPoolState
The common variant of StableSwap.
This class implements the common variant of the stableswap algorithm. The main difference is the
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
367 368 369 370 371 372 373 374 375 376 377 378 379 |
|
AbstractConstantLiquidityPoolState
Bases: AbstractPoolState
Represents the state of a constant liquidity pool automated market maker (AMM).
This class serves as a base for constant liquidity pool implementations, providing methods to calculate the input and output asset amounts for swaps.
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
|
get_amount_in(asset: Assets, precise: bool = True) -> tuple[Assets, float]
Calculate input amount needed for desired output in constant liquidity pool.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
asset |
Assets
|
The desired output asset amount for the swap. |
required |
precise |
bool
|
If True: the output rounded to the nearest integer. |
True
|
Returns:
Type | Description |
---|---|
tuple[Assets, float]
|
tuple[Assets, float]: Tuple containing required input asset and float value. |
Raises:
Type | Description |
---|---|
NotImplementedError
|
This method is not implemented in the base class. |
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
|
get_amount_out(asset: Assets, precise: bool = True) -> tuple[Assets, float]
Calculate the output amount for a given input in a constant liquidity pool.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
asset |
Assets
|
The input asset amount for the swap. |
required |
precise |
bool
|
If True: the output rounded to the nearest integer. |
True
|
Returns:
Type | Description |
---|---|
tuple[Assets, float]
|
tuple[Assets, float]: Tuple containing the output asset and float value. |
Raises:
Type | Description |
---|---|
NotImplementedError
|
This method is not implemented in the base class. |
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
|
AbstractConstantProductPoolState
Bases: AbstractPoolState
Represents the state of a constant product automated market maker (AMM) pool.
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
|
get_amount_in(asset: Assets, precise: bool = True) -> tuple[Assets, float]
Get the input asset amount given a desired output asset amount.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
asset |
Assets
|
An asset with a defined quantity. |
required |
precise |
bool
|
Whether to return precise calculations. |
True
|
Returns:
Type | Description |
---|---|
tuple[Assets, float]
|
The estimated asset needed for input in the swap. |
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
|
get_amount_out(asset: Assets, precise: bool = True) -> tuple[Assets, float]
Get the output asset amount given an input asset amount.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
asset |
Assets
|
An asset with a defined quantity. |
required |
precise |
bool
|
Whether to return precise calculations. |
True
|
Returns:
Type | Description |
---|---|
tuple[Assets, float]
|
A tuple where the first value is the estimated asset returned from the swap and the second value is the price impact ratio. |
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
|
AbstractStableSwapPoolState
Bases: AbstractPoolState
Represents the state of a stable swap automated market maker (AMM) pool.
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
|
amp: int
property
Amplification coefficient used in the stable swap algorithm.
reserve_a: int
property
Reserve amount of asset A.
reserve_b: int
property
Reserve amount of asset B.
get_amount_in(asset: Assets, precise: bool = True, fee_on_input: bool = True) -> tuple[Assets, float]
Calculate the amount of assets required as input to receive a given output.
This function computes the input amount needed for a swap operation in the stable swap pool to achieve a desired output, taking into account the volume fee and precision settings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
asset |
Assets
|
The desired output asset amount for the swap. |
required |
precise |
bool
|
If True, returns precise integer input. Defaults to True. |
True
|
fee_on_input |
bool
|
If True, applies the fee to the calculated input. If False, applies the fee to the given output. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
tuple[Assets, float]
|
tuple[Assets, float]: A tuple containing: - The input asset amount required for the swap. - A float value (always 0 in this implementation). |
Raises:
Type | Description |
---|---|
ValueError
|
If the output asset is invalid or if multiple output |
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
|
get_amount_out(asset: Assets, precise: bool = True, fee_on_input: bool = True) -> tuple[Assets, float]
Calculate the amount of assets received when swapping a given input amount.
This function computes the output amount for a swap operation in the stable swap pool, taking into account the volume fee and precision settings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
asset |
Assets
|
The input asset amount for the swap. |
required |
precise |
bool
|
If True, returns precise integer output. Default True. |
True
|
fee_on_input |
bool
|
If True, applies the fee to the input amount. If False, applies the fee to the output amount. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
tuple[Assets, float]
|
tuple[Assets, float]: A tuple containing: - The output asset amount after the swap. - A float value (always 0 in this implementation). |
Raises:
Type | Description |
---|---|
ValueError
|
If the input asset is invalid or if multiple input assets are provided. |
Source code in src/charli3_dendrite/dexs/amm/amm_types.py
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
|