quickstart

Run the KasGraph toolchain locally.

These commands come from the repo README. A hosted node is not required for local verification or direct database deployment.

install and verify

git clone https://github.com/trillskillz/KasGraph
cd KasGraph
npm install
npm run verify

build and deploy a subgraph

npx kasgraph init my-subgraph
cd my-subgraph
# edit schema.graphql + src/mapping.ts
npx kasgraph codegen
npx kasgraph build
npx kasgraph deploy --database-url "$DATABASE_URL"
npx kasgraph status my-subgraph

run the indexer node

DATABASE_URL="$DATABASE_URL" \
KASGRAPH_INGEST_MODE=continuous \
KASGRAPH_NOTIFICATION_WS_URL=wss://your-kaspa-node/wrpc/json \
KASGRAPH_RELOAD_INTERVAL_SECS=30 \
  cargo run -p kasgraph-node

Read the tutorial View demo preview Check project status

Hosted node environment

Future hosted API/indexer deployments should run on Railway, Fly.io, Render, or a VPS with managed Postgres. These values belong in the platform secret store and must not be committed.

DATABASE_URLKASGRAPH_INGEST_MODEKASGRAPH_NOTIFICATION_WS_URLKASGRAPH_RPC_PRIMARY_URLKASGRAPH_RPC_BACKUP_URLSKASGRAPH_RELOAD_INTERVAL_SECSKASGRAPH_WORK_DIRKASGRAPH_DEPLOY_TOKENKASGRAPH_NODE_URL