feature: get balance API added and tested successfully

Author: unniznd

src/lighthouseweb3/__init__.py

@@ -2,7 +2,13 @@
 
 import os
 import io
-from .functions import upload as d,deal_status, get_uploads as getUploads, download as _download
+from .functions import (
+    upload as d,
+    deal_status, 
+    get_uploads as getUploads, 
+    download as _download,
+    get_balance as getBalance
+)
 
 
 class Lighthouse:
@@ -38,6 +44,18 @@ def uploadBlob(self, source: io.BufferedReader, filename: str, tag: str = ''):
             return d.uploadBlob(source, filename, self.token, tag)
         except Exception as e:
             raise e
+    
+    def getBalance(self, publicKey: str):
+        """
+        Retrieve the balance information of a user from the Lighthouse.
+
+        :param publicKey: str, The public key of the user.
+        :return: dict[str, any], A dictionary containing the data usage and data limit details.
+        """
+        try:
+            return getBalance.get_balance(self.token, publicKey)
+        except Exception as e:
+            raise e
 
     @staticmethod
     def downloadBlob(dist: io.BufferedWriter, cid: str, chunk_size=1024*1024*10):

src/lighthouseweb3/functions/get_balance.py

@@ -0,0 +1,14 @@
+from .config import Config
+import requests as req
+
+def get_balance(token:str, publicKey: str):
+  headers = {
+        "Authorization": f"Bearer {token}",
+    }
+  url = f"{Config.lighthouse_api}/api/user/user_data_usage?publicKey={publicKey}"
+  try:
+    response = req.get(url, headers=headers)
+  except Exception as e:
+    raise Exception("Failed to get account balance")
+
+  return response.json()

tests/test_get_balance.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+import os
+import unittest
+from src.lighthouseweb3 import Lighthouse
+from .setup import parse_env
+
+
+class TestGetBalance(unittest.TestCase):
+
+    def test_get_balance(self):
+        """test get_balance function"""
+        parse_env()
+        l = Lighthouse(os.environ.get("LIGHTHOUSE_TOKEN"))
+        res = l.getBalance("0x1FB9Be96d228De94F4C57962675433Ae55a6c4a5")
+        self.assertIsInstance(res, dict, "data is a dict")
+        self.assertIsInstance(res.get("dataLimit"), int, "data limit is a integer")
+        self.assertIsInstance(res.get("dataUsed"), int, "data used is a integer")