Add comment to TransactionReceiptWithDecodedLogs explaining that it doesn't always return "decodedLogs"

1 files changed, 5 insertions, 0 deletions

diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
index a85d48cf7..f28c2f9a3 100644
--- a/packages/types/src/index.ts
+++ b/packages/types/src/index.ts
@@ -240,6 +240,11 @@ export enum SolidityTypes {
     Uint = 'uint',
 }
 
+/**
+ * Contains the logs returned by a TransactionReceipt. We attempt to decode the
+ * logs using AbiDecoder. If we have the logs corresponding ABI, we decode it,
+ * otherwise we don't.
+ */
 export interface TransactionReceiptWithDecodedLogs extends TransactionReceipt {
     logs: Array<LogWithDecodedArgs<DecodedLogArgs> | LogEntry>;
 }