Merge pull request #3 from SEJeff/start-of-unit-tests

Initial start of unit tests for pyth-client-py

Author: Jeff Schroeder

README.md

@@ -2,3 +2,28 @@ Pyth Client in Python
 =====================
 
 A Python library to retrieve data from Pyth account structures off the Solana blockchain.
+
+**NOTE**: This library requires Python 3.7 or greater due to `from __future__ import annotations`.
+
+
+Developer Setup
+---------------
+
+Using python 3.7 or newer, create, and activate a virtual environment:
+
+    python3 -m venv ve
+    . ve/bin/activate
+
+To install this library in editable mode with test dependencies:
+
+    pip install -e '.[testing]'
+
+To run the unit tests:
+
+    pytest
+
+If html based test coverage is more your jam:
+
+    pytest --cov-report=html
+
+The coverage webpages will be in the `htmlcov` directory.

pytest.ini

@@ -0,0 +1,7 @@
+[pytest]
+addopts =
+    # Prevent SolanaClient from actually reaching out to devnet
+    --disable-socket
+    --allow-unix-socket
+    --cov=pythclient
+    --no-cov-on-fail

pythclient/pythaccounts.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
-from typing import List, Dict, Tuple, Optional, Any
+from typing import List, Dict, Tuple, Optional, Any, ClassVar
 import base64
 from enum import Enum
+from dataclasses import dataclass, field
 import struct
 
 from loguru import logger
@@ -205,7 +206,6 @@ class PythProductAccount(PythAccount):
         first_price_account_key (SolanaPublicKey): the public key of the first price account (the price accounts form a linked list)
         attrs (dict): a dictionary of metadata attributes
     """
-
     def __init__(self, key: SolanaPublicKey, solana: SolanaClient) -> None:
         super().__init__(key, solana)
         self._prices: Optional[Dict[PythPriceType, PythPriceAccount]] = None
@@ -229,7 +229,6 @@ def symbol(self) -> str:
         """
         Gets this account's symbol, or 'Unknown' if there is no 'symbol' attribute.
         """
-
         return self.attrs.get("symbol", "Unknown")
 
     async def get_prices(self) -> Dict[PythPriceType, PythPriceAccount]:
@@ -258,7 +257,10 @@ async def refresh_prices(self) -> Dict[PythPriceType, PythPriceAccount]:
         self._prices = prices
         return prices
 
-    async def check_price_changes(self, update_accounts: bool = True) -> Tuple[List[PythPriceAccount], List[PythPriceAccount]]:
+    async def check_price_changes(
+        self,
+        update_accounts: bool = True
+    ) -> Tuple[List[PythPriceAccount], List[PythPriceAccount]]:
         """
         Checks for changes to the list of price accounts of this product.
 
@@ -345,7 +347,13 @@ def __str__(self) -> str:
     def __repr__(self) -> str:
         return str(self)
 
+    def __iter__(self):
+        for key, val in self.__dict__.items():
+            if not key.startswith('_'):
+                yield key, val
+
 
+@dataclass
 class PythPriceInfo:
     """
     Contains price information.
@@ -360,15 +368,18 @@ class PythPriceInfo:
         exponent (int): the power-of-10 order of the price
     """
 
-    LENGTH = 32
+    LENGTH: ClassVar[int] = 32
 
-    def __init__(self, raw_price: int, raw_confidence_interval: int, price_status: PythPriceStatus, slot: int, exponent: int) -> None:
-        self.raw_price = raw_price
-        self.raw_confidence_interval = raw_confidence_interval
-        self.price_status = price_status
-        self.slot = slot
-        self.exponent = exponent
+    raw_price: int
+    raw_confidence_interval: int
+    price_status: PythPriceStatus
+    slot: int
+    exponent: int
+
+    price: float = field(init=False)
+    confidence_interval: float = field(init=False)
 
+    def __post_init__(self):
         self.price = self.raw_price * (10 ** self.exponent)
         self.confidence_interval = self.raw_confidence_interval * \
             (10 ** self.exponent)
@@ -397,9 +408,11 @@ def __repr__(self) -> str:
         return str(self)
 
 
-class PythPriceComponent: # This has the individual prices each publisher
+@dataclass
+class PythPriceComponent:
     """
-    Represents a price component.
+    Represents a price component. This is the individual prices each
+    publisher sends in addition to their aggregate.
 
     Attributes:
         publisher_key (SolanaPublicKey): the public key of the publisher
@@ -411,13 +424,12 @@ class PythPriceComponent: # This has the individual prices each publisher
             in this price component
     """
 
