From 75069685be5417579c7e2119dac6a68c28276843 Mon Sep 17 00:00:00 2001 From: Roy Crihfield Date: Fri, 20 Nov 2020 19:42:55 +0800 Subject: [PATCH] doc --- statediff/indexer/indexer.go | 2 ++ statediff/indexer/writer.go | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/statediff/indexer/indexer.go b/statediff/indexer/indexer.go index c6d6f54a5..2a6bac3f2 100644 --- a/statediff/indexer/indexer.go +++ b/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 . +// 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 ( diff --git a/statediff/indexer/writer.go b/statediff/indexer/writer.go index 3aa955c3e..24bef7ed3 100644 --- a/statediff/indexer/writer.go +++ b/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 }