Merge branch 'main' into feature_create_wallet

Author: unniznd

requirements-dev.txt

@@ -4,3 +4,5 @@ charset-normalizer==3.1.0
 idna==3.4
 requests==2.31.0
 urllib3==2.0.2
+web3
+eth-accounts

src/lighthouseweb3/__init__.py

@@ -2,12 +2,18 @@
 
 import os
 import io
-from .functions import ( 
+from .functions import (
     upload as d,
     deal_status, 
     get_uploads as getUploads, 
     download as _download,
-    create_wallet as createWallet
+    get_file_info as getFileInfo,
+    get_balance as getBalance,
+    get_api_key as getApiKey,
+    ipns_generate_key as ipnsGenerateKey,
+    ipns_publish_record as ipnsPublishRecord,
+    get_ipns_record as getIpnsRecord,
+    remove_ipns_record as removeIpnsRecord,
 )
 
 
@@ -44,20 +50,63 @@ 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):
+        """
+        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)
+        except Exception as e:
+            raise e
+    
+    def generateKey(self):
+        """
+        Generate a new IPNS key for the authenticated user.
+        :return: dict, The generated IPNS key information.
+        """
+        try:
+            return ipnsGenerateKey.ipns_generate_key(self.token)
+        except Exception as e:
+            raise e
 
-    @staticmethod
-    def createWallet(password: str):
+    def publishRecord(self, cid: str, keyName: str):
         """
-        Creates a new wallet using the provided password.
+        Publish an IPNS record for a given CID and key name.
+        :param cid: str, Content Identifier to publish
+        :param keyName: str, Name of the IPNS key to use
+        :return: dict, The published IPNS record information
+        """
+        try:
+            return ipnsPublishRecord.ipns_publish_record(self.token, cid, keyName)
+        except Exception as e:
+            raise e
 
-        :param password: str, The password to secure the wallet.
-        :return: dict, The wallet encrypted with the passowrd
+    def getAllKeys(self):
+        """
+        Retrieves all IPNS records associated with the current token.
+        return: list A list of IPNS records retrieved using the provided token.
         """
+
         try:
-            return createWallet.create_wallet(password)
+            return getIpnsRecord.get_ipns_records(self.token)
         except Exception as e:
             raise e
-        
+
+    def removeKey(self, keyName: str):
+        """
+        Remove IPNS record of the given keyName
+        :param keyName: str, Name of the IPNS key to use
+        :return: dict, A dict of removed IPNS record.
+        """
+
+        try:
+            return removeIpnsRecord.remove_ipns_record(self.token, keyName)
+        except Exception as e:
+            raise e
+
     @staticmethod
     def downloadBlob(dist: io.BufferedWriter, cid: str, chunk_size=1024*1024*10):
         """
@@ -87,18 +136,16 @@ def getDealStatus(cid: str):
             return deal_status.get_deal_status(cid)
         except Exception as e:
             raise e
-
-    @staticmethod
-    def getUploads(publicKey: str, pageNo: int = 1):
+    
+    def getUploads(self, lastKey: str = None):
         """
         Get uploads from the Lighthouse.
 
-        :param publicKey: str, public key
-        :param pageNo: int, page number (default: 1)
+        :param lastKey: To navigate to different pages of results
         :return: List[t.DealData], list of deal data
         """
         try:
-            return getUploads.get_uploads(publicKey, pageNo)
+            return getUploads.get_uploads(self.token, lastKey)
         except Exception as e:
             raise e
 
@@ -115,6 +162,34 @@ def download(cid: str):
             return _download.get_file(cid)
         except Exception as e:
             raise e