-    LENGTH = SolanaPublicKey.LENGTH + 2 * PythPriceInfo.LENGTH
+    LENGTH: ClassVar[int] = SolanaPublicKey.LENGTH + 2 * PythPriceInfo.LENGTH
 
-    def __init__(self, publisher_key: SolanaPublicKey, last_aggregate_price_info: PythPriceInfo, latest_price_info: PythPriceInfo, exponent: int) -> None:
-        self.publisher_key = publisher_key
-        self.last_aggregate_price_info = last_aggregate_price_info
-        self.latest_price_info = latest_price_info
-        self.exponent = exponent
+    publisher_key: SolanaPublicKey
+    last_aggregate_price_info: PythPriceInfo
+    latest_price_info: PythPriceInfo
+    exponent: int
 
     @staticmethod
     def deserialise(buffer: bytes, offset: int = 0, *, exponent: int) -> Optional[PythPriceComponent]:
@@ -477,6 +489,7 @@ def __init__(self, key: SolanaPublicKey, solana: SolanaClient, *, product: Optio
         self.aggregate_price_info: Optional[PythPriceInfo] = None
         self.price_components: List[PythPriceComponent] = []
         self.derivations: Dict[TwEmaType, int] = {}
+        self.min_publishers: Optional[int] = None
 
     @property
     def aggregate_price(self) -> Optional[float]:
@@ -501,7 +514,8 @@ def update_from(self, buffer: bytes, *, version: int, offset: int = 0) -> None:
             unused (u32)
             currently accumulating price slot (u64)
             slot of current aggregate price (u64)
-            derivations (u64[8] - array index corresponds to (DeriveType - 1) - v2 only)
+            derivations (u64[6] - array index corresponds to (DeriveType - 1) - v2 only)
+            unused derivation values and minimum publishers (u64[2], i32[2], )
             product account key (char[32])
             next price account key (char[32])
             account key of quoter who computed last aggregate price (char[32])
@@ -510,19 +524,22 @@ def update_from(self, buffer: bytes, *, version: int, offset: int = 0) -> None:
         """
         if version == _VERSION_2:
             price_type, exponent, num_components = struct.unpack_from("<IiI", buffer, offset)
-            offset += 16 # struct.calcsize("IiII") (last I unused)
+            offset += 16  # struct.calcsize("IiII") (last I is the number of quoters that make up the aggregate)
             last_slot, valid_slot = struct.unpack_from("<QQ", buffer, offset)
-            offset += 16 # QQ
-            derivations = list(struct.unpack_from("<8q", buffer, offset))
+            offset += 16  # QQ
+            derivations = list(struct.unpack_from("<6q", buffer, offset))
             self.derivations = dict((type_, derivations[type_.value - 1]) for type_ in [TwEmaType.TWACVALUE, TwEmaType.TWAPVALUE])
-            offset += 64 # 8q
+            offset += 48  # 6q
+            # All drv*_ fields sans min_publishers are currently unused
+            _, min_publishers = struct.unpack_from("<qQ", buffer, offset)
+            offset += 16  # <qQ
             product_account_key_bytes, next_price_account_key_bytes = struct.unpack_from("32s32s", buffer, offset)
-            offset += 96 # 32s32s32s
+            offset += 96  # 32s32s32s
         elif version == _VERSION_1:
             price_type, exponent, num_components, _, last_slot, valid_slot, product_account_key_bytes, next_price_account_key_bytes, aggregator_key_bytes = struct.unpack_from(
                 "<IiIIQQ32s32s32s", buffer, offset)
             self.derivations = {}
-            offset += 128 # struct.calcsize("<IiIIQQ32s32s32s")
+            offset += 128  # struct.calcsize("<IiIIQQ32s32s32s")
         else:
             assert False
 
@@ -552,6 +569,7 @@ def update_from(self, buffer: bytes, *, version: int, offset: int = 0) -> None:
             next_price_account_key_bytes)
         self.aggregate_price_info = aggregate_price_info
         self.price_components = price_components
+        self.min_publishers = min_publishers
 
     def __str__(self) -> str:
         if self.product:

setup.py

@@ -1,10 +1,16 @@
 from setuptools import setup
 
+requirements = ['aiodns', 'aiohttp', 'backoff', 'base58', 'loguru']
+
 setup(
     name='pythclient',
-    version='0.0.1',
+    version='0.0.2',
     packages=['pythclient'],
     author='Pyth Developers',
     author_email='[email protected]',
-    install_requires=['aiodns', 'aiohttp', 'backoff', 'base58', 'loguru']
+    install_requires=requirements,
+    extras_require={
+        'testing': requirements + ['mock', 'pytest', 'pytest-cov', 'pytest-socket'],
+    },
+    python_requires='>=3.7.0',
 )

tests/conftest.py

@@ -0,0 +1,10 @@
+import pytest
+from pythclient.solana import SolanaClient
+
+
+@pytest.fixture
+def solana_client():
+    return SolanaClient(
+        endpoint="https://example.com",
+        ws_endpoint="wss://example.com",
+    )

tests/test_mapping_account.py

@@ -0,0 +1,92 @@
+import base64
+import pytest
+
+from pythclient.pythaccounts import PythMappingAccount, _VERSION_2
+from pythclient.solana import SolanaPublicKey
+
+
+@pytest.fixture
+def mapping_account_bytes():
+    """
+    Put a debugger breakpoint in PythMappingAccount.update_from() at the top.
+    Get the mapping account number of entries and 3 keys:
+
+        fmt_size = struct.calcsize(fmt)
+        intermediate_buffer = buffer[offset:offset + fmt_size + (SolanaPublicKey.LENGTH * 3)]
+
+    Replace the num_keys bytes with 3:
+
+        num_entries_bytes = int(3).to_bytes(4, 'little')
+        product_account_bytes = num_entries_bytes + intermediate_buffer[struct.calcsize("<I"):]
+
+    Render those into a pasteable form with:
+
+        print(base64.b6encode(product_account_bytes))
+
+    """
+    return base64.b64decode((
+        b'AwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEjWAz1zPieVDC4DUeJQVJHNkVSCT3FtlRNRT'
+        b'HS5+Y9YyAwLFIq6mUslZupUp4/wjvo9Xg7D0M7qDPqgP+wl7qI1FbOGHo/pPl9UC6QHfCFkBHgrhtXngHezy/0nMT'
+        b'qzvA=='
+    ))
+
+
+@pytest.fixture
+def entries():
+    return [
+        SolanaPublicKey("5uKdRzB3FzdmwyCHrqSGq4u2URja617jqtKkM71BVrkw"),
+        SolanaPublicKey("ETuC4VK6kuHfxc9MCU14dASfnGBfzgFUVCs1oVowawHb"),
+        SolanaPublicKey("4aDoSXJ5o3AuvL7QFeR6h44jALQfTmUUCTVGDD6aoJTM"),
+    ]
+
+
+@pytest.fixture
+def mapping_account(solana_client):
+    return PythMappingAccount(
+        key=SolanaPublicKey("AHtgzX45WTKfkPG53L6WYhGEXwQkN1BVknET3sVsLL8J"),
+        solana=solana_client,
+    )
+
+
+def test_mapping_account_update_from(
+    solana_client, mapping_account, mapping_account_bytes, entries
+):
+    mapping_account.update_from(
+        buffer=mapping_account_bytes,
+        version=_VERSION_2,
+        offset=0,
+    )
+
+    assert mapping_account.entries == entries
+    assert mapping_account.next_account_key is None
+
+
+def test_mapping_account_upate_from_null_key(
+    solana_client, mapping_account, mapping_account_bytes, entries
+):
+    # Replace the last key with a null key
+    null_key_bytes = b"\0" * SolanaPublicKey.LENGTH
+
+    # Length of bytes with the last pubkey trimmed
+    offset = len(mapping_account_bytes) - SolanaPublicKey.LENGTH
+
+    # Take the original bytes and add a null key to the end
+    bad_bytes = mapping_account_bytes[:offset] + null_key_bytes
+
+    mapping_account.update_from(
+        buffer=bad_bytes,
+        version=_VERSION_2,
+        offset=0,
+    )
+
+    # The last key in the list is null, so remove it
+    expected = entries[:-1]
+
+    assert mapping_account.entries == expected
+    assert mapping_account.next_account_key is None
+
+
+def test_mapping_account_str(mapping_account, solana_client):
+    actual = str(mapping_account)
+    expected = f"PythMappingAccount ({mapping_account.key})"
+    assert actual == expected