naeural-client 2.7.42__py3-none-any.whl → 3.0.0__py3-none-any.whl

naeural_client/_ver.py

@@ -1,4 +1,4 @@
-__VER__ = "2.7.42"
+__VER__ = "3.0.0"
 
 if __name__ == "__main__":
   with open("pyproject.toml", "rt") as fd:

naeural_client/ipfs/ifps_keygen

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3
+import os
+import binascii
+import base64
+
+def generate_swarm_key():
+  """
+  Generate a 32-byte random key and format it as a valid IPFS swarm key.
+  """
+  # 32 bytes of cryptographically secure random data
+  random_bytes = os.urandom(32)
+  # Hex-encode them
+  hex_str = binascii.hexlify(random_bytes).decode('utf-8')
+
+  # Construct the file content
+  swarm_key_data = (
+    "/key/swarm/psk/1.0.0/\n"
+    "/base16/\n"
+    f"{hex_str}\n"
+  )
+
+  # Base64-encode the key
+  swarm_key_data = base64.b64encode(swarm_key_data.encode('utf-8')).decode('utf-8')
+
+  return swarm_key_data
+
+
+if __name__ == "__main__":
+  key_str = generate_swarm_key()
+  print("Generated swarm_key_base64.txt content:")
+  print(key_str)
+  # Optionally save to a file
+  with open("swarm_key_base64.txt", "w") as f:
+    f.write(key_str)
+  print("Swarm key written to swarm_key_base64.txt")

naeural_client/ipfs/ipfs_setup/ipfs.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=IPFS daemon
+After=network.target
+
+[Service]
+# Set the user who owns ~/.ipfs (assuming "ipfsuser" owns ~/.ipfs)
+User=root
+ExecStart=/usr/local/bin/ipfs daemon
+Restart=always
+KillSignal=SIGINT
+
+[Install]
+WantedBy=multi-user.target

naeural_client/ipfs/ipfs_setup/launch_service.sh

@@ -0,0 +1,6 @@
+
+cp ipfs.service /etc/systemd/system/ipfs.service
+sudo systemctl daemon-reload
+sudo systemctl enable ipfs
+sudo systemctl start ipfs
+./show.sh

naeural_client/ipfs/ipfs_setup/restart.sh

@@ -0,0 +1 @@
+systemctl restart ipfs

naeural_client/ipfs/ipfs_setup/run.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+ipfs bootstrap rm --all
+ipfs daemon

naeural_client/ipfs/ipfs_setup/setup.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_linux-amd64.tar.gz && \
+  tar -xvzf kubo_v0.33.1_linux-amd64.tar.gz && \
+  cd kubo && \
+  bash install.sh
+ipfs init
+ipfs config --json Swarm.EnableRelayHop true
+cd ..
+./write_key.sh
+

naeural_client/ipfs/ipfs_setup/show.sh

@@ -0,0 +1,3 @@
+ipfs log level all debug
+# shows the log of the ipfs.service systemd service
+journalctl -u ipfs.service -f -n 1000 -a

naeural_client/ipfs/ipfs_setup/write_key.sh

@@ -0,0 +1,3 @@
+# load the base64 encoded swarm key into the SWARM_KEY_CONTENT_BASE64 env var
+cat swarm_key_base64.txt | base64 -d > /root/.ipfs/swarm.key
+cat /root/.ipfs/swarm.key

naeural_client/ipfs/r1fs.py

@@ -1,6 +1,53 @@
 """
 Ratio1 base IPFS utility functions.
 
+
+NOTE: 
+  - Following the bootstrapping of this module, it takes a few minutes for the relay
+    to be connected and the IPFS daemon to be fully operational so sometimes, after
+    the start of the engine, the first few `get` operations may fail.
+
+
+Installation:
+
+1. On the dev node or seed node run ifps_keygen and generate `swarm_key_base64.txt` then
+   save this key to the environment variable `EE_SWARM_KEY_CONTENT_BASE64` on the seed 
+   oracles as well as in a file.
+     
+2. On seed node create `ipfs_setup`, copy the files from the `ipfs_setup` including the
+  key file.
+  
+3. Run `setup.sh` on the seed node or:
+
+    ```bash
+    #!/bin/bash
+    wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_linux-amd64.tar.gz && \
+      tar -xvzf kubo_v0.32.1_linux-amd64.tar.gz && \
+      cd kubo && \
+      bash install.sh
+    ipfs init
+    ipfs config --json Swarm.EnableRelayHop true
+
+    ./write_key.sh
+    ```
+  The `write_key.sh` script should contain the following:
+  
+    ```bash 
+    cat swarm_key_base64.txt | base64 -d > /root/.ipfs/swarm.key
+    cat /root/.ipfs/swarm.key
+    ```
+  
+4. Continue on the seed node and run either manually (NOT recommended) or via a systemd
+   the ifps daemon using `./launch_service.sh` that basically does:
+   
+    ```bash
+    cp ipfs.service /etc/systemd/system/ipfs.service
+    sudo systemctl daemon-reload
+    sudo systemctl enable ipfs
+    sudo systemctl start ipfs
+    ./show.sh
+    ```
+
 """
 import subprocess
 import json
@@ -13,7 +60,7 @@ import uuid
 
 from threading import Lock
 
-__VER__ = "0.2.1"
+__VER__ = "0.2.2"
 
 
 class IPFSCt:

