Merge pull request #9 from derivexyz/fix/cicd

fix: poetry cicd

Author: joshpwrk

.github/workflows/publish-to-pypi.yml

@@ -4,7 +4,10 @@ on: push
 jobs:
   build:
     name: Build distribution 📦
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
     runs-on: ubuntu-latest
+    permissions:
+      contents: write  # IMPORTANT: mandatory for trusted publishing
 
     steps:
     - uses: actions/checkout@v4
@@ -13,43 +16,24 @@ jobs:
       with:
         python-version: "3.9"
 
-    - name: Install project dependencies
-      run: pip install -r requirements.txt
+    - name: Install Poetry
+      run: |
+        curl -sSL https://install.python-poetry.org | python3 -
+        echo "$HOME/.local/bin" >> $GITHUB_PATH
 
-    - name: Install pypa/build 
-      run: >-
-        python3 -m
-        pip install
-        build
-        --user
+    - name: Configure Poetry
+      run: |
+        poetry config pypi-token.pypi $PYPI_TOKEN
+      env:
+        PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
-    - name: Build a binary wheel and a source tarball
-      run: python3 -m build
+    - name: Install project dependencies
+      run: poetry install
 
-    - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
-      with:
-        name: python-package-distributions
-        path: dist/
+    - name: Publish to PyPI
+      run: poetry build
+      env:
+        PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
-  publish-to-pypi:
-    name: >-
-      Publish Python 🐍 distribution 📦 to PyPI
-    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
-    needs:
-    - build
-    runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/p/derive_action_signing  # Replace <package-name> with your PyPI project name
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
-
-    steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v3
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+    - name: Publish to PyPI
+      run: poetry publish

.github/workflows/unit-test.yml

@@ -13,21 +13,15 @@ jobs:
       with:
         python-version: "3.9"
 
-    - name: Install pytest
-      run: >-
-        python3 -m
-        pip install
-        pytest requests
-        --user
+    - name: Install Poetry
+      run: |
+        curl -sSL https://install.python-poetry.org | python3 -
+        echo "$HOME/.local/bin" >> $GITHUB_PATH
 
-    - name: Install project dependencies
-      run: pip install -r requirements.txt
 
-    - name: Install current package
-      run: pip install .
+    - name: Install project dependencies
+      run: poetry install
 
-    - name: Print installed packages
-      run: pip list
 
     - name: Unit-Test
-      run: pytest -s
+      run: poetry run pytest -s

README.md

@@ -60,5 +60,7 @@ Thank you 8baller for building a full Python client for the v2 API. Much of the
 
 ## Developers
 
-1. Create venv and run `pip install -e .`, this reflects changes in package immediately in venv
-2. Install dev related packages with `pip install -r requirements-dev.txt`
+1. Install Poetry: curl -sSL https://install.python-poetry.org | python3 -
+2. `poetry install`
+3. `poetry shell` (activate venv)
+4. `pytest`

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "derive_action_signing"
-version = "0.0.8"
+version = "0.0.9"
 authors = [
   "Derive.xyz <[email protected]>",
   "8baller <[email protected]>"
@@ -15,8 +15,8 @@ classifiers = [
 ]
 
 [tool.poetry.urls]
-homepage = "https://github.com/derivexyz/v2-action-signing-python"
-repository = "https://github.com/derivexyz/v2-action-signing-python"
+Homepage = "https://github.com/derivexyz/v2-action-signing-python"
+Repository = "https://github.com/derivexyz/v2-action-signing-python"
 
 [tool.poetry.dependencies]
 python = ">=3.9,<4.0"
@@ -25,6 +25,7 @@ web3 = ">=6.4.0,<7.0.0"
 hexbytes = ">=0.3.1"
 eth-account = ">=0.13.4"
 setuptools = "^75.8.0"
+eth-typing = "4.0.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=3.0"

pyproject.toml

@@ -51,24 +51,17 @@ def live_instrument_ticker():
     """
     Return all live ETH option tickers and extract sub_id.
     """
-    url = "https://api-demo.lyra.finance/public/get_instruments"
-    payload = {
-        "expired": False,
-        "instrument_type": "option",
-        "currency": "ETH",
-    }
-    response = requests.post(
-        url, json=payload, headers={"accept": "application/json", "content-type": "application/json"}
-    )
-
-    return response.json()["result"][0]
+    return _get_live_instrument_ticker(nth=0)
 
 
 @pytest.fixture(scope="module")
 def second_live_instrument_ticker():
     """
     Return all live ETH option tickers and extract sub_id.
     """
+    return _get_live_instrument_ticker(nth=1)
+
+def _get_live_instrument_ticker(nth=0):
     url = "https://api-demo.lyra.finance/public/get_instruments"
     payload = {
         "expired": False,
@@ -79,4 +72,12 @@ def second_live_instrument_ticker():
         url, json=payload, headers={"accept": "application/json", "content-type": "application/json"}
     )
 
-    return response.json()["result"][1]
+    # return the first is_active true instrument
+    for instrument in response.json()["result"]:
+        if instrument["is_active"]:
+            nth -= 1
+        
+        if nth == -1:
+            return instrument
+
+    raise ValueError("No active instrument found")

requirements-dev.txt

@@ -73,6 +73,7 @@ def test_sign_order(
         },
     )
 
+    print("test sign order response", response.json())
     results = response.json()["result"]
 
     assert ("0x" + action._get_action_hash().hex()) == results["action_hash"]

requirements.txt

