Configuration & Running

Purpose: Hands-on operational guide: prerequisites, env settings, run/test commands. Audience: Operators, DevOps, local developers.

Prerequisites

  • Node.js 18+

  • MongoDB instance (local or managed)

  • RPC/WebSocket endpoints for target Arbitrum networks

  • ARBISCAN_KEY and ALCHEMY_API_KEY for optional verification features

  • PRIVATE_KEY (optional) if you want the backend to place bids


Environment variables (example .env)

# Single Network Mode
NETWORK=arbitrum-sepolia

# Multi-Network Mode
NETWORKS=arbitrum-sepolia,arbitrum-one

# Required API Keys
ARBISCAN_KEY=your_arbiscan_api_key
ALCHEMY_API_KEY=your_alchemy_api_key

# Blockchain WebSocket URL (optional override)
WS_ARBITRUM_SEPOLIA_URL=wss://sepolia-rollup.arbitrum.io/ws

# Database config
MONGODB_URI=mongodb://localhost:27017/smartcache
DATABASE_NAME=smartcache

# App config
NODE_ENV=development
LOG_LEVEL=info
PORT=4000

# Optional for bidding
PRIVATE_KEY=0xyourprivatekeyhere

Security note: never commit .env with private keys to source control. Use secrets management in production.


Install & Run

  1. Install dependencies:

  1. Dev run:

  1. Production build & start:


Testing

  • WebSocket test:

This exercise verifies provider connectivity, event subscription, and discovery logic.

  • Bid cache test:

  • Manual analysis:


Last updated