Catalog npm
Back to packageRELEASE DETAILS

1.2.0-pre.43

npm

@0xobelisk/sui-indexer

Minimal Typescript indexer for Dubhe

Published24 Jun 2025
Direct dependencies55
Transitive dependenciesNot calculated

README

Current package documentation

sui-indexer

A minimal Typescript indexer for Sui Move events (built on sui-client)

Usage

Install and run with:

npm install @0xobelisk/sui-indexer

npm sqlite-indexer
# or
npm postgres-indexer & npm postgres-frontend

or execute the one of the package bins directly:

npx -p @latticexyz/store-indexer sqlite-indexer
# or
npx -p @latticexyz/store-indexer postgres-indexer & npx -p @latticexyz/store-indexer postgres-frontend

Configuration

Each indexer can be configured with environment variables.

Common environment variables for indexer

VariableDescriptionDefault
RPC_HTTP_URLHTTP URL for Ethereum RPC to fetch data from
RPC_WS_URLWebSocket URL for Ethereum RPC to fetch data from
START_BLOCKBlock number to start indexing from0
MAX_BLOCK_RANGEMaximum number of blocks to fetch from the RPC per request1000
POLLING_INTERVALHow often to poll for new blocks (in milliseconds)1000
STORE_ADDRESSOptional address of the Dubhe Store to index. By default, store-indexer will index all Dubhe Stores on the chain.

Note that you only need one of RPC_HTTP_URL or RPC_WS_URL, but we recommend both. The WebSocket URL will be prioritized and fall back to the HTTP URL if there are any connection issues.

Common environment variables for frontend

VariableDescriptionDefault
HOSTHost that the indexer frontend server listens on0.0.0.0
PORTPort that the indexer frontend server listens on3001

Postgres indexer environment variables

VariableDescriptionDefault
DATABASE_URLPostgres connection URL
HEALTHCHECK_HOSTHost that the indexer healthcheck server listens on
HEATHCHECK_PORTPort that the indexer healthcheck server listens on

SQLite indexer environment variables

VariableDescriptionDefault
SQLITE_FILENAMESQLite database filenameindexer.db

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 57

