doublezero-serviceability 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

{doublezero_serviceability-0.0.2.dist-info → doublezero_serviceability-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: doublezero-serviceability
-Version: 0.0.2
+Version: 0.0.3
 Summary: DoubleZero Serviceability SDK
 Requires-Python: >=3.10
 Requires-Dist: borsh-incremental

{doublezero_serviceability-0.0.2.dist-info → doublezero_serviceability-0.0.3.dist-info}/RECORD

@@ -1,14 +1,14 @@
 serviceability/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-serviceability/client.py,sha256=3FYGJqIgkRm-Kc7DrckXVPreIZQP_ozn9lt8mUDnNQY,2335
+serviceability/client.py,sha256=ZMIh2l1izE--Gb5C5HmIfLqwBpwCYwoJxyw-smE1-_w,4545
 serviceability/config.py,sha256=F04WS56QdiS1Uj_QnkkIsHaLi-RLLNS9BTxao-Gt5yo,690
 serviceability/pda.py,sha256=wWEruxwSAiVCzrZXdDd_hfR3udTMGZQgqxcp99_tHaY,739
 serviceability/rpc.py,sha256=G7GPRl0DM3x3p6B3NTdIgjDJTljwCat9-C_XKL5wXwM,1548
-serviceability/state.py,sha256=ekUD4rprfo4ipmBNWgUNBsCrjFJeFH0_wIKUU0-OeKA,23905
+serviceability/state.py,sha256=ySQ4ao_J28hHYTwq_dBa4uc6P-cymKPmNQrw6X9RGAo,24489
 serviceability/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-serviceability/tests/test_compat.py,sha256=H2N1iTJWxovhIIy1nJIPpTFhL3eiNNcoiT1DCPZExtA,4903
+serviceability/tests/test_compat.py,sha256=LubP9He3qPJDGm2jgX0if7IK6QxJrGCARI6ReJ0pXAA,6321
 serviceability/tests/test_enum_strings.py,sha256=hL-WoPRg2xa32UdxOq3GAyiyoEqQc2HyrC7winDoXgk,3448
-serviceability/tests/test_fixtures.py,sha256=9Tit9fyyADbE4KdPg5_IMv9VPk39Ge4obGGYLuW209Q,11132
+serviceability/tests/test_fixtures.py,sha256=z7LnBiIFbCSTxHCd5qLiWfHz4wmfQSC8otHgYaDHLB8,11132
 serviceability/tests/test_pda.py,sha256=9uOGU821Y98J6JdvZ6AiESvN9leYDT8K8vNmCqqfCGs,998
-doublezero_serviceability-0.0.2.dist-info/METADATA,sha256=SF8DeKOgoNBawRmDozmk611qzk3IiK1t1wozZzzPVbs,249
-doublezero_serviceability-0.0.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-doublezero_serviceability-0.0.2.dist-info/RECORD,,
+doublezero_serviceability-0.0.3.dist-info/METADATA,sha256=mkI0LHGaGSrL-bkjo6ZIUMDmMg2jrAL-fo6A_8uxi_c,249
+doublezero_serviceability-0.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+doublezero_serviceability-0.0.3.dist-info/RECORD,,

serviceability/client.py

@@ -83,3 +83,55 @@ class Client:
     @classmethod
     def localnet(cls) -> Client:
         return cls.from_env("localnet")
+
+    def get_program_data(self) -> ProgramData:
+        """Fetch all program accounts and deserialize them by type."""
+        from solana.rpc.types import MemcmpOpts  # type: ignore[import-untyped]
+        from serviceability.state import AccountTypeEnum
+
+        resp = self._solana_rpc.get_program_accounts(
+            self._program_id,
+            encoding="base64",
+        )
+
+        pd = ProgramData()
+        for acct in resp.value:
+            data = bytes(acct.account.data)
+            if len(data) == 0:
+                continue
+
+            account_type = data[0]
+            pubkey = acct.pubkey
+
+            if account_type == AccountTypeEnum.GLOBAL_STATE:
+                pd.global_state = GlobalState.from_bytes(data)
+            elif account_type == AccountTypeEnum.GLOBAL_CONFIG:
+                pd.global_config = GlobalConfig.from_bytes(data)
+            elif account_type == AccountTypeEnum.LOCATION:
+                loc = Location.from_bytes(data)
+                pd.locations.append(loc)
+            elif account_type == AccountTypeEnum.EXCHANGE:
+                ex = Exchange.from_bytes(data)
+                pd.exchanges.append(ex)
+            elif account_type == AccountTypeEnum.DEVICE:
+                dev = Device.from_bytes(data)
+                pd.devices.append(dev)
+            elif account_type == AccountTypeEnum.LINK:
+                lk = Link.from_bytes(data)
+                pd.links.append(lk)
+            elif account_type == AccountTypeEnum.USER:
+                user = User.from_bytes(data)
+                pd.users.append(user)
+            elif account_type == AccountTypeEnum.MULTICAST_GROUP:
+                mg = MulticastGroup.from_bytes(data)
+                pd.multicast_groups.append(mg)
+            elif account_type == AccountTypeEnum.PROGRAM_CONFIG:
+                pd.program_config = ProgramConfig.from_bytes(data)
+            elif account_type == AccountTypeEnum.CONTRIBUTOR:
+                contrib = Contributor.from_bytes(data)
+                pd.contributors.append(contrib)
+            elif account_type == AccountTypeEnum.ACCESS_PASS:
+                ap = AccessPass.from_bytes(data)
+                pd.access_passes.append(ap)
+
+        return pd

serviceability/state.py

@@ -1,8 +1,8 @@
 """On-chain account data structures for the serviceability program.
 
 Binary layout uses Borsh serialization with a 1-byte AccountType discriminator
-as the first byte. Deserialization uses cursor-based IncrementalReader from
-borsh_incremental.
+as the first byte. Deserialization uses cursor-based DefensiveReader from
+borsh_incremental which returns defaults on missing data.
 """
 
 from __future__ import annotations
@@ -10,24 +10,19 @@ from __future__ import annotations
 from dataclasses import dataclass, field
 from enum import IntEnum
 
-from borsh_incremental import IncrementalReader
+from borsh_incremental import DefensiveReader
 from solders.pubkey import Pubkey  # type: ignore[import-untyped]
 
 
-def _read_pubkey(r: IncrementalReader) -> Pubkey:
+def _read_pubkey(r: DefensiveReader) -> Pubkey:
     return Pubkey.from_bytes(r.read_pubkey_raw())
 
 
-def _read_pubkey_vec(r: IncrementalReader) -> list[Pubkey]:
+def _read_pubkey_vec(r: DefensiveReader) -> list[Pubkey]:
     raw = r.read_pubkey_raw_vec()
     return [Pubkey.from_bytes(b) for b in raw]
 
 
-def _try_read_pubkey_vec(r: IncrementalReader) -> list[Pubkey]:
-    raw = r.try_read_pubkey_raw_vec([])
-    return [Pubkey.from_bytes(b) for b in raw]
-
-
 # ---------------------------------------------------------------------------
 # Account type discriminants
 # ---------------------------------------------------------------------------
@@ -361,9 +356,20 @@ class MulticastGroupStatus(IntEnum):
 class AccessPassTypeTag(IntEnum):
     PREPAID = 0
     SOLANA_VALIDATOR = 1
+    SOLANA_RPC = 2
+    SOLANA_MULTICAST_PUBLISHER = 3
+    SOLANA_MULTICAST_SUBSCRIBER = 4
+    OTHERS = 5
 
     def __str__(self) -> str:
-        _names = {0: "prepaid", 1: "solana_validator"}
+        _names = {
+            0: "prepaid",
+            1: "solana_validator",
+            2: "solana_rpc",
+            3: "solana_multicast_publisher",
+            4: "solana_multicast_subscriber",
+            5: "others",
+        }
         return _names.get(self.value, "unknown")
 
 
@@ -451,7 +457,7 @@ class GlobalState:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> GlobalState:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         gs = cls()
         gs.account_type = r.read_u8()
         gs.bump_seed = r.read_u8()
@@ -464,7 +470,7 @@ class GlobalState:
         gs.contributor_airdrop_lamports = r.read_u64()
         gs.user_airdrop_lamports = r.read_u64()
         gs.health_oracle_pk = _read_pubkey(r)
-        gs.qa_allowlist = _try_read_pubkey_vec(r)
+        gs.qa_allowlist = _read_pubkey_vec(r)
         return gs
 
 
@@ -482,7 +488,7 @@ class GlobalConfig:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> GlobalConfig:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         gc = cls()
         gc.account_type = r.read_u8()
         gc.owner = _read_pubkey(r)
@@ -513,7 +519,7 @@ class Location:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> Location:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         loc = cls()
         loc.account_type = r.read_u8()
         loc.owner = _read_pubkey(r)
@@ -548,7 +554,7 @@ class Exchange:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> Exchange:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         ex = cls()
         ex.account_type = r.read_u8()
         ex.owner = _read_pubkey(r)
@@ -592,7 +598,7 @@ class Device:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> Device:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         dev = cls()
         dev.account_type = r.read_u8()
         dev.owner = _read_pubkey(r)
@@ -644,7 +650,7 @@ class Link:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> Link:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         lk = cls()
         lk.account_type = r.read_u8()
         lk.owner = _read_pubkey(r)
@@ -691,7 +697,7 @@ class User:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> User:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         u = cls()
         u.account_type = r.read_u8()
         u.owner = _read_pubkey(r)
@@ -728,7 +734,7 @@ class MulticastGroup:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> MulticastGroup:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         mg = cls()
         mg.account_type = r.read_u8()
         mg.owner = _read_pubkey(r)
@@ -760,7 +766,7 @@ class ProgramConfig:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> ProgramConfig:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         pc = cls()
         pc.account_type = r.read_u8()
         pc.bump_seed = r.read_u8()
@@ -782,7 +788,7 @@ class Contributor:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> Contributor:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         c = cls()
         c.account_type = r.read_u8()
         c.owner = _read_pubkey(r)
@@ -801,7 +807,9 @@ class AccessPass:
     owner: Pubkey = Pubkey.default()
     bump_seed: int = 0
     access_pass_type_tag: AccessPassTypeTag = AccessPassTypeTag.PREPAID
-    validator_pub_key: Pubkey | None = None
+    associated_pubkey: Pubkey | None = None  # for SolanaValidator, SolanaRPC, SolanaMulticast*
+    others_type_name: str = ""  # for Others variant
+    others_key: str = ""  # for Others variant
     client_ip: bytes = b"\x00" * 4
     user_payer: Pubkey = Pubkey.default()
     last_access_epoch: int = 0
@@ -813,14 +821,23 @@ class AccessPass:
 
     @classmethod
     def from_bytes(cls, data: bytes) -> AccessPass:
-        r = IncrementalReader(data)
+        r = DefensiveReader(data)
         ap = cls()
         ap.account_type = r.read_u8()
         ap.owner = _read_pubkey(r)
         ap.bump_seed = r.read_u8()
-        ap.access_pass_type_tag = AccessPassTypeTag(r.read_u8())
-        if ap.access_pass_type_tag == AccessPassTypeTag.SOLANA_VALIDATOR:
-            ap.validator_pub_key = _read_pubkey(r)
+        tag = r.read_u8()
+        try:
+            ap.access_pass_type_tag = AccessPassTypeTag(tag)
+        except ValueError:
+            ap.access_pass_type_tag = AccessPassTypeTag.PREPAID
+        # Variants 1-4 have an associated pubkey
+        if tag in (1, 2, 3, 4):
+            ap.associated_pubkey = _read_pubkey(r)
+        # Variant 5 (Others) has two strings
+        elif tag == 5:
+            ap.others_type_name = r.read_string()
+            ap.others_key = r.read_string()
         ap.client_ip = r.read_ipv4()
         ap.user_payer = _read_pubkey(r)
         ap.last_access_epoch = r.read_u64()

serviceability/tests/test_compat.py

@@ -143,3 +143,36 @@ class TestCompatGlobalState:
         assert gs.activator_authority_pk != Pubkey.default(), "ActivatorAuthorityPK is zero"
         assert gs.sentinel_authority_pk != Pubkey.default(), "SentinelAuthorityPK is zero"
         # health_oracle_pk may be zero on mainnet
+
+
+class TestCompatGetProgramData:
+    """Test fetching and deserializing all program accounts.
+
+    This is the most comprehensive compat test - it fetches every account
+    owned by the program and deserializes them all, including AccessPass
+    accounts which may have various enum variants and trailing fields.
+    """
+
+    def test_deserialize_all_accounts(self) -> None:
+        skip_unless_compat()
+
+        from serviceability.client import Client
+
+        client = Client.mainnet_beta()
+        pd = client.get_program_data()
+
+        assert pd.global_state is not None, "GlobalState is None"
+        assert pd.global_config is not None, "GlobalConfig is None"
+        assert pd.program_config is not None, "ProgramConfig is None"
+        assert len(pd.locations) > 0, "no locations found on mainnet"
+        assert len(pd.exchanges) > 0, "no exchanges found on mainnet"
+        assert len(pd.devices) > 0, "no devices found on mainnet"
+        assert len(pd.links) > 0, "no links found on mainnet"
+        assert len(pd.contributors) > 0, "no contributors found on mainnet"
+
+        # Log summary for debugging.
+        print(
+            f"\nProgramData: {len(pd.locations)} locations, {len(pd.exchanges)} exchanges, "
+            f"{len(pd.devices)} devices, {len(pd.links)} links, {len(pd.users)} users, "
+            f"{len(pd.contributors)} contributors, {len(pd.access_passes)} access passes"
+        )

serviceability/tests/test_fixtures.py

@@ -304,7 +304,7 @@ class TestFixtureAccessPassValidator:
                 "Owner": ap.owner,
                 "BumpSeed": ap.bump_seed,
                 "AccessPassType": ap.access_pass_type_tag,
-                "AccessPassTypeValidatorPubkey": ap.validator_pub_key,
+                "AccessPassTypeValidatorPubkey": ap.associated_pubkey,
                 "ClientIp": ap.client_ip,
                 "UserPayer": ap.user_payer,
                 "LastAccessEpoch": ap.last_access_epoch,
@@ -316,7 +316,7 @@ class TestFixtureAccessPassValidator:
         assert ap.account_type == 11
         assert ap.bump_seed == 243
         assert ap.access_pass_type_tag == 1
-        assert ap.validator_pub_key == Pubkey.from_string(
+        assert ap.associated_pubkey == Pubkey.from_string(
             "BuP3jEYfnTCfB4UqQk9L37k2vaXsNuVsbWxrYbGDmL6s"
         )
         import ipaddress