Documentation

Everything you need to understand, build on, and integrate with Halo Protocol.

Getting Started

Set up your environment and make your first interaction with Halo Protocol. From wallet connection to joining your first circle.

Quick Start Guide
Wallet Connection
Create Your First Circle
Understanding Trust Scores

Core Concepts

Learn the fundamentals of Halo Protocol: how ROSCAs work, trust score calculations, escrow mechanics, insurance pools, and governance.

How ROSCAs Work
Trust Score Algorithm
Escrow & PDAs
Insurance Pools
Governance
Yield Generation

API Reference

Complete reference for the Halo Protocol REST API. Endpoints for authentication, circles, trust scores, users, and webhooks.

Authentication
Circles API
Trust Score API
Users API
Webhooks

Smart Contracts

Technical documentation for the Halo Protocol Anchor program. Account structures, instruction reference, PDA derivations, and error codes.

Program Overview
Account Structures
Instructions
PDA Derivations
Error Codes

Looking for the SDK?

Integrate Halo Protocol into your application with our TypeScript SDK. Query trust scores, manage circles, and interact with the smart contract programmatically.

View SDK Docs