chore(deps): update dependencies + stability improvements (#20)

Author: Archento

.github/workflows/ci.yml

@@ -19,52 +19,34 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - if: matrix.os == 'macos-latest' && matrix.python-version == '3.11'
-      name: Install build tools
-      run: |
-        brew install automake
-
-    - name: Install Poetry
-      uses: abatilo/actions-poetry@v2
-
-    - name: Install dependencies
-      run: |
-        poetry install
-
-    - name: Run tests
-      run: |
-        poetry run pytest
-
-
-  lint:
-    name: Lint
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - if: matrix.os == 'macos-latest' && matrix.python-version == '3.11'
+        name: Install build tools
+        run: |
+          brew install automake
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Run tests
+        run: |
+          poetry run pytest
+
+  ruff:
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v3
-      with:
-        python-version: 3.9
-
-    - name: Install Poetry
-      uses: abatilo/actions-poetry@v2
-
-    - name: Install dependencies
-      run: |
-        poetry install
-
-    - name: Run tests
-      run: |
-        poetry run black --check .
-
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1

.gitignore

@@ -2,3 +2,4 @@
 __pycache__
 
 .idea/
+.vscode/

README.md

@@ -1,3 +1,5 @@
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
 # Babble
 
 A simple python library for interacting with the Fetch.ai messaging service (called Memorandum)
@@ -35,4 +37,4 @@ for msg in client2.receive():
 
 **Run formatter**
 
-    poetry run black .
+    poetry run ruff check --fix && ruff format

examples/simple-e2e.py

@@ -1,5 +1,5 @@
 import base64
-from datetime import datetime
+from datetime import datetime, timezone
 
 from babble import Client, Identity
 
@@ -13,7 +13,7 @@ def create_client(seed: str, chain_id: str = MAINNET_CHAIN_ID) -> Client:
     delegate_pubkey = delegate_identity.public_key
     delegate_pubkey_b64 = base64.b64encode(bytes.fromhex(delegate_pubkey)).decode()
 
-    # Important: Messaging ublic key to be registered should be different even though delegate address can be same.
+    # Important: Messaging public key to be registered should be different even though delegate address can be same.
     identity = Identity.from_seed(f"{seed} {chain_id}")
     signed_bytes, signature = delegate_identity.sign_arbitrary(
         identity.public_key.encode()
@@ -29,11 +29,11 @@ def create_client(seed: str, chain_id: str = MAINNET_CHAIN_ID) -> Client:
     )
 
 
-# create out clients
+# create clients
 client1 = create_client("the wise mans fear none name")
 client2 = create_client("the name of the wind man fear")
 
-# create out clients with same seed phrase, should not be an issue
+# create clients with same seed phrase, should not be an issue
 client1_dorado = create_client("the wise mans fear none name", TESTNET_CHAIN_ID)
 client2_dorado = create_client("the name of the wind man fear", TESTNET_CHAIN_ID)
 
@@ -47,7 +47,8 @@ def create_client(seed: str, chain_id: str = MAINNET_CHAIN_ID) -> Client:
 
 # start sending of a message
 client1.send(
-    client2.delegate_address, "why hello there " + datetime.utcnow().isoformat()
+    client2.delegate_address,
+    "why hello there " + datetime.now(timezone.utc).isoformat(),
 )
 
 # simulate the reading of the message
@@ -61,7 +62,7 @@ def create_client(seed: str, chain_id: str = MAINNET_CHAIN_ID) -> Client:
 
 client1_dorado.send(
     client2_dorado.delegate_address,
-    "why hello there on dorado" + datetime.utcnow().isoformat(),
+    "why hello there on dorado" + datetime.now(timezone.utc).isoformat(),
 )
 
 for msg in client2_dorado.receive():

poetry.lock

@@ -9,17 +9,18 @@ packages = [{ include = "babble", from = "src" }]
 
 
 [tool.poetry.dependencies]
-python = "^3.7"
-ecdsa = "^0.18.0"
-requests = "^2.28.2"
+python = ">=3.9,<3.13"
+ecdsa = "^0.19.0"
+requests = "^2.32.3"
 bech32 = "^1.2.0"
-pycryptodome = "^3.16.0"
-pyjwt = "^2.6.0"
-eciespy = "^0.3.13"
+pycryptodome = "^3.20.0"
+pyjwt = "^2.8.0"
+eciespy = "^0.4.2"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.2.1"
-black = "22.12.0"
+pytest = "^8.2.2"
+tomli = "^2.0.1"
+ruff = "^0.4.10"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -8,7 +8,6 @@
 import tomli
 from packaging.version import Version
 
-
 ROOT = Path(__file__).parent.parent
 
 
@@ -27,7 +26,7 @@ def pypi_password(self) -> str:
 
 
 def get_the_latest_release_version() -> Version:
-    """Get release version from gihtub tags."""
+    """Get release version from github tags."""
     text = subprocess.check_output("git ls-remote --tags origin", shell=True, text=True)
     tags = [i.split("\t")[1].strip() for i in text.splitlines()]
     tags = [i for i in tags if i.startswith("refs/tags/v") and not i.endswith("^{}")]
@@ -93,7 +92,7 @@ def upload_packages(self):
             stderr=sys.stderr,
         )
         if result.returncode != 0:
