RepositoryCurrent collected state Current
Observed since 21 Oct, 09:25 UTC
No superseded metadata states collected. Unchanged observations do not create new revisions.
Back to packageRELEASE DETAILS
0.0.3
npm@0xobelisk/sui-indexer
Minimal Typescript indexer for Dubhe
Published28 Jan 2025
Direct dependencies48
Transitive dependenciesNot calculated
README
Current package documentationsui-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
| Variable | Description | Default |
|---|---|---|
RPC_HTTP_URL | HTTP URL for Ethereum RPC to fetch data from | |
RPC_WS_URL | WebSocket URL for Ethereum RPC to fetch data from | |
START_BLOCK | Block number to start indexing from | 0 |
MAX_BLOCK_RANGE | Maximum number of blocks to fetch from the RPC per request | 1000 |
POLLING_INTERVAL | How often to poll for new blocks (in milliseconds) | 1000 |
STORE_ADDRESS | Optional 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
| Variable | Description | Default |
|---|---|---|
HOST | Host that the indexer frontend server listens on | 0.0.0.0 |
PORT | Port that the indexer frontend server listens on | 3001 |
Postgres indexer environment variables
| Variable | Description | Default |
|---|---|---|
DATABASE_URL | Postgres connection URL | |
HEALTHCHECK_HOST | Host that the indexer healthcheck server listens on | |
HEATHCHECK_PORT | Port that the indexer healthcheck server listens on |
SQLite indexer environment variables
| Variable | Description | Default |
|---|---|---|
SQLITE_FILENAME | SQLite database filename | indexer.db |
Downloads & popularity
Awaiting observationsNo metric observations yet
Download counts and popularity will appear here as the collector receives them.
Declared dependencies 50
Native requirements48 direct targetsNot calculated transitive count
| Package / target | Requirement | Relationship |
|---|---|---|
wsEnvironment{
"local_name": "ws",
"alias": false,
"peer_metadata": null
} | ^8.18.0 | runtime |
koaEnvironment{
"local_name": "koa",
"alias": false,
"peer_metadata": null
} | ^2.14.2 | runtime |
zodEnvironment{
"local_name": "zod",
"alias": false,
"peer_metadata": null
} | 3.23.8 | runtime |
rxjsEnvironment{
"local_name": "rxjs",
"alias": false,
"peer_metadata": null
} | 7.5.5 | runtime |
tsupEnvironment{
"local_name": "tsup",
"alias": false,
"peer_metadata": null
} | ^8.3.5 | runtime |
debugEnvironment{
"local_name": "debug",
"alias": false,
"peer_metadata": null
} | ^4.3.4 | runtime |
yargsEnvironment{
"local_name": "yargs",
"alias": false,
"peer_metadata": null
} | ^17.7.1 | runtime |
dotenvEnvironment{
"local_name": "dotenv",
"alias": false,
"peer_metadata": null
} | ^16.0.3 | runtime |
acceptsEnvironment{
"local_name": "accepts",
"alias": false,
"peer_metadata": null
} | ^1.3.8 | runtime |
graphqlEnvironment{
"local_name": "graphql",
"alias": false,
"peer_metadata": null
} | ^16.10.0 | runtime |
postgresEnvironment{
"local_name": "postgres",
"alias": false,
"peer_metadata": null
} | 3.3.5 | runtime |
@koa/corsEnvironment{
"local_name": "@koa/cors",
"alias": false,
"peer_metadata": null
} | ^4.0.0 | runtime |
superjsonEnvironment{
"local_name": "superjson",
"alias": false,
"peer_metadata": null
} | ^1.12.4 | runtime |
@koa/routerEnvironment{
"local_name": "@koa/router",
"alias": false,
"peer_metadata": null
} | ^12.0.1 | runtime |
@mysten/suiEnvironment{
"local_name": "@mysten/sui",
"alias": false,
"peer_metadata": null
} | ^1.19.0 | runtime |
drizzle-ormEnvironment{
"local_name": "drizzle-orm",
"alias": false,
"peer_metadata": null
} | ^0.28.5 | runtime |
koa-composeEnvironment{
"local_name": "koa-compose",
"alias": false,
"peer_metadata": null
} | ^4.1.0 | runtime |
prom-clientEnvironment{
"local_name": "prom-client",
"alias": false,
"peer_metadata": null
} | ^15.1.2 | runtime |
@sentry/nodeEnvironment{
"local_name": "@sentry/node",
"alias": false,
"peer_metadata": null
} | ^7.86.0 | runtime |
@trpc/clientEnvironment{
"local_name": "@trpc/client",
"alias": false,
"peer_metadata": null
} | 10.34.0 | runtime |
@trpc/serverEnvironment{
"local_name": "@trpc/server",
"alias": false,
"peer_metadata": null
} | 10.34.0 | runtime |
graphql-yogaEnvironment{
"local_name": "graphql-yoga",
"alias": false,
"peer_metadata": null
} | ^5.10.10 | runtime |
@sentry/utilsEnvironment{
"local_name": "@sentry/utils",
"alias": false,
"peer_metadata": null
} | ^7.86.0 | runtime |
better-sqlite3Environment{
"local_name": "better-sqlite3",
"alias": false,
"peer_metadata": null
} | ^8.6.0 | runtime |
trpc-koa-adapterEnvironment{
"local_name": "trpc-koa-adapter",
"alias": false,
"peer_metadata": null
} | ^1.1.3 | runtime |
@latticexyz/storeEnvironment{
"local_name": "@latticexyz/store",
"alias": false,
"peer_metadata": null
} | ^2.2.16 | runtime |
@latticexyz/commonEnvironment{
"local_name": "@latticexyz/common",
"alias": false,
"peer_metadata": null
} | ^2.2.16 | runtime |
@0xobelisk/sui-commonEnvironment{
"local_name": "@0xobelisk/sui-common",
"alias": false,
"peer_metadata": null
} | 1.0.6 | runtime |
@graphql-tools/schemaEnvironment{
"local_name": "@graphql-tools/schema",
"alias": false,
"peer_metadata": null
} | ^10.0.16 | runtime |
@latticexyz/store-syncEnvironment{
"local_name": "@latticexyz/store-sync",
"alias": false,
"peer_metadata": null
} | ^2.2.16 | runtime |
@sentry/profiling-nodeEnvironment{
"local_name": "@sentry/profiling-node",
"alias": false,
"peer_metadata": null
} | ^1.2.6 | runtime |
@latticexyz/protocol-parserEnvironment{
"local_name": "@latticexyz/protocol-parser",
"alias": false,
"peer_metadata": null
} | ^2.2.16 | runtime |
@latticexyz/block-logs-streamEnvironment{
"local_name": "@latticexyz/block-logs-stream",
"alias": false,
"peer_metadata": null
} | ^2.2.16 | runtime |
wsEnvironment{
"local_name": "ws",
"alias": false,
"peer_metadata": null
} | ^8.18.0 | development |
jestEnvironment{
"local_name": "jest",
"alias": false,
"peer_metadata": null
} | ^29.7.0 | development |
viemEnvironment{
"local_name": "viem",
"alias": false,
"peer_metadata": null
} | 2.21.19 | development |
vitestEnvironment{
"local_name": "vitest",
"alias": false,
"peer_metadata": null
} | 0.34.6 | development |
@types/wsEnvironment{
"local_name": "@types/ws",
"alias": false,
"peer_metadata": null
} | ^8.5.14 | development |
@types/koaEnvironment{
"local_name": "@types/koa",
"alias": false,
"peer_metadata": null
} | ^2.13.12 | development |
graphql-wsEnvironment{
"local_name": "graphql-ws",
"alias": false,
"peer_metadata": null
} | ^6.0.2 | development |
@types/jestEnvironment{
"local_name": "@types/jest",
"alias": false,
"peer_metadata": null
} | ^29.5.14 | development |
@types/debugEnvironment{
"local_name": "@types/debug",
"alias": false,
"peer_metadata": null
} | ^4.1.7 | development |
@types/yargsEnvironment{
"local_name": "@types/yargs",
"alias": false,
"peer_metadata": null
} | ^17.0.10 | development |
concurrentlyEnvironment{
"local_name": "concurrently",
"alias": false,
"peer_metadata": null
} | ^8.2.2 | development |
@types/acceptsEnvironment{
"local_name": "@types/accepts",
"alias": false,
"peer_metadata": null
} | ^1.3.7 | development |
@types/koa__corsEnvironment{
"local_name": "@types/koa__cors",
"alias": false,
"peer_metadata": null
} | ^4.0.3 | development |
@types/koa-composeEnvironment{
"local_name": "@types/koa-compose",
"alias": false,
"peer_metadata": null
} | ^3.2.8 | development |
@types/koa__routerEnvironment{
"local_name": "@types/koa__router",
"alias": false,
"peer_metadata": null
} | ^12.0.4 | development |
@types/better-sqlite3Environment{
"local_name": "@types/better-sqlite3",
"alias": false,
"peer_metadata": null
} | ^7.6.4 | development |
viemEnvironment{
"local_name": "viem",
"alias": false,
"peer_metadata": null
} | 2.x | peer |
Distribution files
1 collectedDistribution 1
Source fileSource distribution
Checksums from source
{
"shasum": "664a46c781be8587efce42b1133159e6fbef4333",
"tarball": "https://registry.npmjs.org/@0xobelisk/sui-indexer/-/sui-indexer-0.0.3.tgz",
"fileCount": 38,
"integrity": "sha512-e8uGoxV/JTIbsxYLZ1h36Ms/jZLBGSEJeP8qj3jG6FLEJ62Qr5e7FPQcZQc3dgGkii9omRzP+iKi8R+7Fo+5Ew==",
"signatures": [
{
"sig": "MEUCIQCtJt9Lpq3ytyeKPFkyogxy896lmrcg0lmgDfKMAYUFZgIgQZ5sTHAgtkL+0KA2JfahLQQ4QrsxBHdszkyYk+vLjvo=",
"keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"
}
],
"unpackedSize": 153504
}Repository
PENDINGMetadata history
Meaningful changesRecord identity
package_version:4513df112db7cba41cf55a61a4d0e1bbbd0593afe49502b516af5d7469bd20eb