@xyo-network/xl1-cli 4.0.1 → 4.0.3

package/README.md

@@ -183,7 +183,6 @@ Named **connections** describe where providers read/write state:
 | `chain-mongo` | `mongo` | MongoDB chain authority store |
 | `dlq-store` | `lmdb` / `mongo` | Dead-letter queue backing (dev: aliases to chain store when omitted) |
 | `mempool-store` | `lmdb` / `mongo` | Mempool backing (dev: aliases to chain store when omitted) |
-| `indexer-store` | `lmdb` / `mongo` | Indexer-local store when split from chain authority |
 | `default-rpc` | `rpc` | HTTP JSON-RPC to another XL1 API |
 | `default-evm-rpc` | `evm-rpc` | EVM JSON-RPC for staking/contracts |
 | `s3-finalized` / `s3-chain-state` / `s3-index` | `s3` | Object storage publish targets |
@@ -192,6 +191,15 @@ Named **connections** describe where providers read/write state:
 
 **providerBindings** map each provider moniker to a connection. When omitted, bindings are synthesized per connection name (chain monikers → `local-store` / `chain-mongo`, DLQ → `dlq-store` or dev-aliased chain store, mempool → `mempool-store` or dev-aliased chain store, viewers → `default-rpc` when present, EVM monikers → `default-evm-rpc` when declared, otherwise memory fallback at plan time).
 
+**Index summaries** use two monikers (not one provider per family):
+
+| Moniker | Typical connection | Role |
+|---|---|---|
+| `IndexViewer` | `rest-index` (CDN) or `memory` (local dev) | Read step-summary families: `balances`, `blocks`, `schemas`, `transfers` |
+| `IndexPublishRunner` | `s3-index` | Publish those families to the index bucket |
+
+Local dev omits `IndexViewer` — `AccountBalanceViewer` computes summaries on demand from `BlockViewer`. Bind `IndexViewer` → `memory` (`SimpleIndexViewer`) when you want in-process summary memoization without S3.
+
 **S3 write + REST read:** The finalizer writes finalized blocks and the chain-state head to S3 (`BlockPublishRunner`, `ChainStatePublishRunner`). The indexer reads the published head and blocks over REST (`ChainStateViewer`, `BlockViewer`) and writes the index bucket via `IndexPublishRunner` → `s3-index`. Because `BlockViewer` must stay on the authority store for finalization, use split per-actor configs ([Finalizer](#finalizer-per-actor) + [Indexer](#indexer-per-actor)) or override `providerBindings` explicitly as in [S3 write + REST read](#s3-write--rest-read).
 
 ## Development examples
@@ -637,6 +645,16 @@ Mongo store plus S3 publish connections for finalizer and indexer in one process
         "readUrl": "https://index.xl1.example"
       }
     },
+    "providerBindings": {
+      "BlockViewer": { "connection": "chain-mongo" },
+      "BlockPublishRunner": { "connection": "s3-finalized" },
+      "ChainStatePublishRunner": { "connection": "s3-chain-state" },
+      "ChainStateViewer": { "connection": "s3-chain-state" },
+      "FinalizationRunner": { "connection": "chain-mongo" },
+      "FinalizationViewer": { "connection": "chain-mongo" },
+      "IndexPublishRunner": { "connection": "s3-index" },
+      "MempoolViewer": { "connection": "chain-mongo" }
+    },
     "actors": [
       {
         "name": "producer",
@@ -1166,6 +1184,16 @@ Configure the buckets as named `connections` (`s3-finalized`, `s3-chain-state`,
       "s3-chain-state": { "type": "s3", "bucket": "xl1-chain-state", "readUrl": "https://chain-state.xl1.example" },
       "s3-index": { "type": "s3", "bucket": "xl1-index", "readUrl": "https://index.xl1.example" }
     },
+    "providerBindings": {
+      "BlockViewer": { "connection": "chain-mongo" },
+      "BlockPublishRunner": { "connection": "s3-finalized" },
+      "ChainStatePublishRunner": { "connection": "s3-chain-state" },
+      "ChainStateViewer": { "connection": "s3-chain-state" },
+      "FinalizationRunner": { "connection": "chain-mongo" },
+      "FinalizationViewer": { "connection": "chain-mongo" },
+      "IndexPublishRunner": { "connection": "s3-index" },
+      "MempoolViewer": { "connection": "chain-mongo" }
+    },
     "actors": [
       { "name": "producer", "heartbeatInterval": 1000 },
       { "name": "finalizer", "publishOnFinalize": true, "publishContentEncoding": "br" },