Native requirements
55 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
ws
Environment
{
  "local_name": "ws",
  "alias": false,
  "peer_metadata": null
}
^8.18.0runtime
koa
Environment
{
  "local_name": "koa",
  "alias": false,
  "peer_metadata": null
}
^2.14.2runtime
zod
Environment
{
  "local_name": "zod",
  "alias": false,
  "peer_metadata": null
}
3.23.8runtime
pino
Environment
{
  "local_name": "pino",
  "alias": false,
  "peer_metadata": null
}
^9.6.0runtime
rxjs
Environment
{
  "local_name": "rxjs",
  "alias": false,
  "peer_metadata": null
}
7.5.5runtime
tsup
Environment
{
  "local_name": "tsup",
  "alias": false,
  "peer_metadata": null
}
^8.3.5runtime
debug
Environment
{
  "local_name": "debug",
  "alias": false,
  "peer_metadata": null
}
^4.3.4runtime
yargs
Environment
{
  "local_name": "yargs",
  "alias": false,
  "peer_metadata": null
}
^17.7.1runtime
dotenv
Environment
{
  "local_name": "dotenv",
  "alias": false,
  "peer_metadata": null
}
^16.0.3runtime
accepts
Environment
{
  "local_name": "accepts",
  "alias": false,
  "peer_metadata": null
}
^1.3.8runtime
graphql
Environment
{
  "local_name": "graphql",
  "alias": false,
  "peer_metadata": null
}
^16.10.0runtime
postgres
Environment
{
  "local_name": "postgres",
  "alias": false,
  "peer_metadata": null
}
3.3.5runtime
@koa/cors
Environment
{
  "local_name": "@koa/cors",
  "alias": false,
  "peer_metadata": null
}
^4.0.0runtime
superjson
Environment
{
  "local_name": "superjson",
  "alias": false,
  "peer_metadata": null
}
^1.12.4runtime
@koa/router
Environment
{
  "local_name": "@koa/router",
  "alias": false,
  "peer_metadata": null
}
^12.0.1runtime
@mysten/sui
Environment
{
  "local_name": "@mysten/sui",
  "alias": false,
  "peer_metadata": null
}
^1.19.0runtime
drizzle-orm
Environment
{
  "local_name": "drizzle-orm",
  "alias": false,
  "peer_metadata": null
}
^0.28.5runtime
koa-compose
Environment
{
  "local_name": "koa-compose",
  "alias": false,
  "peer_metadata": null
}
^4.1.0runtime
pino-pretty
Environment
{
  "local_name": "pino-pretty",
  "alias": false,
  "peer_metadata": null
}
^13.0.0runtime
prom-client
Environment
{
  "local_name": "prom-client",
  "alias": false,
  "peer_metadata": null
}
^15.1.2runtime
@sentry/node
Environment
{
  "local_name": "@sentry/node",
  "alias": false,
  "peer_metadata": null
}
^7.86.0runtime
@trpc/client
Environment
{
  "local_name": "@trpc/client",
  "alias": false,
  "peer_metadata": null
}
10.34.0runtime
@trpc/server
Environment
{
  "local_name": "@trpc/server",
  "alias": false,
  "peer_metadata": null
}
10.34.0runtime
graphql-yoga
Environment
{
  "local_name": "graphql-yoga",
  "alias": false,
  "peer_metadata": null
}
^5.10.10runtime
@sentry/utils
Environment
{
  "local_name": "@sentry/utils",
  "alias": false,
  "peer_metadata": null
}
^7.86.0runtime
better-sqlite3
Environment
{
  "local_name": "better-sqlite3",
  "alias": false,
  "peer_metadata": null
}
^8.6.0runtime
trpc-koa-adapter
Environment
{
  "local_name": "trpc-koa-adapter",
  "alias": false,
  "peer_metadata": null
}
^1.1.3runtime
@latticexyz/store
Environment
{
  "local_name": "@latticexyz/store",
  "alias": false,
  "peer_metadata": null
}
^2.2.16runtime
@latticexyz/common
Environment
{
  "local_name": "@latticexyz/common",
  "alias": false,
  "peer_metadata": null
}
^2.2.16runtime
@0xobelisk/sui-common
Environment
{
  "local_name": "@0xobelisk/sui-common",
  "alias": false,
  "peer_metadata": null
}
1.2.0-pre.43runtime
@graphql-tools/schema
Environment
{
  "local_name": "@graphql-tools/schema",
  "alias": false,
  "peer_metadata": null
}
^10.0.16runtime
@latticexyz/store-sync
Environment
{
  "local_name": "@latticexyz/store-sync",
  "alias": false,
  "peer_metadata": null
}
^2.2.16runtime
@sentry/profiling-node
Environment
{
  "local_name": "@sentry/profiling-node",
  "alias": false,
  "peer_metadata": null
}
^1.2.6runtime
@mysten/graphql-transport
Environment
{
  "local_name": "@mysten/graphql-transport",
  "alias": false,
  "peer_metadata": null
}
^0.2.40runtime
@latticexyz/protocol-parser
Environment
{
  "local_name": "@latticexyz/protocol-parser",
  "alias": false,
  "peer_metadata": null
}
^2.2.16runtime
@latticexyz/block-logs-stream
Environment
{
  "local_name": "@latticexyz/block-logs-stream",
  "alias": false,
  "peer_metadata": null
}
^2.2.16runtime
ws
Environment
{
  "local_name": "ws",
  "alias": false,
  "peer_metadata": null
}
^8.18.0development
jest
Environment
{
  "local_name": "jest",
  "alias": false,
  "peer_metadata": null
}
^29.7.0development
viem
Environment
{
  "local_name": "viem",
  "alias": false,
  "peer_metadata": null
}
2.21.19development
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^8.56.0development
vitest
Environment
{
  "local_name": "vitest",
  "alias": false,
  "peer_metadata": null
}
0.34.6development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
3.3.3development
@types/ws
Environment
{
  "local_name": "@types/ws",
  "alias": false,
  "peer_metadata": null
}
^8.5.14development
@types/koa
Environment
{
  "local_name": "@types/koa",
  "alias": false,
  "peer_metadata": null
}
^2.13.12development
graphql-ws
Environment
{
  "local_name": "graphql-ws",
  "alias": false,
  "peer_metadata": null
}
^6.0.2development
@types/jest
Environment
{
  "local_name": "@types/jest",
  "alias": false,
  "peer_metadata": null
}
^29.5.14development
@types/pino
Environment
{
  "local_name": "@types/pino",
  "alias": false,
  "peer_metadata": null
}
^7.0.5development
@types/debug
Environment
{
  "local_name": "@types/debug",
  "alias": false,
  "peer_metadata": null
}
^4.1.7development
@types/yargs
Environment
{
  "local_name": "@types/yargs",
  "alias": false,
  "peer_metadata": null
}
^17.0.10development
concurrently
Environment
{
  "local_name": "concurrently",
  "alias": false,
  "peer_metadata": null
}
^8.2.2development
@types/accepts
Environment
{
  "local_name": "@types/accepts",
  "alias": false,
  "peer_metadata": null
}
^1.3.7development
@types/koa__cors
Environment
{
  "local_name": "@types/koa__cors",
  "alias": false,
  "peer_metadata": null
}
^4.0.3development
@types/koa-compose
Environment
{
  "local_name": "@types/koa-compose",
  "alias": false,
  "peer_metadata": null
}
^3.2.8development
@types/koa__router
Environment
{
  "local_name": "@types/koa__router",
  "alias": false,
  "peer_metadata": null
}
^12.0.4development
@types/better-sqlite3
Environment
{
  "local_name": "@types/better-sqlite3",
  "alias": false,
  "peer_metadata": null
}
^7.6.4development
eslint-config-prettier
Environment
{
  "local_name": "eslint-config-prettier",
  "alias": false,
  "peer_metadata": null
}
^9.1.0development
viem
Environment
{
  "local_name": "viem",
  "alias": false,
  "peer_metadata": null
}
2.xpeer

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "2e8459543b3a7cceea94a98a9e87f14f81d88f95",
  "tarball": "https://registry.npmjs.org/@0xobelisk/sui-indexer/-/sui-indexer-1.2.0-pre.43.tgz",
  "fileCount": 30,
  "integrity": "sha512-mfLQtRwinMfCShnDvNyuEOgSKH2MVsnCtv7y6YfmSzQkc4Ecvj7kuP2Bfj8dvUMYSfTbY2hO/rFUQ8iXYp23sQ==",
  "signatures": [
    {
      "sig": "MEYCIQDxysoZZaQhToGp29XsAH1+isshWGalMHNtzwn1wacQ8wIhAOsQ8sWj4ECW2aTvS01dlL0OPQ2BbCqwriUWLVVYmM5r",
      "keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"
    }
  ],
  "unpackedSize": 273596
}

Repository

PENDING
0xobelisk/dubhe

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 09:26 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:a2cf0ced4c19394752c35df20e7a9a3c39b7809e907e516971e3bbab7e7fbc96

Other collected versions

1.2.0-pre.512 Jul1.2.0-pre.501 Jul1.2.0-pre.491 Jul1.2.0-pre.481 Jul1.2.0-pre.4730 Jun1.2.0-pre.4625 JunView all collected versions →