chore: addressed issues in PR comments

Author: elijah0kello

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test Python open payments sdk f
+name: Test Python open payments sdk
 
 on:
   push:
@@ -10,11 +10,12 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
-        python-version: [3.11, 3.12, 3.13]
+        os: [ubuntu-latest, windows-latest]
+        python-version: [3.9,3.10,3.11, 3.12, 3.13]
 
     steps:
       - name: Checkout code
@@ -25,13 +26,10 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install Poetry
+      - name: Setup Poetry
         run: |
           curl -sSL https://install.python-poetry.org | python3 -
           echo "$HOME/.local/bin" >> $GITHUB_PATH
-
-      - name: Configure Poetry
-        run: |
           poetry config virtualenvs.create false
 
       - name: Install dependencies
@@ -42,3 +40,14 @@ jobs:
       - name: Run Unit Tests
         run: |
           poetry run pytest tests/unit/
+          
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: |
+          python3 -m pip install .  # assumes dependencies declared in pyproject.toml
+          python3 -m pip install pip-audit
+      - name: Run pip-audit
+        run: pip-audit .

.gitignore

@@ -170,4 +170,4 @@ poetry.toml
 pyrightconfig.json
 
 # End of https://www.toptal.com/developers/gitignore/api/python
-privkey.pem
+privkey.pem

README.md

@@ -21,43 +21,47 @@ An Open Payments server runs two sub-systems, a resource server which exposes AP
 
 ## Local development
 