@@ -20,6 +20,32 @@ def test_sign_rfq_execute(
     web3_client = Web3()
     session_key_wallet = web3_client.eth.account.from_key(SESSION_KEY_PRIVATE_KEY)
 
+
+    ########################
+    # Create legs and sort #
+    ########################
+
+    legs = [
+        RFQQuoteDetails(
+            instrument_name=live_instrument_ticker["instrument_name"],
+            direction="sell",
+            asset_address=live_instrument_ticker["base_asset_address"],
+            sub_id=int(live_instrument_ticker["base_asset_sub_id"]),
+            price=Decimal("50"),
+            amount=Decimal("1"),
+        ),
+        RFQQuoteDetails(
+            instrument_name=second_live_instrument_ticker["instrument_name"],
+            direction="buy",
+            asset_address=second_live_instrument_ticker["base_asset_address"],
+            sub_id=int(second_live_instrument_ticker["base_asset_sub_id"]),
+            price=Decimal("100"),
+            amount=Decimal("2"),
+        ),
+    ]
+
+    sorted_legs = list(sorted(legs, key=lambda leg: leg.instrument_name))
+
     #####################
     # Sign order action #
     #####################
@@ -36,24 +62,7 @@ def test_sign_rfq_execute(
         module_data=RFQExecuteModuleData(
             global_direction=global_direction,
             max_fee=Decimal("1000"),
-            legs=[
-                RFQQuoteDetails(
-                    instrument_name=live_instrument_ticker["instrument_name"],
-                    direction="sell",
-                    asset_address=live_instrument_ticker["base_asset_address"],
-                    sub_id=int(live_instrument_ticker["base_asset_sub_id"]),
-                    price=Decimal("50"),
-                    amount=Decimal("1"),
-                ),
-                RFQQuoteDetails(
-                    instrument_name=second_live_instrument_ticker["instrument_name"],
-                    direction="buy",
-                    asset_address=second_live_instrument_ticker["base_asset_address"],
-                    sub_id=int(second_live_instrument_ticker["base_asset_sub_id"]),
-                    price=Decimal("100"),
-                    amount=Decimal("2"),
-                ),
-            ],
+            legs=sorted_legs,
         ),
         DOMAIN_SEPARATOR=domain_separator,
         ACTION_TYPEHASH=action_typehash,
@@ -80,7 +89,7 @@ def test_sign_rfq_execute(
             "content-type": "application/json",
         },
     )
-    print("RESPONSE", response.json())
+    print("test sign rfq quote execute response", response.json())
     results = response.json()["result"]
 
     assert "0x" + action.module_data._encoded_legs().hex() == results["encoded_legs"]

tests/conftest.py

@@ -20,6 +20,30 @@ def test_sign_rfq_quote(
     web3_client = Web3()
     session_key_wallet = web3_client.eth.account.from_key(SESSION_KEY_PRIVATE_KEY)
 
+    ########################
+    # Create legs and sort #
+    ########################
+    legs = [
+        RFQQuoteDetails(
+            instrument_name=live_instrument_ticker["instrument_name"],
+            direction="buy",
+            asset_address=live_instrument_ticker["base_asset_address"],
+            sub_id=int(live_instrument_ticker["base_asset_sub_id"]),
+            price=Decimal("50"),
+            amount=Decimal("1"),
+        ),
+        RFQQuoteDetails(
+            instrument_name=second_live_instrument_ticker["instrument_name"],
+            direction="buy",
+            asset_address=second_live_instrument_ticker["base_asset_address"],
+            sub_id=int(second_live_instrument_ticker["base_asset_sub_id"]),
+            price=Decimal("100"),
+            amount=Decimal("2"),
+        ),
+    ]
+    sorted_legs = list(sorted(legs, key=lambda leg: leg.instrument_name))
+
+
     #####################
     # Sign order action #
     #####################
@@ -36,24 +60,7 @@ def test_sign_rfq_quote(
         module_data=RFQQuoteModuleData(
             global_direction=global_direction,
             max_fee=Decimal("1000"),
-            legs=[
-                RFQQuoteDetails(
-                    instrument_name=live_instrument_ticker["instrument_name"],
-                    direction="buy",
-                    asset_address=live_instrument_ticker["base_asset_address"],
-                    sub_id=int(live_instrument_ticker["base_asset_sub_id"]),
-                    price=Decimal("50"),
-                    amount=Decimal("1"),
-                ),
-                RFQQuoteDetails(
-                    instrument_name=second_live_instrument_ticker["instrument_name"],
-                    direction="buy",
-                    asset_address=second_live_instrument_ticker["base_asset_address"],
-                    sub_id=int(second_live_instrument_ticker["base_asset_sub_id"]),
-                    price=Decimal("100"),
-                    amount=Decimal("2"),
-                ),
-            ],
+            legs=sorted_legs,
         ),
         DOMAIN_SEPARATOR=domain_separator,
         ACTION_TYPEHASH=action_typehash,
@@ -64,7 +71,7 @@ def test_sign_rfq_quote(
     assert action.signature is not None
 
     ############################
-    # compare with debug route #
+    # Compare with debug route #
     ############################
 
     response = requests.post(
@@ -80,6 +87,8 @@ def test_sign_rfq_quote(
             "content-type": "application/json",
         },
     )
+
+    print("test sign rfq quote response", response.json())
     results = response.json()["result"]
     assert "0x" + action.module_data.to_abi_encoded().hex() == results["encoded_data"]
     assert "0x" + action._get_action_hash().hex() == results["action_hash"]