nit

Author: lmlmt

examples/deployer_freeze.py

@@ -0,0 +1,25 @@
+# Example script to freeze a user from trading, sending, and receiving a token.
+#
+# IMPORTANT: Replace any arguments for the exchange calls below to match your deployment requirements.
+
+import example_utils
+
+from hyperliquid.utils import constants
+
+
+def main():
+    address, info, exchange = example_utils.setup(constants.TESTNET_API_URL, skip_ws=True)
+
+    # Freezing and unfreezing a user for token index 1. This assumes that the deployer
+    # enabled deployer freeze privileges for this token before genesis.
+    token = 1
+    target_user = "0x0000000000000000000000000000000000000001"
+    freeze_user_result = exchange.spot_deploy_freeze_user(token, target_user, True)
+    print(freeze_user_result)
+
+    unfreeze_user_result = exchange.spot_deploy_freeze_user(token, target_user, False)
+    print(unfreeze_user_result)
+
+    # Revoke freeze privilege. Revoking the freeze privilege for a token is permanent.
+    revoke_freeze_privilege_result = exchange.spot_deploy_revoke_freeze_privilege(token)
+    print(revoke_freeze_privilege_result)

examples/spot_deploy.py

@@ -49,6 +49,12 @@ def main():
     user_genesis_result = exchange.spot_deploy_user_genesis(token, [], [(1, "100000000000000")])
     print(user_genesis_result)
 
+    # Step 2-a: Enable Deployer Freeze Functionality
+    #
+    # Enables the deployer to freeze/unfreeze users so that they cannot transfer or trade this token.
+    enable_freeze_privilege_result = exchange.spot_deploy_enable_freeze_privilege(token)
+    print(enable_freeze_privilege_result)
+
     # Step 3: Genesis
     #
     # Finalize genesis. The max supply of 300000000000000 wei needs to match the total

hyperliquid/exchange.py

@@ -623,6 +623,71 @@ def spot_deploy_user_genesis(
             timestamp,
         )
 
+    def spot_deploy_enable_freeze_privilege(self, token: int) -> Any:
+        timestamp = get_timestamp_ms()
+        action = {
+            "type": "spotDeploy",
+            "enableFreezePrivilege": {
+                "token": token,
+            },
+        }
+        signature = sign_l1_action(
+            self.wallet,
+            action,
+            None,
+            timestamp,
+            self.base_url == MAINNET_API_URL,
+        )
+        return self._post_action(
+            action,
+            signature,
+            timestamp,
+        )
+
+    def spot_deploy_freeze_user(self, token: int, user: str, freeze: bool) -> Any:
+        timestamp = get_timestamp_ms()
+        action = {
+            "type": "spotDeploy",
+            "freezeUser": {
+                "token": token,
+                "user": user.lower(),
+                "freeze": freeze,
+            },
+        }
+        signature = sign_l1_action(
+            self.wallet,
+            action,
+            None,
+            timestamp,
+            self.base_url == MAINNET_API_URL,
+        )
+        return self._post_action(
+            action,
+            signature,
+            timestamp,
+        )
+
+    def spot_deploy_revoke_freeze_privilege(self, token: int) -> Any:
+        timestamp = get_timestamp_ms()
+        action = {
+            "type": "spotDeploy",
+            "revokeFreezePrivilege": {
+                "token": token,
+            },
+        }
+        signature = sign_l1_action(
+            self.wallet,
+            action,
+            None,
+            timestamp,
+            self.base_url == MAINNET_API_URL,
+        )
+        return self._post_action(
+            action,
+            signature,
+            timestamp,
+        )
+
     def spot_deploy_genesis(self, token: int, max_supply: str, no_hyperliquidity: bool) -> Any:
         timestamp = get_timestamp_ms()
         genesis = {