-            raise RuntimeError("Upload pacakges failed!")
+            raise RuntimeError("Upload packages failed!")
 
     def main(self):
         """Run release process."""

scripts/do_release.py

@@ -1,2 +1,2 @@
-from .client import Client, Message
-from .crypto import Identity
+from .client import Client, Message  # noqa
+from .crypto import Identity  # noqa

src/babble/__init__.py

@@ -1,13 +1,13 @@
 from dataclasses import dataclass
 from datetime import datetime, timezone
-from typing import Tuple
+from typing import Optional, Tuple
 
 import jwt
 import requests
 
-from .config import AUTH_SERVER
+from .config import AUTH_SERVER, DEFAULT_REQUEST_TIMEOUT
 from .crypto.identity import Identity
-from .encoding import to_base64, from_base64
+from .encoding import from_base64, to_base64
 
 
 @dataclass
@@ -18,18 +18,29 @@ class TokenMetadata:
     expires_at: datetime
 
 
+def send_post_request(url: str, data: dict) -> Optional[dict]:
+    """Send a POST request to the given URL with the given data."""
+    try:
+        response = requests.post(url, json=data, timeout=DEFAULT_REQUEST_TIMEOUT)
+        return response.json()
+    except requests.exceptions.RequestException as err:
+        print(f"Error: {err}")
+        return None
+
+
 def authenticate(identity: Identity, name: str = None) -> Tuple[str, TokenMetadata]:
