add gas price multiples (#1433)

examples/custom_policy.py

@@ -1,12 +1,10 @@
-"""Custom policy example"""
+"""Custom policy example."""
 
 from __future__ import annotations
 
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-from fixedpointmath import FixedPoint
-
 from agent0 import (
     HyperdriveBasePolicy,
     add_liquidity_trade,
@@ -17,6 +15,7 @@
     redeem_withdraw_shares_trade,
     remove_liquidity_trade,
 )
+from fixedpointmath import FixedPoint
 
 if TYPE_CHECKING:
     from agent0.core.base import Trade
@@ -27,7 +26,7 @@
 # Build custom policy
 # Simple agent, opens a set of all trades for a fixed amount and closes them after
 class CustomCycleTradesPolicy(HyperdriveBasePolicy):
-    """An agent that simply cycles through all trades"""
+    """An agent that simply cycles through all trades."""
 
     @dataclass(kw_only=True)
     class Config(HyperdriveBasePolicy.Config):

src/agent0/core/base/policies/base.py

@@ -9,6 +9,8 @@
 from fixedpointmath import FixedPoint
 from numpy.random import default_rng
 
+from agent0.core.base.types import freezable
+
 if TYPE_CHECKING:
     from numpy.random._generator import Generator
 
@@ -24,6 +26,7 @@ class BasePolicy(Generic[MarketInterface, Wallet]):
 
     # Because we're inheriting from this config, we need to set
     # kw_only so that we can mix and match defaults and non-defaults
+    @freezable(frozen=False, no_new_attribs=False)
     @dataclass(kw_only=True)
     class Config:
         """Config data class for policy specific configuration."""
@@ -34,6 +37,10 @@ class Config:
         """The experiment's stateful random number generator. Defaults to a spawn of the global rng."""
         slippage_tolerance: FixedPoint | None = None
         """The slippage tolerance for trades. Defaults to None."""
+        base_fee_multiple: float | None = None
+        """The base fee multiple for transactions. Defaults to None."""
+        priority_fee_multiple: float | None = None
+        """The priority fee multiple for transactions. Defaults to None."""
 
     def __init__(self, policy_config: Config):
         """Initialize the policy.
@@ -47,6 +54,9 @@ def __init__(self, policy_config: Config):
         # overwriting the __init__ function. The downside is that users of this member variable
         # can't be type checked. There's probably a way to do this with generics instead of Any.
         self.config: Any = policy_config
+        # lock down the config so we can't change it by either modifying existing attribs or adding new ones
+        self.config.freeze()  # type: ignore
+        self.config.disable_new_attribs()  # type: ignore
         self.slippage_tolerance = policy_config.slippage_tolerance
         # Generate rng if not set in config
         if policy_config.rng is None:

src/agent0/core/base/types.py

@@ -1,4 +1,4 @@
-"""Core types used across the repo"""
+"""Core types used across the repo."""
 
 from __future__ import annotations  # types will be strings by default in 3.11
 
@@ -40,7 +40,7 @@ def dtypes(self):
 
 
 def freezable(frozen: bool = False, no_new_attribs: bool = False):
-    """A wrapper that allows classes to be frozen, such that existing member attributes cannot be changed.
+    """Allow classes to be frozen, such that existing member attributes cannot be changed.
 
     Arguments
     ---------
@@ -53,7 +53,7 @@ def freezable(frozen: bool = False, no_new_attribs: bool = False):
     """
 
     def decorator(cls):
-        """Decorator for the provided class.
+        """Define decorator for the provided class.
 
         Arguments
         ---------
@@ -139,7 +139,7 @@ def dtypes(self) -> dict[str, type]:
 
 
 class TokenType(Enum):
-    r"""A type of token"""
+    r"""A type of token."""
 
     BASE = "base"
 

src/agent0/core/base/types_test.py

@@ -1,4 +1,4 @@
-"""Testing for agent0 types"""
+"""Testing for agent0 types."""
 
 from __future__ import annotations
 
@@ -13,37 +13,37 @@
 
 @dataclass
 class ClassWithOneAttribute:
-    """Class with one attribute"""
+    """Class with one attribute."""
 
     existing_attrib: int = 1
 
 
 @freezable(frozen=False, no_new_attribs=False)
 @dataclass
 class FreezableClass(ClassWithOneAttribute):
-    """Freezable class unfrozen by default"""
+    """Freezable class unfrozen by default."""
 
 
 @freezable(frozen=True, no_new_attribs=False)
 @dataclass
 class FreezableClassFrozenByDefault(ClassWithOneAttribute):
-    """Freezable class frozen by default"""
+    """Freezable class frozen by default."""
 
 
 @freezable(frozen=False, no_new_attribs=True)
 @dataclass
 class FreezableClassNoNewAttribsByDefault(ClassWithOneAttribute):
-    """Freezable class with no_new_attribs set by default"""
+    """Freezable class with no_new_attribs set by default."""
 
 
 @freezable(frozen=True, no_new_attribs=True)
 @dataclass
 class FreezableClassFrozenNoNewAttribsByDefault(ClassWithOneAttribute):
-    """Freezable class frozen and with no_new_attribs set by default"""
+    """Freezable class frozen and with no_new_attribs set by default."""
 
 
 class TestFreezability(unittest.TestCase):
-    """Test freezable wrapper functionality
+    """Test freezable wrapper functionality.
 
     each test checks for the ability to change or add attributest, in 4 cases:
     1. not frozen
@@ -56,16 +56,18 @@ class TestFreezability(unittest.TestCase):
     """
 
     def test_freezable_when_not_set(self):
-        """Freezable object when frozen is NOT set, and no_new_attribs is NOT set
-        desired behavior is: CAN change attributes, and CAN add attributes
+        """Freezable object when frozen is NOT set, and no_new_attribs is NOT set.
+
+        Desired behavior is: CAN change attributes, and CAN add attributes
         """
         freezable_object = FreezableClass()
         freezable_object.existing_attrib = 2
         freezable_object.new_attrib = 1  # pylint: disable=attribute-defined-outside-init # type: ignore
 
     def test_freezable_when_frozen_is_set(self):
-        """Freezable object when frozen IS set, but no_new_attribs is NOT set, manually
-        desired behavior is: can NOT change attributes, and CAN add attributes
+        """Freezable object when frozen IS set, but no_new_attribs is NOT set, manually.
+
+        Desired behavior is: can NOT change attributes, and CAN add attributes
         """
         freezable_object = FreezableClass()
         freezable_object.freeze()  # pylint: disable=no-member # type: ignore
@@ -74,17 +76,19 @@ def test_freezable_when_frozen_is_set(self):
         freezable_object.new_attrib = 1  # pylint: disable=attribute-defined-outside-init # type: ignore
 
     def test_freezable_when_frozen_is_set_by_default(self):
-        """Freezable object when frozen IS set, but no_new_attribs is NOT set, by default
-        desired behavior is: can NOT change attributes, and CAN add attributes
+        """Freezable object when frozen IS set, but no_new_attribs is NOT set, by default.
+
+        Desired behavior is: can NOT change attributes, and CAN add attributes
         """
         freezable_object = FreezableClassFrozenByDefault()
         with self.assertRaises(AttributeError):
             freezable_object.existing_attrib = 2
         freezable_object.new_attrib = 1  # pylint: disable=attribute-defined-outside-init # type: ignore
 
     def test_freezable_when_no_new_attribs_is_set(self):
-        """Freezable object when frozen is NOT set, but no_new_attribs IS set, manually
-        desired behavior is: CAN change attributes, and can NOT add attributes
+        """Freezable object when frozen is NOT set, but no_new_attribs IS set, manually.
+
+        Desired behavior is: CAN change attributes, and can NOT add attributes
         """
         freezable_object = FreezableClass()
         freezable_object.disable_new_attribs()  # pylint: disable=no-member # type: ignore
@@ -93,17 +97,19 @@ def test_freezable_when_no_new_attribs_is_set(self):
             freezable_object.new_attrib = 1  # pylint: disable=attribute-defined-outside-init # type: ignore
 
     def test_freezable_when_no_new_attribs_is_set_by_default(self):
-        """Freezable object when frozen is NOT set, but no_new_attribs IS set, by default
-        desired behavior is: CAN change attributes, and can NOT add attributes
+        """Freezable object when frozen is NOT set, but no_new_attribs IS set, by default.
+
+        Desired behavior is: CAN change attributes, and can NOT add attributes.
         """
         freezable_object = FreezableClassNoNewAttribsByDefault()
         freezable_object.existing_attrib = 2
         with self.assertRaises(AttributeError):
             freezable_object.new_attrib = 1  # pylint: disable=attribute-defined-outside-init # type: ignore
 
     def test_freezable_when_frozen_is_set_and_no_new_attribs_is_set(self):
-        """Freezable object when frozen IS set, and no_new_attribs IS set, manually
-        desired behavior is: can NOT change attributes, and can NOT add attributes
+        """Freezable object when frozen IS set, and no_new_attribs IS set manually.
+
+        Desired behavior is: can NOT change attributes, and can NOT add attributes
         """
         freezable_object = FreezableClass()
         freezable_object.freeze()  # pylint: disable=no-member # type: ignore
@@ -114,8 +120,9 @@ def test_freezable_when_frozen_is_set_and_no_new_attribs_is_set(self):
             freezable_object.new_attrib = 1  # pylint: disable=attribute-defined-outside-init # type: ignore
 
     def test_freezable_when_frozen_is_set_and_no_new_attribs_is_set_by_default(self):
-        """Freezable object when frozen IS set, and no_new_attribs IS set, by default
-        desired behavior is: can NOT change attributes, and can NOT add attributes
+        """Freezable object when frozen IS set, and no_new_attribs IS set.
+
+        Default desired behavior is: can NOT change attributes, and can NOT add attributes.
         """
         freezable_object = FreezableClassFrozenNoNewAttribsByDefault()
         with self.assertRaises(AttributeError):
@@ -124,7 +131,7 @@ def test_freezable_when_frozen_is_set_and_no_new_attribs_is_set_by_default(self)
             freezable_object.new_attrib = 1  # pylint: disable=attribute-defined-outside-init # type: ignore
 
     def test_dtypes(self):
-        """Test dtype casting & checking capability of classes that have the freezable decorator"""
+        """Test dtype casting & checking capability of classes that have the freezable decorator."""
         freezable_object = FreezableClass(existing_attrib=4)
         # cast to int, check that it is an int
         assert isinstance(