Update go-lib and write docs

Author: aopoltorzhicky

README.md

@@ -1,10 +1,98 @@
-# Software Development Kit for indexers
-SDK for creation indexers by DipDup. It's a set of package which can be used for building indexers.
+# DipDup Indexer SDK
 
-## Storage
+SDK for building indexers by [DipDup](https://dipdup.io). Provides a set of packages for constructing modular, flow-based indexing pipelines.
 
-Abstract layer of data storage is described in the package. Detailed docs can be found [here](/pkg/storage/).
+## Architecture
 
-## Modules
+The SDK follows a **flow-based programming (FBP)** approach: independent asynchronous modules communicate through typed inputs and outputs, forming a processing pipeline (workflow).
 
-The workflow is builded by modules. SDK uses flow-based programming approach. Detailed docs can be found [here](/pkg/modules/).
+```
+┌──────────┐     ┌──────────┐     ┌──────────┐
+│  Source  │────>│ Process  │────>│  Sink    │
+│ (gRPC,   │     │ (custom  │     │ (storage,│
+│  cron)   │     │  logic)  │     │  printer)│
+└──────────┘     └──────────┘     └──────────┘
+```
+
+## Packages
+
+| Package | Description |
+|---------|-------------|
+| [`pkg/modules`](pkg/modules/) | Flow-based module system: interfaces, inputs/outputs, workflow orchestration |
+| [`pkg/modules/grpc`](pkg/modules/grpc/) | gRPC client and server modules with subscription support |
+| [`pkg/modules/cron`](pkg/modules/cron/) | Cron scheduler module |
+| [`pkg/modules/zipper`](pkg/modules/zipper/) | Aggregates two input streams by key |
+| [`pkg/modules/stopper`](pkg/modules/stopper/) | Graceful shutdown via context cancellation |
+| [`pkg/modules/printer`](pkg/modules/printer/) | Debug module that logs received messages |
+| [`pkg/storage`](pkg/storage/) | Abstract storage layer with generic interfaces |
+| [`pkg/storage/postgres`](pkg/storage/postgres/) | PostgreSQL implementation (pgx + bun) |
+| [`pkg/sync`](pkg/sync/) | Thread-safe generic `Map[K, V]` |
+| [`pkg/contract`](pkg/contract/) | Contract ABI to JSON Schema transformer (EVM) |
+| [`pkg/rlp`](pkg/rlp/) | RLP encoding/decoding for Ethereum logs |
+| [`pkg/jsonschema`](pkg/jsonschema/) | JSON Schema types (Draft 2019-09) |
+
+## Quick Start
+
+### Module Workflow
+
+```go
+import (
+    "github.com/dipdup-net/indexer-sdk/pkg/modules"
+    "github.com/dipdup-net/indexer-sdk/pkg/modules/cron"
+)
+
+// Create modules
+cronModule, _ := cron.NewModule(cfg.Cron)
+customModule := NewCustomModule()
+
+// Connect cron output to custom module input
+modules.Connect(cronModule, customModule, "every_second", "input")
+
+// Start workflow
+ctx, cancel := context.WithCancel(context.Background())
+cronModule.Start(ctx)
+customModule.Start(ctx)
+```
+
+### Storage
+
+```go
+import (
+    "github.com/dipdup-io/go-lib/config"
+    "github.com/dipdup-net/indexer-sdk/pkg/storage/postgres"
+)
+
+cfg := config.Database{
+    Host: "127.0.0.1", Port: 5432,
+    User: "user", Password: "password", Database: "mydb",
+}
+
+storage, _ := postgres.Create(ctx, cfg, func(ctx context.Context, conn *database.Bun) error {
+    _, err := conn.DB().NewCreateTable().Model((*MyModel)(nil)).IfNotExists().Exec(ctx)
+    return err
+})
+defer storage.Close()
+```
+
+## Code Generation
+
+The `cmd/dipdup-gen` tool generates boilerplate for new indexer projects from EVM contract ABIs.
+
+```bash
+go run ./cmd/dipdup-gen abi --input contract.json --output ./generated
+```
+
+## Examples
+
+Working examples are available in the [`examples/`](examples/) directory:
+
+- [`examples/cron`](examples/cron/) — cron scheduler usage
+- [`examples/storage`](examples/storage/) — PostgreSQL storage layer
+- [`examples/grpc`](examples/grpc/) — gRPC client/server with subscriptions
+- [`examples/zipper`](examples/zipper/) — stream aggregation by key
+
+## Installation
+
+```bash
+go get github.com/dipdup-net/indexer-sdk
+```

cmd/dipdup-gen/templates/cmd/main.tmpl

@@ -11,7 +11,7 @@ import (
 	"github.com/dipdup-net/evm-indexer/pkg/modules/grpc"
 	"github.com/dipdup-net/evm-indexer/pkg/modules/layer2"
 	"github.com/dipdup-net/indexer-sdk/pkg/modules"
-	"github.com/dipdup-net/go-lib/config"
+	"github.com/dipdup-io/go-lib/config"
 	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/spf13/cobra"
 

cmd/dipdup-gen/templates/modules/postgres_module.tmpl

@@ -4,7 +4,7 @@ import (
 	"context"
 	"sync"
 
-	"github.com/dipdup-net/go-lib/config"
+	"github.com/dipdup-io/go-lib/config"
 	"{{ .PackageName }}/internal/storage/postgres"
 	"{{ .PackageName }}/internal/storage"
 	"github.com/dipdup-net/evm-indexer/pkg/modules/grpc/pb"

cmd/dipdup-gen/templates/storage/postgres.tmpl

@@ -2,7 +2,7 @@ package postgres
 
 import (
 	"{{ .PackageName }}/internal/storage"
-	"github.com/dipdup-net/go-lib/database"
+	"github.com/dipdup-io/go-lib/database"
 	"github.com/dipdup-net/indexer-sdk/pkg/storage/postgres"
 )
 

cmd/dipdup-gen/templates/storage/postgres_core.tmpl

@@ -3,8 +3,8 @@ package postgres
 import (
 	"context"
 
-	"github.com/dipdup-net/go-lib/config"
-	"github.com/dipdup-net/go-lib/database"
+	"github.com/dipdup-io/go-lib/config"
+	"github.com/dipdup-io/go-lib/database"
 	models "{{ .PackageName }}/internal/storage"
 	"github.com/dipdup-net/indexer-sdk/pkg/storage"
 	"github.com/dipdup-net/indexer-sdk/pkg/storage/postgres"

examples/cron/main.go

@@ -7,7 +7,7 @@ import (
 	"os/signal"
 	"syscall"
 
-	"github.com/dipdup-net/go-lib/config"
+	"github.com/dipdup-io/go-lib/config"
 	"github.com/dipdup-net/indexer-sdk/pkg/modules"
 	"github.com/dipdup-net/indexer-sdk/pkg/modules/cron"
 )

examples/storage/main.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"log"
 
-	"github.com/dipdup-net/go-lib/config"
+	"github.com/dipdup-io/go-lib/config"
 	"github.com/dipdup-net/indexer-sdk/examples/storage/storage"
 	"github.com/dipdup-net/indexer-sdk/examples/storage/storage/postgres"
 )

examples/storage/storage/postgres/core.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"database/sql"
 
-	"github.com/dipdup-net/go-lib/config"
-	"github.com/dipdup-net/go-lib/database"
+	"github.com/dipdup-io/go-lib/config"
+	"github.com/dipdup-io/go-lib/database"
 	models "github.com/dipdup-net/indexer-sdk/examples/storage/storage"
 	"github.com/dipdup-net/indexer-sdk/pkg/storage/postgres"
 	"github.com/uptrace/bun"

examples/storage/storage/postgres/person.go

@@ -3,7 +3,7 @@ package postgres
 import (
 	"context"
 
-	"github.com/dipdup-net/go-lib/database"
+	"github.com/dipdup-io/go-lib/database"
 	"github.com/dipdup-net/indexer-sdk/examples/storage/storage"
 	"github.com/dipdup-net/indexer-sdk/pkg/storage/postgres"
 )

go.mod

@@ -3,16 +3,17 @@ module github.com/dipdup-net/indexer-sdk
 go 1.25.7
 
 require (
+	github.com/dipdup-io/go-lib/config v1.0.0
+	github.com/dipdup-io/go-lib/database v1.0.0
 	github.com/dipdup-io/workerpool v0.0.4
-	github.com/dipdup-net/go-lib v0.5.0
 	github.com/ethereum/go-ethereum v1.17.0
-	github.com/go-testfixtures/testfixtures/v3 v3.16.0
+	github.com/go-testfixtures/testfixtures/v3 v3.19.0
 	github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus v1.0.0-rc.0
 	github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.0.0-rc.5
 	github.com/iancoleman/strcase v0.3.0
 	github.com/jackc/pgx/v5 v5.8.0
 	github.com/json-iterator/go v1.1.12
-	github.com/lib/pq v1.10.9
+	github.com/lib/pq v1.11.2
 	github.com/pkg/errors v0.9.1
 	github.com/prometheus/client_golang v1.22.0
 	github.com/robfig/cron/v3 v3.0.1
@@ -23,12 +24,12 @@ require (
 	github.com/uptrace/bun/dialect/pgdialect v1.2.18
 	go.uber.org/mock v0.5.0
 	golang.org/x/time v0.11.0
-	google.golang.org/grpc v1.77.0
+	google.golang.org/grpc v1.79.1
 	google.golang.org/protobuf v1.36.11
 )
 
 require (
-	dario.cat/mergo v1.0.1 // indirect
+	dario.cat/mergo v1.0.2 // indirect
 	github.com/Azure/go-ansiterm v0.0.0-20230124172434-306776ec8161 // indirect
 	github.com/Microsoft/go-winio v0.6.2 // indirect
 	github.com/ProjectZKM/Ziren/crates/go-runtime/zkvm_runtime v0.0.0-20251001021608-1fe7b43fc4d6 // indirect
@@ -37,28 +38,31 @@ require (
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/consensys/gnark-crypto v0.18.1 // indirect
+	github.com/containerd/errdefs v1.0.0 // indirect
+	github.com/containerd/errdefs/pkg v0.3.0 // indirect
 	github.com/containerd/log v0.1.0 // indirect
 	github.com/containerd/platforms v0.2.1 // indirect
 	github.com/cpuguy83/dockercfg v0.3.2 // indirect
 	github.com/crate-crypto/go-eth-kzg v1.4.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0 // indirect
+	github.com/dipdup-io/go-lib/hasura v1.0.0 // indirect
 	github.com/distribution/reference v0.6.0 // indirect
-	github.com/docker/docker v28.0.4+incompatible // indirect
-	github.com/docker/go-connections v0.5.0 // indirect
+	github.com/docker/docker v28.5.1+incompatible // indirect
+	github.com/docker/go-connections v0.6.0 // indirect
 	github.com/docker/go-units v0.5.0 // indirect
-	github.com/ebitengine/purego v0.8.2 // indirect
+	github.com/ebitengine/purego v0.8.4 // indirect
 	github.com/ethereum/c-kzg-4844/v2 v2.1.5 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
-	github.com/gabriel-vasile/mimetype v1.4.8 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.12 // indirect
 	github.com/go-logr/logr v1.4.3 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-ole/go-ole v1.3.0 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
 	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-playground/validator/v10 v10.26.0 // indirect
-	github.com/goccy/go-yaml v1.17.1 // indirect
-	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/go-playground/validator/v10 v10.30.1 // indirect
+	github.com/goccy/go-yaml v1.18.0 // indirect
+	github.com/golang/mock v1.7.0-rc.1 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/holiman/uint256 v1.3.2 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
@@ -73,9 +77,10 @@ require (
 	github.com/mattn/go-colorable v0.1.14 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/moby/docker-image-spec v1.3.1 // indirect
+	github.com/moby/go-archive v0.1.0 // indirect
 	github.com/moby/patternmatcher v0.6.0 // indirect
-	github.com/moby/sys/sequential v0.5.0 // indirect
-	github.com/moby/sys/user v0.3.0 // indirect
+	github.com/moby/sys/sequential v0.6.0 // indirect
+	github.com/moby/sys/user v0.4.0 // indirect
 	github.com/moby/sys/userns v0.1.0 // indirect
 	github.com/moby/term v0.5.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
@@ -91,12 +96,12 @@ require (
 	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/puzpuzpuz/xsync/v3 v3.5.1 // indirect
 	github.com/shirou/gopsutil v3.21.11+incompatible // indirect
-	github.com/shirou/gopsutil/v4 v4.25.1 // indirect
+	github.com/shirou/gopsutil/v4 v4.25.6 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
 	github.com/supranational/blst v0.3.16-0.20250831170142-f48500c1fdbe // indirect
-	github.com/testcontainers/testcontainers-go v0.37.0 // indirect
-	github.com/testcontainers/testcontainers-go/modules/postgres v0.37.0 // indirect
+	github.com/testcontainers/testcontainers-go v0.40.0 // indirect
+	github.com/testcontainers/testcontainers-go/modules/postgres v0.40.0 // indirect
 	github.com/tklauser/go-sysconf v0.3.12 // indirect
 	github.com/tklauser/numcpus v0.6.1 // indirect
 	github.com/tmthrgd/go-hex v0.0.0-20190904060850-447a3041c3bc // indirect
@@ -113,6 +118,7 @@ require (
 	golang.org/x/sync v0.19.0 // indirect
 	golang.org/x/sys v0.41.0 // indirect
 	golang.org/x/text v0.34.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20251222181119-0a764e51fe1b // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20251222181119-0a764e51fe1b // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )