Welcome to the official documentation for SafiGuard — a parametric micro-insurance platform built on Stellar and Soroban.
SafiGuard provides automated crop and weather insurance for underserved markets in Africa and Latin America. By leveraging blockchain technology, decentralized oracles, and parametric triggers, SafiGuard delivers transparent, affordable, and instant insurance payouts to smallholder farmers and communities most vulnerable to climate change.
| Section | Description |
|---|---|
| Architecture | System design, smart contracts, oracle, actuarial model, security |
| User Guides | Getting started, buying insurance, risk pools, deployment, oracle operations |
| API Reference | REST API, smart contract API, SDK reference |
| Glossary | Key terms and definitions |
| Diagrams | Mermaid diagrams for system architecture and data flows |
| Templates | ADR and RFC templates for contributors |
- System Architecture Overview — High-level system design and component interactions
- Smart Contract Architecture — Soroban contract design and storage layout
- Oracle System Design — Multi-source data aggregation and consensus
- Actuarial Model — Premium calculation, risk assessment, payout triggers
- Security Model — Smart contract, oracle, and API security
- Getting Started — Prerequisites, setup, and first steps
- Buying Insurance — End-to-end guide for purchasing coverage
- Risk Pool Participation — Depositing liquidity and earning returns
- Deployment Guide — Deploying contracts, frontend, and backend
- Oracle Operator Guide — Running and maintaining an oracle node
- REST API — Backend API endpoints and authentication
- Smart Contract API — Contract functions and invocation examples
- SDK Reference — TypeScript, Python SDK, and CLI tools
- Glossary — 25+ key terms defined
- Diagrams — Visual system architecture and data flows
- Templates — ADR and RFC templates
SafiGuard is organized across five repositories:
| Repository | Description | Tech Stack |
|---|---|---|
| safiguard-contracts | Soroban smart contracts | Rust, Soroban SDK |
| safiguard-frontend | Web application | React, TypeScript, Freighter |
| safiguard-backend | API server and oracle | Node.js, Express, PostgreSQL |
| safiguard-sdk | Developer SDK and CLI | TypeScript, Python |
| safiguard-docs | Documentation (this repo) | Markdown, Mermaid |
We welcome contributions to improve SafiGuard's documentation. Whether it is fixing a typo, adding a missing section, or improving an explanation, your contributions help the entire community.
- Fork this repository
- Clone your fork locally:
git clone https://github.com/<your-username>/safiguard-docs.git cd safiguard-docs
- Create a branch for your changes:
git checkout -b docs/your-improvement
- Make your changes following our Contributing Guide
- Submit a Pull Request with a clear description of your changes
- Use clear, concise language
- Include code examples where helpful
- Add Mermaid diagrams for complex flows
- Follow existing formatting conventions
- Test all code snippets before submitting
For detailed contribution guidelines, see CONTRIBUTING.md.
This documentation is written in Markdown and can be viewed directly on GitHub. For local development:
# Install markdownlint for linting
npm install -g markdownlint-cli
# Lint all markdown files
markdownlint 'docs/**/*.md' '*.md'
# Optional: Use a local Markdown preview tool
npx serve .This documentation is licensed under the MIT License.
Copyright (c) 2025 Tetech-Labs.
- GitHub Issues: safiguard-docs/issues
- Email: docs@tetech-labs.com
- Discord: SafiGuard Community
SafiGuard — Protecting livelihoods through decentralized parametric insurance.