Rename vault_exiting_validators_limit_bps to os_token_vaults_exit_lim…

…it_bps (#128)

* Rename vault_exiting_validators_limit_bps to os_token_vaults_exit_limit_bps

* Add items to gitignore

* poetry update

* Fix pylint

* Review fix

.gitignore

@@ -5,3 +5,8 @@ dist
 .idea
 local.env
 *.env
+.python-version
+.vscode
+.history
+.DS_Store
+.coverage

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sw-utils"
-version = "v0.6.31"
+version = "v0.6.32"
 description = "StakeWise Python utils"
 authors = ["StakeWise Labs <[email protected]>"]
 license = "GPL-3.0-or-later"

sw_utils/execution.py

@@ -113,7 +113,7 @@ def set_retry_timeout(self, retry_timeout: int) -> None:
         self.retry_timeout = retry_timeout
 
 
-# pylint: disable-next=too-many-arguments
+# pylint: disable-next=too-many-arguments,too-many-positional-arguments
 def get_execution_client(
     endpoints: list[str],
     is_poa: bool = False,

sw_utils/ipfs.py

@@ -290,7 +290,7 @@ async def _iter_pins(self) -> AsyncIterator[dict]:
             page_number += 1
             total_pages = pin_results['totalPages']
 
-    # pylint: disable-next=too-many-arguments
+    # pylint: disable-next=too-many-arguments,too-many-positional-arguments
     async def _call(
         self,
         http_method: str,

sw_utils/protocol_config.py

@@ -31,7 +31,9 @@ def build_protocol_config(
     if validators_threshold and exit_signature_recover_threshold > validators_threshold:
         raise ValueError('Invalid exit signature threshold')
 
-    vault_exiting_validators_limit_bps = config_data.get('vault_exiting_validators_limit_bps') or 0
+    # default exit limit bps is 100%
+    os_token_vaults_exit_limit_bps = config_data.get('os_token_vaults_exit_limit_bps') or 10_000
+
     os_token_vaults = [Web3.to_checksum_address(v) for v in config_data.get('os_token_vaults', [])]
 
     return ProtocolConfig(
@@ -49,6 +51,6 @@ def build_protocol_config(
         exit_signature_epoch=config_data['exit_signature_epoch'],
         signature_validity_period=config_data['signature_validity_period'],
         until_force_exit_epochs=config_data['until_force_exit_epochs'],
-        vault_exiting_validators_limit_bps=vault_exiting_validators_limit_bps,
+        os_token_vaults_exit_limit_bps=os_token_vaults_exit_limit_bps,
         os_token_vaults=os_token_vaults,
     )

sw_utils/tests/factories.py

@@ -64,7 +64,7 @@ def get_mocked_protocol_config(
     inactive_validator_balance: Wei = Web3.to_wei(31.75, 'ether'),
     validator_min_active_epochs: int = 2250,  # 10 days
     vault_fee_max_bps: int = 1500,  # 15%
-    vault_exiting_validators_limit_bps: int = 0,
+    os_token_vaults_exit_limit_bps: int = 10_000,  # 100%
     os_token_vaults: list[str] | None = None,
 ) -> ProtocolConfig:
     return ProtocolConfig(
@@ -91,6 +91,6 @@ def get_mocked_protocol_config(
         until_force_exit_epochs=until_force_exit_epochs,
         rewards_threshold=rewards_threshold,
         validators_threshold=validators_threshold,
-        vault_exiting_validators_limit_bps=vault_exiting_validators_limit_bps,
+        os_token_vaults_exit_limit_bps=os_token_vaults_exit_limit_bps,
         os_token_vaults=os_token_vaults or [],
     )

sw_utils/typings.py

@@ -65,9 +65,9 @@ class ProtocolConfig:
 
     exit_signature_recover_threshold: int
 
-    # Max exiting validators bps for genesis vault.
+    # Max exiting validators bps for os-token vaults.
     # Zero value means limit is not set.
-    vault_exiting_validators_limit_bps: int
+    os_token_vaults_exit_limit_bps: int
 
     # List of vaults used to determine osToken reward rate
     os_token_vaults: list[ChecksumAddress]