adjust config and add liquidation functions

Author: Tburm

src/synthetix/perps/perps.py

@@ -1314,7 +1314,8 @@ def get_markets(self):
                 "market_name": market_digests[ind][1].decode("utf-8").strip("\x00"),
                 "symbol": market_digests[ind][1].decode("utf-8").strip("\x00")[:-4],
                 "feed_id": encode_hex(market_configs[ind][1]),
-                "config": unpack_bfp_configuration(market_config),
+                "system_config": unpack_bfp_configuration(market_config),
+                "market_config": unpack_bfp_configuration_by_id(market_configs[ind]),
             }
             for ind, market_id in enumerate(market_ids)
         }
@@ -1346,7 +1347,7 @@ def get_markets(self):
                 "total_trader_debt_usd": wei_to_ether(market_digests[ind][10]),
                 "total_collateral_value_usd": wei_to_ether(market_digests[ind][11]),
                 "debt_correction": wei_to_ether(market_digests[ind][12]),
-                # "market_configuration": unpack_bfp_configuration_by_id(market_configs[ind]),
+                "market_config": unpack_bfp_configuration_by_id(market_configs[ind]),
             }
             for ind, market_id in enumerate(market_ids)
         }
@@ -1541,6 +1542,39 @@ def get_quote(
             "side": "long" if size > 0 else "short",
         }
 
