PkgFoundry
Catalog npm
PACKAGE EXPLORERView in registry

@0xobelisk/sui-indexer

npm

Minimal Typescript indexer for Dubhe

Versions collected68
Direct dependencies55From release 1.2.0-pre.51
Last observed21 Oct, 09:26 UTC

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.

Versions 68

Collected releases
VersionPublishedDirect dependenciesOpen version
1.2.0-pre.51Registry latest2 Jul 202555
1.2.0-pre.501 Jul 202555
1.2.0-pre.491 Jul 202555
1.2.0-pre.481 Jul 202555
1.2.0-pre.4730 Jun 202555
1.2.0-pre.4625 Jun 202555
1.2.0-pre.4525 Jun 202555
1.2.0-pre.4425 Jun 202555
1.2.0-pre.4324 Jun 202555
1.2.0-pre.4224 Jun 202555
1.2.0-pre.4123 Jun 202555
1.2.0-pre.4023 Jun 202555
1.2.0-pre.3923 Jun 202555
1.2.0-pre.3823 Jun 202555
1.2.0-pre.3623 Jun 202555
1.2.0-pre.3523 Jun 202555
1.2.0-pre.3423 Jun 202555
1.2.0-pre.3323 Jun 202555
1.2.0-pre.2923 Jun 202555
1.2.0-pre.2823 Jun 202555
Sorted by available source dates · UTC

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

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:25 UTC

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

Record identity

package:3bf1267e714332d17eb24f50e3ae3255074a012c0a8684a075922fd2fd9615b6