Add new APIs to allow efficient retrieval of receipts

Author: cburgdorf

eth/abc.py

@@ -440,7 +440,7 @@ def get_canonical_block_header_by_number(self, block_number: BlockNumber) -> Blo
         """
         Return the block header with the given number in the canonical chain.
 
-        Raise ``BlockNotFound`` if there's no block header with the given number in the
+        Raise ``HeaderNotFound`` if there's no block header with the given number in the
         canonical chain.
         """
         ...
@@ -2876,6 +2876,16 @@ def get_block_header_by_hash(self, block_hash: Hash32) -> BlockHeaderAPI:
         """
         ...
 
+    @abstractmethod
+    def get_canonical_block_header_by_number(self, block_number: BlockNumber) -> BlockHeaderAPI:
+        """
+        Return the block header with the given number in the canonical chain.
+
+        Raise ``HeaderNotFound`` if there's no block header with the given number in the
+        canonical chain.
+        """
+        ...
+
     @abstractmethod
     def get_canonical_head(self) -> BlockHeaderAPI:
         """
@@ -2986,6 +2996,17 @@ def create_unsigned_transaction(cls,
         """
         ...
 
+    @abstractmethod
+    def get_canonical_transaction_index(self, transaction_hash: Hash32) -> Tuple[BlockNumber, int]:
+        """
+        Return a 2-tuple of (block_number, transaction_index) indicating which
+        block the given transaction can be found in and at what index in the
+        block transactions.
+
+        Raise ``TransactionNotFound`` if the transaction does not exist in the canoncial
+        chain.
+        """
+
     @abstractmethod
     def get_canonical_transaction(self, transaction_hash: Hash32) -> SignedTransactionAPI:
         """
@@ -2997,6 +3018,19 @@ def get_canonical_transaction(self, transaction_hash: Hash32) -> SignedTransacti
         """
         ...
 
+    @abstractmethod
+    def get_canonical_transaction_by_index(self,
+                                           block_number: BlockNumber,
+                                           index: int) -> SignedTransactionAPI:
+        """
+        Return the requested transaction as specified by the ``block_number``
+        and ``index`` from the canonical chain.
+
+        Raise ``TransactionNotFound`` if no transaction exists at ``index`` at ``block_number`` in
+        the canonical chain.
+        """
+        ...
+
     @abstractmethod
     def get_transaction_receipt(self, transaction_hash: Hash32) -> ReceiptAPI:
         """
@@ -3007,6 +3041,17 @@ def get_transaction_receipt(self, transaction_hash: Hash32) -> ReceiptAPI:
         """
         ...
 
+    @abstractmethod
+    def get_transaction_receipt_by_index(self, block_number: BlockNumber, index: int) -> ReceiptAPI:
+        """
+        Return the requested receipt for the transaction as specified by the ``block_number``
+        and ``index``.
+
+        Raise ``ReceiptNotFound`` if not receipt for the specified ``block_number`` and ``index`` is
+        found in the canonical chain.
+        """
+        ...
+
     #
     # Execution API
     #

eth/chains/base.py

@@ -263,6 +263,9 @@ def get_block_header_by_hash(self, block_hash: Hash32) -> BlockHeaderAPI:
         validate_word(block_hash, title="Block Hash")
         return self.chaindb.get_block_header_by_hash(block_hash)
 
+    def get_canonical_block_header_by_number(self, block_number: BlockNumber) -> BlockHeaderAPI:
+        return self.chaindb.get_canonical_block_header_by_number(block_number)
+
     def get_canonical_head(self) -> BlockHeaderAPI:
         return self.chaindb.get_canonical_head()
 
@@ -337,15 +340,13 @@ def build_block_with_transactions(
     #
     # Transaction API
     #
+    def get_canonical_transaction_index(self, transaction_hash: Hash32) -> Tuple[BlockNumber, int]:
+        return self.chaindb.get_transaction_index(transaction_hash)
+
     def get_canonical_transaction(self, transaction_hash: Hash32) -> SignedTransactionAPI:
         (block_num, index) = self.chaindb.get_transaction_index(transaction_hash)
-        VM_class = self.get_vm_class_for_block_number(block_num)
 
-        transaction = self.chaindb.get_transaction_by_index(
-            block_num,
-            index,
-            VM_class.get_transaction_class(),
-        )
+        transaction = self.get_canonical_transaction_by_index(block_num, index)
 
         if transaction.hash == transaction_hash:
             return transaction
@@ -355,6 +356,18 @@ def get_canonical_transaction(self, transaction_hash: Hash32) -> SignedTransacti
                 f"instead of {encode_hex(transaction_hash)} in block {block_num} at {index}"
             )
 
+    def get_canonical_transaction_by_index(self,
+                                           block_number: BlockNumber,
+                                           index: int) -> SignedTransactionAPI:
+
+        VM_class = self.get_vm_class_for_block_number(block_number)
+
+        return self.chaindb.get_transaction_by_index(
+            block_number,
+            index,
+            VM_class.get_transaction_class(),
+        )
+
     def create_transaction(self, *args: Any, **kwargs: Any) -> SignedTransactionAPI:
         return self.get_vm().create_transaction(*args, **kwargs)
 
@@ -379,9 +392,15 @@ def get_transaction_receipt(self, transaction_hash: Hash32) -> ReceiptAPI:
         transaction_block_number, transaction_index = self.chaindb.get_transaction_index(
             transaction_hash,
         )
+        return self.get_transaction_receipt_by_index(transaction_block_number, transaction_index)
+
+    def get_transaction_receipt_by_index(self,
+                                         block_number: BlockNumber,
+                                         index: int) -> ReceiptAPI:
+
         receipt = self.chaindb.get_receipt_by_index(
-            block_number=transaction_block_number,
-            receipt_index=transaction_index,
+            block_number=block_number,
+            receipt_index=index,
         )
 
         return receipt

newsfragments/1887.feature.rst

@@ -0,0 +1,6 @@
+Add new Chain APIs:
+
+- `get_canonical_block_header_by_number`
+- `get_canonical_transaction_index`
+- `get_canonical_transaction_by_index`
+- `get_transaction_receipt_by_index`