doc

Author: roysc

statediff/indexer/indexer.go

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+// This package provides an interface for pushing and indexing IPLD objects into a Postgres database
+// Metrics for reporting processing and connection stats are defined in ./metrics.go
 package indexer
 
 import (

statediff/indexer/writer.go

@@ -17,9 +17,9 @@
 package indexer
 
 import (
-	"github.com/ethereum/go-ethereum/common"
 	"github.com/jmoiron/sqlx"
 
+	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/statediff/indexer/models"
 	"github.com/ethereum/go-ethereum/statediff/indexer/postgres"
 	"github.com/ethereum/go-ethereum/statediff/indexer/shared"
@@ -29,7 +29,7 @@ var (
 	nullHash = common.HexToHash("0x0000000000000000000000000000000000000000000000000000000000000000")
 )
 
-// Indexer satisfies the Indexer interface for ethereum
+// Handles processing and writing of indexed IPLD objects to Postgres
 type PostgresCIDWriter struct {
 	db *postgres.DB
 }