-    r = requests.post(
+    """Authenticate the given identity and return the token and metadata."""
+    resp = send_post_request(
         f"{AUTH_SERVER}/auth/login/wallet/challenge",
-        json={
+        {
             "address": identity.address,
             "client_id": name if name else "uagent",
         },
     )
-    r.raise_for_status()
-    resp = r.json()
+    if not resp or "challenge" not in resp or "nonce" not in resp:
+        return None, None
 
-    payload = resp["challenge"]
+    payload: str = resp["challenge"]
 
     # create the signature
     _, signature = identity.sign_arbitrary(payload.encode())
@@ -47,20 +58,18 @@ def authenticate(identity: Identity, name: str = None) -> Tuple[str, TokenMetada
         "scope": "",
     }
 
-    r = requests.post(
-        f"{AUTH_SERVER}/auth/login/wallet/verify",
-        json=login_request,
+    login_resp = send_post_request(
+        f"{AUTH_SERVER}/auth/login/wallet/verify", login_request
     )
-    r.raise_for_status()
+    if not login_resp:
+        return None, None
 
-    r = requests.post(
-        f"{AUTH_SERVER}/tokens",
-        json=r.json(),
-    )
-    r.raise_for_status()
+    token_resp = send_post_request(f"{AUTH_SERVER}/tokens", login_resp)
+    if not token_resp or "access_token" not in token_resp:
+        return None, None
 
     # extract the token
-    token = str(r.json()["access_token"])
+    token = str(token_resp["access_token"])
 
     # parse the token
     token_data = jwt.decode(
@@ -78,7 +87,10 @@ def authenticate(identity: Identity, name: str = None) -> Tuple[str, TokenMetada
         expires_at=datetime.fromtimestamp(token_data["exp"], timezone.utc),
     )
 
-    assert metadata.address == identity.address
-    assert metadata.public_key == identity.public_key
+    if (
+        not metadata.address == identity.address
+        or not metadata.public_key == identity.public_key
+    ):
+        return None, None
 
     return token, metadata

src/babble/auth.py

@@ -1,18 +1,18 @@
 from dataclasses import dataclass
-from datetime import datetime, timezone, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import List
 
 import bech32
 
 from .auth import authenticate
 from .crypto.exceptions import RoutingError
 from .crypto.identity import Identity
-from .encoding import to_json, to_base64, from_base64, from_json
+from .encoding import from_base64, from_json, to_base64, to_json
 from .mailbox import (
-    lookup_messaging_public_key,
-    register_messaging_public_key,
     dispatch_messages,
     list_messages,
+    lookup_messaging_public_key,
+    register_messaging_public_key,
 )
 
 EXPIRATION_BUFFER_SECONDS = 60 * 5  # 5 minutes
@@ -61,6 +61,7 @@ def __init__(
 
         # authenticate against the API
         self._token = None
+        self._token_metadata = {"expires_at": self._now()}
         self._update_authentication()
 
         # ensure the registration is in place
@@ -73,6 +74,8 @@ def _update_authentication(self):
             < self._now() - timedelta(seconds=EXPIRATION_BUFFER_SECONDS)
         ):
             self._token, self._token_metadata = authenticate(self._identity, self._name)
+            if not self._token or not self._token_metadata:
+                raise ValueError("Failed to authenticate")
 
     def __repr__(self):
         return f"{self._delegate_address}  ({self._identity.public_key})"

src/babble/client.py

@@ -1,5 +1,9 @@
 import os
 
+MAINNET_CHAIN_ID = "fetchhub-4"
+TESTNET_CHAIN_ID = "dorado-1"
+
+DEFAULT_REQUEST_TIMEOUT = 30
 AUTH_SERVER = os.environ.get("AUTH_SERVER", "https://accounts.fetch.ai/v1")
 MEMORANDUM_SERVER = os.environ.get(
     "MEMORANDUM_SERVER",

src/babble/config.py

@@ -1 +1 @@
-from .identity import Identity
+from .identity import Identity  # noqa

src/babble/crypto/__init__.py

@@ -7,10 +7,9 @@
 import bech32
 import ecdsa
 from ecdsa.util import sigencode_string_canonize
-from ecies import encrypt, decrypt
-from ecies.utils import PrivateKey
+from ecies import PrivateKey, decrypt, encrypt
 
-from .hashfuncs import sha256, ripemd160
+from .hashfuncs import ripemd160, sha256
 
 
 def _to_bech32(prefix: str, data: bytes) -> str:

src/babble/crypto/identity.py

@@ -1,6 +1,6 @@
 import base64
 import json
-from typing import Union, Any
+from typing import Any, Union
 
 
 def to_json(data: Any) -> str:

src/babble/encoding.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from datetime import datetime, timezone
-from typing import Optional, Dict, Any, List
+from typing import Any, Dict, List, Optional
 
 import requests
 
@@ -176,7 +176,7 @@ def drop_messages(token: str, ids: List[str]):
         "ids": ids,
     }
 
-    resp = _execute(
+    _ = _execute(
         """
     mutation Mutation($ids: [ID!]!) {
       dropMessages(ids: $ids) {