Merge pull request #12 from Tnmoxa/dev

fix: #8 return empty list

Author: Tnmoxa

celestia/node_api/blob.py

@@ -28,7 +28,7 @@ class BlobClient(Wrapper):
     """ Client for interacting with Celestia's Blob API."""
 
     @handle_blob_error
-    async def get(self, height: int, namespace: Namespace, commitment: Commitment,
+    async def get(self, height: int, namespace: Namespace, commitment: Commitment, *,
                   deserializer: Callable | None = None) -> Blob | None:
         """ Retrieves the blob by commitment under the given namespace and height.
 
@@ -63,12 +63,14 @@ async def get_all(self, height: int, namespace: Namespace, *namespaces: Namespac
             deserializer (Callable | None): Custom deserializer. Defaults to None.
 
         Returns:
-            list[Blob] | None: The list, of blobs or None if not found.
+            list[Blob]: The list of blobs or [] if not found.
         """
 
-        def deserializer_(result):
+        def deserializer_(result) -> list['Blob']:
             if result is not None:
                 return [Blob(**kwargs) for kwargs in result]
+            else:
+                return []
 
         deserializer = deserializer if deserializer is not None else deserializer_
         namespaces = tuple(Namespace(namespace) for namespace in (namespace, *namespaces))
@@ -100,7 +102,7 @@ def deserializer_(height):
         return await self._rpc.call("blob.Submit", (blobs, options), deserializer)
 
     @handle_blob_error
-    async def get_commitment_proof(self, height: int, namespace: Namespace, commitment: Commitment,
+    async def get_commitment_proof(self, height: int, namespace: Namespace, commitment: Commitment, *,
                                    deserializer: Callable | None = None) -> CommitmentProof | None:
         """ Generates a commitment proof for a share commitment.
 
@@ -119,25 +121,32 @@ async def get_commitment_proof(self, height: int, namespace: Namespace, commitme
         return await self._rpc.call("blob.GetCommitmentProof", (height, Namespace(namespace), Commitment(commitment)),
                                     deserializer)
 
-    @handle_blob_error
-    async def get_proof(self, height: int, namespace: Namespace, commitment: Commitment,
+    async def get_proof(self, height: int, namespace: Namespace, commitment: Commitment, *,
                         deserializer: Callable | None = None) -> list[Proof] | None:
         """ Retrieves proofs in the given namespaces at the given height by commitment.
 
         Args:
             height (int): The block height.
             namespace (Namespace): The namespace of the proof.
             commitment (Commitment): The commitment to generate the proof for.
-            deserializer (Callable | None): Custom deserializer. Defaults to :meth:`~celestia.types.blob.Proof.deserializer`.
+            deserializer (Callable | None): Custom deserializer. Defaults to None.
 
         Returns:
-            list[Proof] | None: A list of proofs, or None if not found.
+            list[Proof]: A list of proofs or [] if not found.
         """
 
-        deserializer = deserializer if deserializer is not None else Proof.deserializer
+        def deserializer_(result) -> list['Proof']:
+            if result is not None:
+                return [Proof(**kwargs) for kwargs in result]
 
-        return await self._rpc.call("blob.GetProof", (height, Namespace(namespace), Commitment(commitment)),
-                                    deserializer)
+        deserializer = deserializer if deserializer is not None else deserializer_
+        try:
+            return await self._rpc.call("blob.GetProof", (height, Namespace(namespace), Commitment(commitment)),
+                                        deserializer)
+        except ConnectionError as e:
+            if 'blob: not found' in e.args[1].body['message'].lower():
+                return []
+            raise
 
     async def included(self, height: int, namespace: Namespace, proof: Proof, commitment: Commitment) -> bool:
         """ Checks whether a blob's given commitment(Merkle subtree root) is
@@ -155,7 +164,7 @@ async def included(self, height: int, namespace: Namespace, proof: Proof, commit
 
         return await self._rpc.call("blob.Included", (height, Namespace(namespace), proof, Commitment(commitment)))
 
-    async def subscribe(self, namespace: Namespace,
+    async def subscribe(self, namespace: Namespace, *,
                         deserializer: Callable | None = None) -> AsyncIterator[SubscriptionBlobResult | None]:
         """ Subscribe to published blobs from the given namespace as they are included.
 

celestia/node_api/das.py

@@ -7,7 +7,7 @@
 class DasClient(Wrapper):
     """ Client for interacting with Celestia's Das API."""
 
-    async def sampling_stats(self, deserializer: Callable | None = None) -> SamplingStats:
+    async def sampling_stats(self, *, deserializer: Callable | None = None) -> SamplingStats:
         """ Returns the current statistics over the DA sampling process.
 
         Args:

celestia/node_api/header.py

@@ -25,7 +25,7 @@ class HeaderClient(Wrapper):
     """ Client for interacting with Celestia's Header API."""
 
     @handle_header_error
-    async def get_by_hash(self, header_hash: str, deserializer: Callable | None = None) -> ExtendedHeader | None:
+    async def get_by_hash(self, header_hash: str, *, deserializer: Callable | None = None) -> ExtendedHeader | None:
         """ Returns the header of the given hash from the node's header store.
 
         Args:
@@ -40,7 +40,7 @@ async def get_by_hash(self, header_hash: str, deserializer: Callable | None = No
 
         return await self._rpc.call("header.GetByHash", (header_hash,), deserializer)
 
-    async def get_by_height(self, height: int, deserializer: Callable | None = None) -> ExtendedHeader:
+    async def get_by_height(self, height: int, *, deserializer: Callable | None = None) -> ExtendedHeader:
         """ Returns the ExtendedHeader at the given height if it is currently available.
 
         Args:
@@ -55,7 +55,7 @@ async def get_by_height(self, height: int, deserializer: Callable | None = None)
 
         return await self._rpc.call("header.GetByHeight", (int(height),), deserializer)
 
-    async def get_range_by_height(self, range_from: ExtendedHeader, range_to: int,
+    async def get_range_by_height(self, range_from: ExtendedHeader, range_to: int, *,
                                   deserializer: Callable | None = None) -> list[ExtendedHeader]:
         """ Returns the given range (from:to) of ExtendedHeaders from the node's header store
         and verifies that the returned headers are adjacent to each other.
@@ -77,7 +77,7 @@ def deserializer_(result):
 
         return await self._rpc.call("header.GetRangeByHeight", (range_from, int(range_to)), deserializer)
 
-    async def local_head(self, deserializer: Callable | None = None) -> ExtendedHeader:
+    async def local_head(self, *, deserializer: Callable | None = None) -> ExtendedHeader:
         """ Returns the ExtendedHeader of the chain head.
 
         Args:
@@ -91,7 +91,7 @@ async def local_head(self, deserializer: Callable | None = None) -> ExtendedHead
 
         return await self._rpc.call("header.LocalHead", (), deserializer)
 
-    async def network_head(self, deserializer: Callable | None = None) -> ExtendedHeader:
+    async def network_head(self, *, deserializer: Callable | None = None) -> ExtendedHeader:
         """ Provides the Syncer's view of the current network head.
 
         Args:
@@ -105,7 +105,7 @@ async def network_head(self, deserializer: Callable | None = None) -> ExtendedHe
 
         return await self._rpc.call("header.NetworkHead", (), deserializer)
 
-    async def subscribe(self, deserializer: Callable | None = None) -> AsyncIterator[ExtendedHeader | None]:
+    async def subscribe(self, *, deserializer: Callable | None = None) -> AsyncIterator[ExtendedHeader | None]:
         """ Subscribes to recent ExtendedHeaders from the network.
 
         Args:
@@ -121,7 +121,7 @@ async def subscribe(self, deserializer: Callable | None = None) -> AsyncIterator
             if subs_header_result is not None:
                 yield subs_header_result
 
-    async def sync_state(self, deserializer: Callable | None = None) -> State:
+    async def sync_state(self, *, deserializer: Callable | None = None) -> State:
         """ Returns the current state of the header Syncer.
 
         Args:
@@ -143,7 +143,7 @@ async def sync_wait(self) -> None:
         """
         return await self._rpc.call("header.SyncWait")
 
-    async def wait_for_height(self, height: int, deserializer: Callable | None = None) -> ExtendedHeader:
+    async def wait_for_height(self, height: int, *, deserializer: Callable | None = None) -> ExtendedHeader:
         """ Blocks until the header at the given height has been processed
         by the store or context deadline is exceeded.
 

celestia/node_api/p2p.py

@@ -7,7 +7,7 @@
 class P2PClient(Wrapper):
     """ Client for interacting with Celestia's P2P API."""
 
-    async def bandwidth_for_peer(self, peer_id: str, deserializer: Callable | None = None) -> BandwidthStats:
+    async def bandwidth_for_peer(self, peer_id: str, *, deserializer: Callable | None = None) -> BandwidthStats:
         """ Returns a Stats struct with bandwidth metrics associated with the given peer.ID.
         The metrics returned include all traffic sent / received for the peer, regardless of protocol.
 
@@ -23,7 +23,7 @@ async def bandwidth_for_peer(self, peer_id: str, deserializer: Callable | None =
 
         return await self._rpc.call("p2p.BandwidthForPeer", (peer_id,), deserializer)
 
-    async def bandwidth_for_protocol(self, protocol_id: str, deserializer: Callable | None = None) -> BandwidthStats:
+    async def bandwidth_for_protocol(self, protocol_id: str, *, deserializer: Callable | None = None) -> BandwidthStats:
         """ Returns a Stats struct with bandwidth metrics associated with the given protocol.ID.
 
         Args:
@@ -38,7 +38,7 @@ async def bandwidth_for_protocol(self, protocol_id: str, deserializer: Callable
 
         return await self._rpc.call("p2p.BandwidthForProtocol", (protocol_id,), deserializer)
 
-    async def bandwidth_stats(self, deserializer: Callable | None = None) -> BandwidthStats:
+    async def bandwidth_stats(self, *, deserializer: Callable | None = None) -> BandwidthStats:
         """ Returns a Stats struct with bandwidth metrics for all data sent/received by the local peer,
         regardless of protocol or remote peer IDs.
 
@@ -88,7 +88,7 @@ async def connectedness(self, peer_id: str) -> Connectedness:
         """
         return await self._rpc.call("p2p.Connectedness", (peer_id,))
 
-    async def info(self, deserializer: Callable | None = None) -> AddrInfo:
+    async def info(self, *, deserializer: Callable | None = None) -> AddrInfo:
         """ Returns address information about the host.
 
         Args:
@@ -130,7 +130,7 @@ async def nat_status(self) -> Reachability:
         """
         return await self._rpc.call("p2p.NATStatus")
 
-    async def peer_info(self, peer_id: str, deserializer: Callable | None = None) -> AddrInfo:
+    async def peer_info(self, peer_id: str, *, deserializer: Callable | None = None) -> AddrInfo:
         """ Returns a small slice of information Peerstore has on the given peer.
 
         Args:
@@ -182,7 +182,7 @@ async def pub_sub_topics(self) -> list[str] | None:
         """
         return await self._rpc.call("p2p.PubSubTopics")
 
-    async def resource_state(self, deserializer: Callable | None = None) -> ResourceManagerStat:
+    async def resource_state(self, *, deserializer: Callable | None = None) -> ResourceManagerStat:
         """ Returns the state of the resource manager.
 
         Args:

celestia/node_api/share.py

@@ -1,6 +1,6 @@
 from typing import Callable
 
-from celestia.types import Namespace, Base64
+from celestia.types import Namespace
 from celestia.types.header import ExtendedHeader
 from celestia.types.share import ExtendedDataSquare, NamespaceData, SampleCoords, GetRangeResult
 from ._RPC import Wrapper
@@ -9,7 +9,7 @@
 class ShareClient(Wrapper):
     """ Client for interacting with Celestia's Share API."""
 
-    async def get_eds(self, height: int, deserializer: Callable | None = None) -> ExtendedDataSquare:
+    async def get_eds(self, height: int, *, deserializer: Callable | None = None) -> ExtendedDataSquare:
         """ Gets the full EDS identified by the given extended header.
 
         Args:
@@ -24,7 +24,7 @@ async def get_eds(self, height: int, deserializer: Callable | None = None) -> Ex
 
         return await self._rpc.call("share.GetEDS", (height,), deserializer)
 
-    async def get_namespace_data(self, height: int, namespace: Namespace,
+    async def get_namespace_data(self, height: int, namespace: Namespace, *,
                                  deserializer: Callable | None = None) -> list[NamespaceData]:
         """ Gets all shares from an EDS within the given namespace. Shares are returned
         in a row-by-row order if the namespace spans multiple rows.
@@ -35,18 +35,20 @@ async def get_namespace_data(self, height: int, namespace: Namespace,
             deserializer (Callable | None): Custom deserializer. Defaults to None.
 
         Returns:
-            list[NamespaceData]: A list of NamespaceData objects.
+            list[NamespaceData]: A list of NamespaceData objects or [] if not found.
         """
 
         def deserializer_(result):
             if result is not None:
                 return [NamespaceData(**data) for data in result]
+            else:
+                return []
 
         deserializer = deserializer if deserializer is not None else deserializer_
 
         return await self._rpc.call("share.GetNamespaceData", (height, Namespace(namespace)), deserializer)
 
-    async def get_range(self, height: int, start: int, end: int,
+    async def get_range(self, height: int, start: int, end: int, *,
                         deserializer: Callable | None = None) -> GetRangeResult:
         """ Gets a list of shares and their corresponding proof.
 
@@ -64,19 +66,20 @@ async def get_range(self, height: int, start: int, end: int,
 
         return await self._rpc.call("share.GetRange", (height, start, end), deserializer)
 
-    async def get_samples(self, header: ExtendedHeader, indices: list[SampleCoords]) -> list[Base64]:
+    async def get_samples(self, header: ExtendedHeader, indices: list[SampleCoords]) -> list[str]:
         """ Gets sample for given indices.
 
         Args:
             header (ExtendedHeader): The extended header.
             indices (list[SampleCoords]): A list of sample coordinates.
 
         Returns:
-            list[Base64]: A list of retrieved samples.
+            list[str]: A list of retrieved samples or [] if not found.
         """
-        return await self._rpc.call("share.GetSamples", (header, indices,))
+        return await self._rpc.call("share.GetSamples", (header, indices,),
+                                    lambda result: result if result is not None else [])
 
-    async def get_share(self, height: int, row: int, col: int) -> Base64:
+    async def get_share(self, height: int, row: int, col: int) -> str:
         """ Gets a Share by coordinates in EDS.
 
         Args:
@@ -85,7 +88,7 @@ async def get_share(self, height: int, row: int, col: int) -> Base64:
             col (int): The column index.
 
         Returns:
-            Base64: The retrieved share.
+            str: The retrieved share.
         """
         return await self._rpc.call("share.GetShare", (height, row, col,))