degenbot.curve.stableswap_pool_state
====================================

.. py:module:: degenbot.curve.stableswap_pool_state

.. autoapi-nested-parse::

   State mixin for Curve StableSwap pools.

   Holds immutable data attributes and read-only properties that access them.
   No calculation logic — calculations stay in CurveStableswapPool.

   The state mixin follows the same pattern as V2PoolState and V3PoolState:
   underscore-prefixed private attributes set by the concrete pool's __init__,
   with public @property accessors defined here.

   Curve StableSwap state is significantly different from V2/V3/V4:
   - Multiple tokens (not just 2)
   - A coefficient (amplification parameter) with ramping
   - Strategy enums for variant computation
   - CurveDataProvider for on-chain data access
   - Block-scoped caches for rate/virtual price data





Module Contents
---------------

.. py:class:: StableswapPoolState

   State for Curve StableSwap pools.

   Immutable data set at construction:
   - _tokens: the pool's ERC-20 tokens (2 or more)
   - Configuration attributes (a_coefficient, fee, admin_fee, etc.)
   - Strategy enums and variant computation selectors

   All attributes are set by the concrete pool's __init__.
   Properties provide read access; mutation happens through external_update().


   .. py:property:: tokens
      :type: tuple[degenbot.erc20.Erc20Token, ...]


      Tokens.


   .. py:property:: a_coefficient
      :type: int


      A coefficient.


   .. py:property:: fee
      :type: int


      Fee.


   .. py:property:: admin_fee
      :type: int


      Admin fee.


   .. py:property:: rate_multipliers
      :type: tuple[int, ...]


      Rate multipliers.


   .. py:property:: precision_multipliers
      :type: tuple[int, ...]


      Precision multipliers.


   .. py:property:: base_pool
      :type: degenbot.curve.curve_stableswap_liquidity_pool.CurveStableswapPool | None


      Base pool.


   .. py:property:: tokens_underlying
      :type: tuple[degenbot.erc20.Erc20Token, ...] | None


      Tokens underlying.


   .. py:property:: lp_token
      :type: degenbot.erc20.Erc20Token


      Lp token.


   .. py:property:: use_lending
      :type: tuple[bool, ...]


      Use lending.


   .. py:property:: initial_a_coefficient
      :type: int | None


      Initial a coefficient.


   .. py:property:: future_a_coefficient
      :type: int | None


      Future a coefficient.


   .. py:property:: initial_a_coefficient_time
      :type: int | None


      Initial a coefficient time.


   .. py:property:: future_a_coefficient_time
      :type: int | None


      Future a coefficient time.


   .. py:property:: fee_gamma
      :type: int


      Fee gamma.


   .. py:property:: mid_fee
      :type: int


      Mid fee.


   .. py:property:: out_fee
      :type: int


      Out fee.


   .. py:property:: gamma
      :type: int


      Gamma.


   .. py:property:: offpeg_fee_multiplier
      :type: int


      Offpeg fee multiplier.


   .. py:property:: name
      :type: str


      Name.