-
-
 - Python >= 3.11
 
   To install python visit [Python Download](https://www.python.org/downloads/)
+
 - Poetry
   To install poetry visit [Poetry Documentation](https://python-poetry.org/docs/).
 
 ### Installation
 
-1. Activate your virtual emvironment. No need to create one, Poetry creates one. 
+1. Activate your virtual emvironment. No need to create one, Poetry creates one.
    Read [managing environments in Poetry](https://python-poetry.org/docs/managing-environments/).
 
-
 2. Install the dependencies in the poetry.lock
 
 ```
 > poetry install
 ```
-## Usage 
-To use this sdk, you will first need to install it in your project.  Currently you will need to build from source but once it is hosted on pypi you will be able to install it with pip
+
+## Usage
+
+To use this SDK, you will first need to install it in your project. Currently, you will need to build from source but once it is hosted on PyPi you will be able to install it with `pip`.
 
 ```bash
 python3 -m pip install open-payments-python-sdk #currently not setup
 ```
+
 ## Installing from source
 
-Clone the repository 
+Clone the repository
+
 ```bash
 git clone https://github.com/interledger/open-payments-python-sdk.git
 cd open-payments-python-sdk
 ```
 
 Build the package
+
 ```bash
 poetry build
 ```
+
 After running this command, the wheel package will be written to the `dist/` folder in the repo you just cloned
 
 Install it in your project
@@ -67,6 +71,7 @@ pip install </path/to/>open-payments-python-sdk/dist/open_payments_sdk-0.1.0-py3
 ```
 
 # Initialising the Client
+
 To create a client you can do so by importing the `OpenPaymentsClient` defined in the [`client`](./src/client/client.py) module and instantiating it.
 
 ```python
@@ -106,8 +111,10 @@ private_key = key_manager.load_ed25519_private_key_from_pem(
 
 public_key = private_key.public_key() # derive public key from private key
 ```
+
 ## Wallets
-You can use the created client to interact with the resource server. In this case we will use it to interact with a wallet address to get the wallet address details and jwks.json 
+
+You can use the created client to interact with the resource server. In this case we will use it to interact with a wallet address to get the wallet address details and jwks.json
 
 ```python
 #get wallet address
@@ -117,6 +124,7 @@ wallet_address_details = op_client.wallet.get_wallet_address("https://ilp.interl
 {'id': AnyUrl('https://ilp.interledger-test.dev/elijahokellosalary'), 'publicName': 'elijahokellosalary', 'assetCode': AssetCode(root='USD'), 'assetScale': AssetScale(root=2), 'authServer': AnyUrl('https://auth.interledger-test.dev/'), 'resourceServer': AnyUrl('https://ilp.interledger-test.dev/')}
 
 ```
+
 Get Wallet jwks
 
 ```python
@@ -129,6 +137,7 @@ wallet_jwks = op_client.wallet.get_keys("https://ilp.interledger-test.dev/elijah
 ```
 
 ## Grants
+
 You can use the created client to request a grant from the authorization server. In this case we will use it to request a grant for an incoming payment resource. Check the [fixtures](./tests/conftest.py) file to see the request body.
 
 ```python

src/open_payments_sdk/api/auth.py

@@ -5,10 +5,10 @@
 
 from open_payments_sdk.gnap_utils.security import SecurityBase
 from open_payments_sdk.http import HttpClient
-from open_payments_sdk.models.auth import AccessToken
-from open_payments_sdk.models.auth import Grant as AuthGrant
+from open_payments_sdk.models.auth import AccessToken, Grant
 from open_payments_sdk.models.auth import (GrantContinueResponse, GrantRequest,
                                            InteractRef)
+from open_payments_sdk.utils.utils import get_default_covered_components, get_default_headers
 
 
 
@@ -25,14 +25,14 @@ def post_grant_request(
             self,
             grant_request: GrantRequest,
             auth_server_endpoint: str,
-        ) -> AuthGrant:
+        ) -> Grant:
         """
         Grant Request
         """
         data = grant_request.model_dump(exclude_unset=True, mode="json")
 
         req_headers = {
-            **self.get_default_headers()
+            **get_default_headers()
         }
         request = self.http_client.build_request(
             method="POST",
@@ -41,9 +41,9 @@ def post_grant_request(
             headers=req_headers
         )
         request = self.set_content_digest(request=request)
-        request = self.sign_request(request,("content-type","content-digest","content-length",*self.get_default_covered_components()))
+        request = self.sign_request(request,("content-type","content-digest","content-length",*get_default_covered_components()))
         response = self.http_client.send(request=request)
-        return response.json()
+        return Grant.model_validate(response.json())
 
     def post_grant_continuation_request(
             self,
@@ -56,7 +56,7 @@ def post_grant_continuation_request(
         """
         data = interact_ref.model_dump(exclude_unset=True, mode="json")
         req_headers = {
-            **self.get_default_headers(),
+            **get_default_headers(),
             **self.get_auth_header(access_token=access_token)
         }
         request = self.http_client.build_request(
@@ -66,7 +66,7 @@ def post_grant_continuation_request(
             headers=req_headers
         )
         request = self.set_content_digest(request=request)
-        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return GrantContinueResponse.model_validate(response.json())
 
@@ -89,7 +89,7 @@ def delete_grant(
             url=url,
             headers=req_headers
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         self.http_client.send(request=request)
 
 class AccessTokens(SecurityBase):
@@ -119,7 +119,7 @@ def post_rotate_access_token(
             url=url,
             headers=req_headers
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return AccessToken.model_validate(response.json())
 
@@ -143,5 +143,5 @@ def delete_access_token(
             url=url,
             headers=req_headers
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         self.http_client.send(request=request)

src/open_payments_sdk/api/resource.py

@@ -13,6 +13,7 @@
                                                PaginatedOutgoingPayments,
                                                PaymentListQuery, Quote,
                                                QuoteRequest)
+from open_payments_sdk.utils.utils import get_default_covered_components, get_default_headers
 
 
 class IncomingPayments(SecurityBase):
@@ -36,7 +37,7 @@ def post_create_payment(
         url = f"{base_url}/incoming-payments"
         data = payment.model_dump(exclude_unset=True, mode="json")
         req_headers = {
-            **self.get_default_headers(),
+            **get_default_headers(),
             **self.get_auth_header(access_token=access_token)
         }
         request = self.http_client.build_request(
@@ -46,7 +47,7 @@ def post_create_payment(
             headers=req_headers
         )
         request = self.set_content_digest(request=request)
-        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return IncomingPayment.model_validate(response.json())
 
@@ -70,7 +71,7 @@ def get_incoming_payments(
             headers=req_headers,
             params=query_params
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return PaginatedIncomingPayments.model_validate(response.json())
 
@@ -93,7 +94,7 @@ def get_incoming_payment(
             url=url,
             headers=req_headers
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return IncomingPaymentResponse.model_validate(response.json())
 
@@ -116,7 +117,7 @@ def post_complete_incoming_payment(
             url=url,
             headers=req_headers
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return IncomingPayment.model_validate(response.json())
 
@@ -141,7 +142,7 @@ def post_create_payment(
         url = f"{base_url}/outgoing-payments"
         data = payment.model_dump(exclude_unset=True, mode="json")
         req_headers = {
-            **self.get_default_headers(),
+            **get_default_headers(),
             **self.get_auth_header(access_token=access_token)
         }
         request = self.http_client.build_request(
@@ -151,7 +152,7 @@ def post_create_payment(
             headers=req_headers
         )
         request = self.set_content_digest(request=request)
-        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return OutgoingPayment.model_validate(response.json())
 
@@ -176,7 +177,7 @@ def get_outgoing_payments(
             headers=req_headers,
             params=query_params
         )
-        response = request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        response = request = self.sign_request(request,("authorization",*get_default_covered_components()))
         self.http_client.send(request=request)
         return PaginatedOutgoingPayments.model_validate(response.json())
 
@@ -198,7 +199,7 @@ def get_outgoing_payment(
             url=url,
             headers=req_headers
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return OutgoingPayment.model_validate(response.json())
 
@@ -223,7 +224,7 @@ def post_create_quote(
         url = f"{base_url}/quotes"
         data = quote.model_dump(exclude_unset=True, mode="json")
         req_headers = {
-            **self.get_default_headers(),
+            **get_default_headers(),
             **self.get_auth_header(access_token=access_token)
         }
         request = self.http_client.build_request(
@@ -233,7 +234,7 @@ def post_create_quote(
             json=data
         )
         request = self.set_content_digest(request=request)
-        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("content-type","content-digest","content-length","authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return Quote.model_validate(response.json())
 
@@ -256,6 +257,6 @@ def get_quote(
             url=url,
             headers=req_headers
         )
-        request = self.sign_request(request,("authorization",*self.get_default_covered_components()))
+        request = self.sign_request(request,("authorization",*get_default_covered_components()))
         response = self.http_client.send(request=request)
         return Quote.model_validate(response.json())

src/open_payments_sdk/gnap_utils/keys.py

@@ -43,15 +43,15 @@ def generate_key_pair(self) -> KeyPair:
         keypair = KeyPair(jwks=key_jwks, private_key_pem=private_key_pem)
         return KeyPair.model_validate(keypair)
 
-    def load_ed25519_private_key_from_pem(self,pem_str: Union[str, bytes]) -> Ed25519PrivateKey:
+    def load_ed25519_private_key_from_pem(self,pem_bytes: Union[str, bytes]) -> Ed25519PrivateKey:
         """
         Read private key from str or bytes string
         """
-        if isinstance(pem_str,str):
-            pem_str = pem_str.encode("utf-8")
+        if isinstance(pem_bytes,str):
+            pem_bytes = pem_bytes.encode("utf-8")
 
         private_key = serialization.load_pem_private_key(
-            data=pem_str,
+            data=pem_bytes,
             password=None
         )
 

src/open_payments_sdk/gnap_utils/security.py

@@ -44,20 +44,6 @@ def sign_request(self, message: Request, covered_component_ids: Sequence[str] )-
             label="sig1"
         )
         return message
-
-    def get_default_headers(self) -> dict:
-        """
-        Get default headers
-        """
-        return {
-            "Content-Type": "application/json"
-        }
-
-    def get_default_covered_components(self) -> tuple:
-        """
-        Return default covered components
-        """
-        return ("@method","@target-uri")
 
     def set_content_digest(self, request: Request) -> Request:
         """