+    
+    @staticmethod
+    def getFileInfo(cid: str):
+        """
+        Retrieves information about a file using its CID (Content Identifier).
+        :param cid: str, Content Identifier for the data to be downloaded
+        returns: dict, A dictionary containing file information.
+        """
+
+        try:
+            return getFileInfo.get_file_info(cid)
+        except Exception as e:
+            raise e
+    
+    @staticmethod
+    def getApiKey(publicKey: str, signedMessage: str):
+        """
+        Generates and returns an API key for the given public key and signed message.
+        :param publicKey: str, The public key associated with the user.
+        :param signedMessage: str, The message signed by the user's private key.
+        :return: dict, A dict with generated API key.
+        """
+
+
+        try:
+            return getApiKey.get_api_key(publicKey, signedMessage)
+        except Exception as e:
+            raise e
 
     def getTagged(self, tag: str):
         """

src/lighthouseweb3/functions/get_api_key.py

@@ -0,0 +1,28 @@
+from .config import Config
+import requests as req
+
+def get_api_key(publicKey: str, signedMessage: str):
+  url = f"{Config.lighthouse_api}/api/auth/create_api_key"
+
+  data = {
+    "publicKey": publicKey,
+    "signedMessage": signedMessage
+  }
+
+  try:
+    response = req.post(url, data=data)
+  except Exception as e:
+    raise Exception("Failed to create api key")
+
+  if response.status_code != 200:
+    return response.json()
+
+  apiKey = response.json()
+
+  result = {
+    "data": {
+      "apiKey" : apiKey
+    }
+  }
+
+  return result

src/lighthouseweb3/functions/get_balance.py

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

src/lighthouseweb3/functions/get_file_info.py

@@ -0,0 +1,11 @@
+from .config import Config
+import requests as req
+
+def get_file_info(cid: str):
+  url = f"{Config.lighthouse_api}/api/lighthouse/file_info?cid={cid}"
+  try:
+    response = req.get(url)
+  except Exception as e:
+    raise Exception("Failed to get file metadata")
+
+  return response.json()

src/lighthouseweb3/functions/get_ipns_record.py

@@ -0,0 +1,19 @@
+from .config import Config
+import requests as req
+
+def get_ipns_records(token: str):
+  headers = {
+    "Authorization": f"Bearer {token}",
+  }
+  url = f"{Config.lighthouse_api}/api/ipns/get_ipns_records"
+  try:
+    response = req.get(url, headers=headers)
+  except Exception as e:
+    raise Exception("Failed to get ipns records")
+
+  if response.status_code != 200:
+    return response.json()
+
+  return {
+    "data": response.json()
+  }

src/lighthouseweb3/functions/get_uploads.py

@@ -11,10 +11,14 @@ def bytes_to_size(bytes_size):
     return f"{round(bytes_size, 2)} {units[index]}"
 
 
-def get_uploads(publicKey: str, pageNo: int = 1) :
+def get_uploads(token: str, lastKey: str = None) :
+    headers = {
+        "Authorization": f"Bearer {token}",
+    }
+
     try:
-        url = f"{Config.lighthouse_api}/api/user/files_uploaded?publicKey={publicKey}&pageNo={pageNo}"
-        response = requests.get(url)
+        url = f"{Config.lighthouse_api}/api/user/files_uploaded?lastKey={lastKey}"
+        response = requests.get(url, headers=headers)
         response.raise_for_status()
         return response.json()
     except requests.HTTPError as error:

src/lighthouseweb3/functions/ipns_generate_key.py

@@ -0,0 +1,19 @@
+from .config import Config
+import requests as req
+
+def ipns_generate_key(token: str):
+  headers = {
+    "Authorization": f"Bearer {token}",
+  }
+  url = f"{Config.lighthouse_api}/api/ipns/generate_key"
+  try:
+    response = req.get(url, headers=headers)
+  except Exception as e:
+    raise Exception("Failed to ipns generate key")
+
+  if response.status_code != 200:
+    return response.json()
+
+  return {
+    "data": response.json()
+  }

src/lighthouseweb3/functions/ipns_publish_record.py

@@ -0,0 +1,19 @@
+from .config import Config
+import requests as req
+
+def ipns_publish_record(token: str, cid: str, keyName: str):
+  headers = {
+    "Authorization": f"Bearer {token}",
+  }
+  url = f"{Config.lighthouse_api}/api/ipns/publish_record?cid={cid}&keyName={keyName}"
+  try:
+    response = req.get(url, headers=headers)
+  except Exception as e:
+    raise Exception("Failed to ipns generate key")
+
+  if response.status_code != 200:
+    return response.json()
+
+  return {
+    "data": response.json()
+  }

src/lighthouseweb3/functions/remove_ipns_record.py

@@ -0,0 +1,19 @@
+from .config import Config
+import requests as req
+
+def remove_ipns_record(token: str,  keyName: str):
+  headers = {
+    "Authorization": f"Bearer {token}",
+  }
+  url = f"{Config.lighthouse_api}/api/ipns/remove_key?keyName={keyName}"
+  try:
+    response = req.delete(url, headers=headers)
+  except Exception as e:
+    raise Exception("Failed to remove ipns record")
+
+  if response.status_code != 200:
+    return response.json()
+
+  return {
+    "data": response.json()
+  }