{naeural_client-2.7.42.dist-info → naeural_client-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: naeural_client
-Version: 2.7.42
+Version: 3.0.0
 Summary: `naeural_client` is the Python SDK required for client app development for the Naeural Edge Protocol Edge Protocol framework
 Project-URL: Homepage, https://github.com/NaeuralEdgeProtocol/naeural_client
 Project-URL: Bug Tracker, https://github.com/NaeuralEdgeProtocol/naeural_client/issues

{naeural_client-2.7.42.dist-info → naeural_client-3.0.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 naeural_client/__init__.py,sha256=YimqgDbjLuywsf8zCWE0EaUXH4MBUrqLxt0TDV558hQ,632
-naeural_client/_ver.py,sha256=Q93aXw2mji9yRTgEWkuF0JwuicbvBiHlVU3oFdsJmUs,331
+naeural_client/_ver.py,sha256=MqerdK9jgr7au4o00knSFo3zGjY-2Lg5pJXY___ZpQA,330
 naeural_client/base_decentra_object.py,sha256=C4iwZTkhKNBS4VHlJs5DfElRYLo4Q9l1V1DNVSk1fyQ,4412
 naeural_client/plugins_manager_mixin.py,sha256=X1JdGLDz0gN1rPnTN_5mJXR8JmqoBFQISJXmPR9yvCo,11106
 naeural_client/base/__init__.py,sha256=hACh83_cIv7-PwYMM3bQm2IBmNqiHw-3PAfDfAEKz9A,259
@@ -61,7 +61,15 @@ naeural_client/io_formatter/default/a_dummy.py,sha256=qr9eUizQ-NN5jdXVzkaZKMaf9K
 naeural_client/io_formatter/default/aixp1.py,sha256=MX0TeUR4APA-qN3vUC6uzcz8Pssz5lgrQWo7td5Ri1A,3052
 naeural_client/io_formatter/default/default.py,sha256=gEy78cP2D5s0y8vQh4aHuxqz7D10gGfuiKF311QhrpE,494
 naeural_client/ipfs/__init__.py,sha256=vXEDLUNUO6lOTMGa8iQ9Zf7ajIQq9GZuvYraAHt3meE,38
-naeural_client/ipfs/r1fs.py,sha256=vqqSDulF1AlqrepCS8byGAv3JwNppMwbdS1KmuTvKw8,17213
+naeural_client/ipfs/ifps_keygen,sha256=PcoYuo4c89_C9FWrKq9K_28ruhKqnxNn1s3nLHiF1tc,879
+naeural_client/ipfs/r1fs.py,sha256=IKJZG3jiodvXT6tfRWKQtg4oALQ9H9OhW85q1JGnd58,18653
+naeural_client/ipfs/ipfs_setup/ipfs.service,sha256=isTJQsktPy4i1yaDA9AC1OKdlTYvsCCRRAVX-EmGqAs,248
+naeural_client/ipfs/ipfs_setup/launch_service.sh,sha256=GWhZyNqtohLxJg8Q_c8YnNZduu1ddXDU-IFRRMaEyiY,141
+naeural_client/ipfs/ipfs_setup/restart.sh,sha256=9xHMgkUoAMI25jeaoDVFbCa_LjojYm3ubljW58RatKE,22
+naeural_client/ipfs/ipfs_setup/run.sh,sha256=CXfUtGiQRzawb-n9nLCWl1lbTcDqMNRqMLXwPovBsPM,48
+naeural_client/ipfs/ipfs_setup/setup.sh,sha256=1yIIDjk0jU1nInQypKFF-8wqjVVyuk-UzREzpL7GjVY,249
+naeural_client/ipfs/ipfs_setup/show.sh,sha256=3EXyZppTNDrla0dH21m73s2lDNJXBAMn_DurYb30WfU,117
+naeural_client/ipfs/ipfs_setup/write_key.sh,sha256=wLESi33j4UoSkXmYUUnI0kd9Sro6BMwtQp29UXxNVk4,164
 naeural_client/logging/__init__.py,sha256=b79X45VC6c37u32flKB2GAK9f-RR0ocwP0JDCy0t7QQ,33
 naeural_client/logging/base_logger.py,sha256=qqqMX30Vmh5Dz8YYaeL_ainQPTP5FsX1Y4QMbsIG5Rg,69599
 naeural_client/logging/small_logger.py,sha256=m12hCb_H4XifJYYfgCAOUDkcXm-h4pSODnFf277OFVI,2937
@@ -88,8 +96,8 @@ naeural_client/utils/comm_utils.py,sha256=4cS9llRr_pK_3rNgDcRMCQwYPO0kcNU7AdWy_L
 naeural_client/utils/config.py,sha256=lAbWe3UMi40BOdsAIZIb-fYtb4LwG3MIYg0EOA1ITr8,10340
 naeural_client/utils/dotenv.py,sha256=_AgSo35n7EnQv5yDyu7C7i0kHragLJoCGydHjvOkrYY,2008
 naeural_client/utils/oracle_sync/oracle_tester.py,sha256=X-923ccjkr6_kzbbiuAAcWSIhMtBDOH2VURjTh55apQ,27235
-naeural_client-2.7.42.dist-info/METADATA,sha256=_MgS-DeFCJsXJlhrvjUxxo2bzlFgs494DCfztb8JrOM,12354
-naeural_client-2.7.42.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-naeural_client-2.7.42.dist-info/entry_points.txt,sha256=CTua17GUrRa4aXeafezGC9TiWKGKQzwTjQmB2jyj22g,91
-naeural_client-2.7.42.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
-naeural_client-2.7.42.dist-info/RECORD,,
+naeural_client-3.0.0.dist-info/METADATA,sha256=tFFs2d77B_LkChWon4_SsC6V5AQIMAatH4gmJVHA_3c,12353
+naeural_client-3.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+naeural_client-3.0.0.dist-info/entry_points.txt,sha256=CTua17GUrRa4aXeafezGC9TiWKGKQzwTjQmB2jyj22g,91
+naeural_client-3.0.0.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+naeural_client-3.0.0.dist-info/RECORD,,