docs

📚 SafeTx Documentation Index

Welcome to SafeTx documentation! Find what you need:

---

🚀 Getting Started

For Developers

• Getting Started Guide ⭐ START HERE

  • How to get API keys
  • Quick integration examples
  • All supported languages/frameworks
  • Common use cases

• API Keys Guide

  • Where to get your API key
  • Pricing tiers
  • Security best practices
  • Self-hosting setup

For End Users

• Main README
  • Project overview
  • How to run the dashboard locally
  • Wallet setup

---

📖 API Documentation

Reference Docs

• API Reference

  • All endpoints documented
  • Request/response examples
  • Authentication methods
  • Rate limits

• OpenAPI Specification

  • Machine-readable API spec
  • Import into Postman/Insomnia
  • Generate client SDKs

Code Examples

• TypeScript SDK
  • Official JavaScript/TypeScript client
  • Installation & usage
  • REST + SSE + Solana helpers

---

🏗️ Architecture & Design

• Architecture Overview

  • System design
  • Component interaction
  • Data flow diagrams

• Diagrams

  • Visual system overview
  • User journey flowcharts
  • Performance targets

---

💼 Business & Product

• Product Roadmap
  • Product vision
  • Use cases for companies
  • 30/60/90 day plan
  • Monetization strategy
  • Go-to-market plan

---

🔧 Backend & Infrastructure

• Backend README

  • Installation & setup
  • Environment configuration
  • API usage examples
  • Self-hosting guide

• Backend with MagicBlock

  • MagicBlock integration
  • Ephemeral rollup setup

---

⚙️ Smart Contracts

• Contracts Overview

  • Smart contract architecture

• Solana Program

  • On-chain program details
  • Deployment instructions
  • Program ID and addresses

---

🧪 Testing & Deployment

• Testing Guide

  • How to run tests
  • Test coverage
  • Integration testing

• Deployment Guide

  • Production deployment
  • Environment setup
  • CI/CD pipelines

---

📊 By Use Case

I want to...

Integrate SafeTx metrics into my dApp

→ Start with Getting Started Guide → Check API Reference → Use TypeScript SDK

Get an API key

→ Read API Keys Guide → For now: Run locally (no key needed) → Coming soon: Self-service dashboard

Run SafeTx locally for development

→ See Main README - Quick Start section → Backend setup: Backend README

Self-host the backend in production

→ Backend README → Deployment Guide → API Keys Guide - Self-hosting section

Deploy the Solana program

→ Solana Program Guide

Build a custom client in another language

→ OpenAPI Spec - Generate client → API Reference - Endpoint details

Monitor Solana network in my wallet

→ Getting Started Guide - Wallet Dashboard example → TypeScript SDK

Set up alerts for network issues

→ Getting Started Guide - DevOps Monitoring example → Subscribe to SSE stream for real-time alerts

Understand the product vision

→ Product Roadmap → Architecture

---

🔍 Quick Search

Topic	Document
API authentication	API Keys Guide
API endpoints	API Reference
Code examples	Getting Started Guide
Installation	Main README
OpenAPI spec	openapi.yaml
Pricing	API Keys Guide
Product roadmap	ROADMAP.md
Rate limits	API Reference
SDK (TypeScript)	safetx-client README
Self-hosting	Backend README
Smart contracts	Solana Program
SSE streaming	Getting Started Guide
System architecture	ARCHITECTURE.md
Testing	TESTING.md
Use cases	ROADMAP.md

---

📞 Need Help?

• Documentation Issue? Open a GitHub issue
• Technical Support: hello@safetx.io
• Discord Community: Coming soon
• Twitter: Coming soon

---

🤝 Contributing

Want to improve our docs?

1. Fork the repo
2. Edit the markdown files
3. Submit a pull request

We appreciate clear, accurate documentation! 🙏

---

Last Updated: October 22, 2025