Skip to content

Latest commit

 

History

History

sui-indexer

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
migrations
migrations
 
 
src
src
 
 
tests
tests
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 
diesel.toml
diesel.toml
 
 

README.md

Sui indexer is an off-fullnode service to serve data from Sui protocol, including both data directly generated from chain and derivative data.

Architecture

enhanced_FN

Steps to run locally

Prerequisites

  • install local Postgres server. You can also brew install postgresql@version and then add the following to your ~/.zshrc or ~/.zprofile, etc:
export LDFLAGS="-L/opt/homebrew/opt/postgresql@15/lib"
export CPPFLAGS="-I/opt/homebrew/opt/postgresql@15/include"
export PATH="/opt/homebrew/opt/postgresql@15/bin:$PATH"

  • make sure you have libpq installed: brew install libpq, and in your profile, add export PATH="/opt/homebrew/opt/libpq/bin:$PATH". If this doesn't work, try brew link --force libpq.

  • install Diesel CLI with cargo install diesel_cli --no-default-features --features postgres, refer to Diesel Getting Started guide for more details

  • [optional but handy] Postgres client like Postico, for local check, query execution etc.

Start the Postgres Service

Postgres must run as a service in the background for other tools to communicate with. If it was installed using homebrew, it can be started as a service with:

brew services start postgresql@version

Local Development(Recommended)

Use sui-test-validator

Running standalone indexer

  1. DB setup, under sui/crates/sui-indexer run:
# an example DATABASE_URL is "postgres://postgres:postgres@localhost/gegao"
diesel setup --database-url="<DATABASE_URL>"
diesel database reset --database-url="<DATABASE_URL>"

Note that you'll need an existing database for the above to work. Replace gegao with the name of the database created.

  1. Checkout to your target branch

For example, if you want to be on the DevNet branch

git fetch upstream devnet && git reset --hard upstream/devnet
  1. Start indexer binary, under sui/crates/sui-indexer run:
  • run indexer as a writer, which pulls data from fullnode and writes data to DB
# Change the RPC_CLIENT_URL to http://0.0.0.0:9000 to run indexer against local validator & fullnode
cargo run --bin sui-indexer -- --db-url "<DATABASE_URL>" --rpc-client-url "https://fullnode.devnet.sui.io:443" --fullnode-sync-worker --reset-db
  • run indexer as a reader, which is a JSON RPC server with the interface
cargo run --bin sui-indexer -- --db-url "<DATABASE_URL>" --rpc-client-url "https://fullnode.devnet.sui.io:443" --rpc-server-worker

More flags info can be found in this file.

DB reset

Run this command under sui/crates/sui-indexer, which will wipe DB; In case of schema changes in .sql files, this will also update corresponding schema.rs file.

diesel database reset --database-url="<DATABASE_URL>"