Deal Bot

Automated Filecoin PDP deal creation and performance monitoring system

An intelligent automation system for creating and monitoring PDP deals on the Filecoin network. Features automated deal creation, CDN performance testing, comprehensive metrics tracking, and a modern web dashboard.

Features

• Automated Deal Creation - Scheduled storage deals across multiple providers
• Performance Monitoring - Real-time metrics for deals and retrievals
• Add-ons Testing - FWSS add-ons testing and comparison with provider performance
• Analytics Dashboard - Modern React UI with charts and statistics
• Synapse SDK - Seamless Filecoin storage operations
• Smart Contracts - Automated wallet management and service approvals

Quick Start

Prerequisites

• Node.js 18+
• PostgreSQL
• pnpm
• Filecoin wallet with tokens

Installation

# Clone repository
git clone https://github.com/FilOzone/dealbot.git
cd dealbot

# Install dependencies
pnpm install

# Configure environment
cp .env.example .env
# Edit .env with your wallet and database credentials

Running

# Development
pnpm start

# Production
pnpm start:prod

Web Dashboard

The project includes a React dashboard for visualizing metrics and monitoring performance.

Development

# Terminal 1: Backend
pnpm start

# Terminal 2: Frontend
pnpm dev:web

Visit http://localhost:5173 to view the dashboard.

Production Build

# Build frontend
pnpm build:web

# Start server (serves both API and UI)
pnpm start:prod

API Documentation

Complete API documentation is available via Swagger UI:

Production: https://dealbot.fwss.io/api

Local: http://localhost:3000/api (when running locally)

Configuration

Key environment variables:

Variable	Description	Default
WALLET_ADDRESS	Filecoin wallet address	-
WALLET_PRIVATE_KEY	Wallet private key	-
DATABASE_HOST	PostgreSQL host	-
DATABASE_PORT	PostgreSQL port	-
DATABASE_USER	PostgreSQL user	-
DATABASE_PASSWORD	PostgreSQL password	-
DATABASE_NAME	PostgreSQL database name	-
DEALBOT_PORT	Application port	3000
DEAL_INTERVAL_SECONDS	Deal creation interval	1800
RETRIEVAL_INTERVAL_SECONDS	Retrieval test interval	3600

See .env.example for complete configuration options.

Architecture

src/
├── deal/            # Deal creation and management
├── retrieval/       # Storage retrieval testing
├── metrics/         # Performance metrics and analytics
├── scheduler/       # Automated task scheduling
├── wallet-sdk/      # Wallet and contract operations
└── web/             # React dashboard

Monitoring

The system tracks comprehensive metrics:

• Deal Performance - Success rates, latencies
• Retrieval Performance - TTFB, latency, success rates by service type (cdn)
• Provider Statistics - Per-provider performance metrics
• Network Health - Overall system health and trends

Access metrics via the web dashboard or API endpoints.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run formatting and linting checks
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Code Quality

This project uses Biome for formatting and linting. Before submitting a PR:

# Format code
pnpm format

# Check formatting (CI mode)
pnpm format:check

# Lint code
pnpm lint

# Check linting (CI mode)
pnpm lint:check

# Run both format and lint checks
pnpm check

# Run CI checks (same as CI pipeline)
pnpm check:ci

Biome is configured to handle TypeScript, React/JSX, and Tailwind CSS with project-specific rules for NestJS decorators and testing files.

Resources

• Filecoin Documentation
• Synapse SDK
• NestJS Documentation

License

Dual-licensed: MIT, Apache Software License v2 by way of the Permissive License Stack.