Stacks Status

This repository contains the code for the Stacks Blockchain Status Page code used by the Stacks Foundation to display blockchain metrics. This is a next.js react app that reads locally stored metric data from a postgres database, and periodically will fetch data from https://stacksonchain.com/ to refresh the displayed data.

Getting Started

PostgreSQL is a required dependency example with Docker:

$ docker run -d \
    --rm \
    --name postgres \
    -p 5432:5432 \
    -e POSTGRES_PASSWORD=postgres \
    -v /tmp/postgres_data:/var/lib/postgresql/data \
postgres:14-alpine

# Clone this repo and enter its directory
git clone https://github.com/stacksfoundation/stacksstatus && cd stacksstatus


# Create .env file
cp .env.local.example .env

# update .env file with DB connection options (HOST, USER, PASSWORD, etc) and apply migrations
npx prisma migrate dev --name init

# Install dependencies
npm install

# Run development server
npm run dev
# or
yarn dev

# Run production server
npm run build && npm run start
yarn build && yarn start

Open http://localhost:3000 with your browser to see the result.

Refreshing the data

There are 2 paths via the /api route to refresh the data, and 1 standalone script with not authentication

/api/refresh - this path is used with upstash docs
/api/refresh_local - this path is used with a local key defined below API_SECRET_KEY
node lib/standalone_check.js - package.json will need to be set to "type": "module" to run this

To refresh the data, you can run a curl command like the following:

$ curl -sLw '\n' \
    --request POST \
    --url 'localhost:3000/api/refresh_local' \
    --header 'Authorization: Bearer secret'

With upstash:

$ curl -sL \
  --request POST \
  --url "https://qstash.upstash.io/v1/publish/<url of app>/api/refresh" \
 --header "Authorization: Bearer <refer to upstash docs>"

Adding more checks

In folder ./status_checks, each json file defines an API request to stacksonchain. To add a new check, copy/paste an existing file and modify the query (be sure to set "disabled": false to enable the check). Refer to the json schemas:

Configuration

Environment Variables