+    def get_can_liquidate(
+        self, account_id: int = None, market_id: int = None, market_name: str = None
+    ):
+        """
+        Check if an ``account_id`` is eligible for liquidation on a specified market
+
+        :param int | None account_id: The id of the account to check. If not provided, the default account is used.
+        :return: A boolean indicating if the account is eligible for liquidation.
+        :rtype: bool
+        """
+        market_id, market_name = self._resolve_market(market_id, market_name)
+        if not account_id:
+            account_id = self.default_account_id
+
+        # call the liquidation functions
+        is_position_liquidatable = call_erc7412(
+            self.snx,
+            self.market_proxy,
+            "isPositionLiquidatable",
+            (account_id, market_id),
+        )
+        is_margin_liquidatable = call_erc7412(
+            self.snx,
+            self.market_proxy,
+            "isMarginLiquidatable",
+            (account_id, market_id),
+        )
+
+        return {
+            "is_position_liquidatable": is_position_liquidatable,
+            "is_margin_liquidatable": is_margin_liquidatable,
+        }
+
     def modify_collateral(
         self,
         amount: float,
@@ -1644,10 +1678,11 @@ def commit_order(
             hooks = []
 
         # Prepare the transaction
-        tx_params = self.snx._get_tx_params(to=self.market_proxy.address)
-        tx_params["data"] = self.market_proxy.encodeABI(
-            fn_name="commitOrder",
-            args=[
+        tx_params = write_erc7412(
+            self.snx,
+            self.market_proxy,
+            "commitOrder",
+            [
                 account_id,
                 market_id,
                 size_wei,
@@ -1703,10 +1738,10 @@ def settle_order(
         order = self.get_order(account_id, market_id=market_id)
         self.logger.info(f"Order: {order}")
 
-        min_publish_delay = self.market_meta[market_id]["config"][
+        min_publish_delay = self.market_meta[market_id]["system_config"][
             "pyth_publish_time_min"
         ]
-        max_publish_delay = self.market_meta[market_id]["config"][
+        max_publish_delay = self.market_meta[market_id]["system_config"][
             "pyth_publish_time_max"
         ]
 
@@ -1720,12 +1755,6 @@ def settle_order(
 
         for attempt in range(max_attempts):
             try:
-                # log the block info
-                block = self.snx.web3.eth.get_block("latest")
-                self.logger.info(
-                    f"Block number: {block['number']} | timestamp {block['timestamp']}"
-                )
-
                 # Fetch the latest Pyth price update data
                 pyth_data = self.snx.pyth.get_price_from_ids(
                     [pyth_price_feed_id], publish_time=publish_time
@@ -1818,3 +1847,34 @@ def pay_debt(
             return tx_hash
         else:
             return tx_params
+
+    def liquidate(
+        self,
+        account_id: int = None,
+        market_id: int = None,
+        market_name: str = None,
+        margin_only: bool = False,
+        submit: bool = False,
+    ):
+        """ """
+        market_id, market_name = self._resolve_market(market_id, market_name)
+        if account_id is None:
+            account_id = self.default_account_id
+
+        fn_name = "liquidatePosition" if not margin_only else "liquidateMarginOnly"
+        tx_params = write_erc7412(
+            self.snx,
+            self.market_proxy,
+            fn_name,
+            [account_id, market_id],
+        )
+        if submit:
+            tx_hash = self.snx.execute_transaction(tx_params)
+            self.logger.info(
+                f"Liquidating account {account_id} in market {market_name}"
+            )
+
+            self.logger.info(f"{fn_name} tx: {tx_hash}")
+            return tx_hash
+        else:
+            return tx_params

src/synthetix/perps/perps_utils.py

@@ -1,4 +1,6 @@
 from eth_utils import encode_hex
+from ..utils import wei_to_ether
+
 
 def unpack_bfp_configuration(config_data):
     """
@@ -15,22 +17,22 @@ def unpack_bfp_configuration(config_data):
         "pyth_publish_time_max": config_data[4],
         "min_order_age": config_data[5],
         "max_order_age": config_data[6],
-        "min_keeper_fee_usd": config_data[7],
-        "max_keeper_fee_usd": config_data[8],
-        "keeper_profit_margin_usd": config_data[9],
-        "keeper_profit_margin_percent": config_data[10],
+        "min_keeper_fee_usd": wei_to_ether(config_data[7]),
+        "max_keeper_fee_usd": wei_to_ether(config_data[8]),
+        "keeper_profit_margin_usd": wei_to_ether(config_data[9]),
+        "keeper_profit_margin_percent": wei_to_ether(config_data[10]),
         "keeper_settlement_gas_units": config_data[11],
         "keeper_cancellation_gas_units": config_data[12],
         "keeper_liquidation_gas_units": config_data[13],
         "keeper_flag_gas_units": config_data[14],
         "keeper_liquidate_margin_gas_units": config_data[15],
         "keeper_liquidation_endorsed": config_data[16],
         "collateral_discount_scalar": config_data[17],
-        "min_collateral_discount": config_data[18],
-        "max_collateral_discount": config_data[19],
-        "utilization_breakpoint_percent": config_data[20],
-        "low_utilization_slope_percent": config_data[21],
-        "high_utilization_slope_percent": config_data[22],
+        "min_collateral_discount": wei_to_ether(config_data[18]),
+        "max_collateral_discount": wei_to_ether(config_data[19]),
+        "utilization_breakpoint_percent": wei_to_ether(config_data[20]),
+        "low_utilization_slope_percent": wei_to_ether(config_data[21]),
+        "high_utilization_slope_percent": wei_to_ether(config_data[22]),
     }
 
 
@@ -65,20 +67,20 @@ def unpack_bfp_configuration_by_id(config_data):
     return {
         "oracle_node_id": encode_hex(oracle_node_id),
         "pyth_price_feed_id": encode_hex(pyth_price_feed_id),
-        "maker_fee": maker_fee,
-        "taker_fee": taker_fee,
-        "max_market_size": max_market_size,
-        "max_funding_velocity": max_funding_velocity,
-        "skew_scale": skew_scale,
-        "funding_velocity_clamp": funding_velocity_clamp,
-        "min_credit_percent": min_credit_percent,
-        "min_margin_usd": min_margin_usd,
-        "min_margin_ratio": min_margin_ratio,
-        "incremental_margin_scalar": incremental_margin_scalar,
-        "maintenance_margin_scalar": maintenance_margin_scalar,
-        "max_initial_margin_ratio": max_initial_margin_ratio,
-        "liquidation_reward_percent": liquidation_reward_percent,
-        "liquidation_limit_scalar": liquidation_limit_scalar,
-        "liquidation_window_duration": liquidation_window_duration,
-        "liquidation_max_pd": liquidation_max_pd,
+        "maker_fee": wei_to_ether(maker_fee),
+        "taker_fee": wei_to_ether(taker_fee),
+        "max_market_size": wei_to_ether(max_market_size),
+        "max_funding_velocity": wei_to_ether(max_funding_velocity),
+        "skew_scale": wei_to_ether(skew_scale),
+        "funding_velocity_clamp": wei_to_ether(funding_velocity_clamp),
+        "min_credit_percent": wei_to_ether(min_credit_percent),
+        "min_margin_usd": wei_to_ether(min_margin_usd),
+        "min_margin_ratio": wei_to_ether(min_margin_ratio),
+        "incremental_margin_scalar": wei_to_ether(incremental_margin_scalar),
+        "maintenance_margin_scalar": wei_to_ether(maintenance_margin_scalar),
+        "max_initial_margin_ratio": wei_to_ether(max_initial_margin_ratio),
+        "liquidation_reward_percent": wei_to_ether(liquidation_reward_percent),
+        "liquidation_limit_scalar": wei_to_ether(liquidation_limit_scalar),
+        "liquidation_window_duration": wei_to_ether(liquidation_window_duration),
+        "liquidation_max_pd": wei_to_ether(liquidation_max_pd),
     }