Skip to content

pinax-network/pinax-sql-api

Repository files navigation

Pinax: SQL API

.github/workflows/bun-test.yml

Collection of SQL based APIs by built on top of Pinax MCP Server (powered by Substreams).

Architecture

flowchart LR
  S1[ERC-20.spkg] --> Server
  S2[SPL Token.spkg] --> Server
  S3[eosio.token.spkg] --> Server
  Server{Pinax MCP Server} --> API{Pinax SQL API}
Loading

Supported Endpoints

Tokens

  • EVM
    • Native
    • ERC-20
  • SVN (Solana)
    • Native
    • SPL Token
  • Antelope
    • Native
    • eosio.token

Token Balances

  • EVM
  • SVN (Solana)
  • Antelope

Token Transfers

  • EVM
  • SVN (Solana)
  • Antelope

Token Holders

  • EVM
  • SVN (Solana)
  • Antelope

Token Prices

  • EVM
    • Uniswap V2
    • Uniswap V3
    • CurveFi
    • SushiSwap
  • SVN (Solana)
    • Orca
    • Raydium
  • Antelope
    • Defibox

Transactions

  • EVM
  • SVN (Solana)
  • Antelope

NFTs

  • EVM
  • SVN (Solana)
  • Antelope

.env Environment variables

# SQL API Server
PORT=8080
HOSTNAME=localhost

# Bun request timeout in seconds
BUN_IDLE_REQUEST_TIMEOUT=60

# MCP Server
HOST=https://beta.mcp.pinax.network
PINAX_API_KEY="f98f••••••••••••••••••••5247"

# Logging
PRETTY_LOGGING=true
VERBOSE=true

Docker environment

  • Pull from GitHub Container registry

For latest tagged release

docker pull ghcr.io/pinax-network/pinax-sql-api:latest

For head of main branch

docker pull ghcr.io/pinax-network/pinax-sql-api:develop
  • Build from source
docker build \
  --build-arg GIT_COMMIT="$(git rev-parse HEAD)" \
  -t pinax-sql-api .
  • Run with .env file
docker run -it --rm --env-file .env -p 3000:3000 ghcr.io/pinax-network/pinax-sql-api:develop

Contributing

See CONTRIBUTING.md.

Quick start

Install Bun

bun install
bun dev

Tests

bun lint
bun test