store: Document new modules.

graphprotocol · Jun 16, 2021 · c3922f1 · c3922f1
1 parent 649f0c2
commit c3922f1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/store/postgres/src/transaction_gas.rs b/store/postgres/src/transaction_gas.rs
@@ -1,3 +1,8 @@
+//! Code for retrieving transaction gas information from the database.
+//!
+//! This module exposes the [`find_transaction_gas_in_block_range`] function, that queries the
+//! database and returns how much gas each transaction were issued with.
+
 use super::transaction_receipt::drain_vector;
 use diesel::{
     pg::{Pg, PgConnection},
@@ -96,7 +101,7 @@ struct RawTransactionGas {
 }
 
 /// Like web3::types::Transaction, but with fewer fields.
-pub(crate) struct TransactionGas {
+struct TransactionGas {
     pub transaction_hash: H256,
     pub gas: U256,
 }

diff --git a/store/postgres/src/transaction_receipt.rs b/store/postgres/src/transaction_receipt.rs
@@ -1,3 +1,11 @@
+//! Code for retrieving transaction receipts from the database.
+//!
+//! This module exposes:
+//! 1. the [`find_transaction_receipts_for_block_range`] function, that queries the database and returns
+//!    transaction receipts for a given block range.
+//! 2. the [`LightTransactionReceipt`] type, which holds basic information about the retrieved
+//!    transaction receipts.
+
 use diesel::{
     pg::{Pg, PgConnection},
     prelude::*,