The official documentation hub for the EcoTask Network.
Architecture guides, API references, whitepaper, onboarding tutorials, and everything you need to understand, contribute to, or build on EcoTask.
ecotask-docs is the single source of truth for all EcoTask documentation. Whether you're a developer integrating with our API, a contributor writing smart contracts, a community organizer onboarding local users, or a researcher studying the platform — this is where you start.
ecotask-docs/
├── whitepaper/
│ └── ecotask-whitepaper.md # Full project whitepaper
│
├── architecture/
│ ├── system-overview.md # High-level system architecture
│ ├── smart-contracts.md # Soroban contract design & flows
│ ├── verification-system.md # How proof verification works
│ └── token-economy.md # ECO token model & economics
│
├── api/
│ ├── overview.md # API conventions & authentication
│ ├── tasks.md # Tasks endpoint reference
│ ├── proofs.md # Proofs endpoint reference
│ ├── users.md # Users endpoint reference
│ └── analytics.md # Analytics endpoint reference
│
└── guides/
├── getting-started.md # Quick start for new contributors
├── mobile-app-setup.md # Setting up ecotask-app locally
├── contracts-setup.md # Setting up ecotask-contracts locally
├── backend-setup.md # Setting up ecotask-backend locally
├── stellar-basics.md # Stellar & Soroban primer for beginners
├── task-creation-guide.md # How to create & publish tasks (NGOs/sponsors)
└── community-validator-guide.md # How to become a community validator
The EcoTask whitepaper covers the full vision, problem statement, solution design, token economics, governance model, and long-term roadmap. Start here if you're new to the project or evaluating it for a partnership.
A bird's-eye view of how all EcoTask components interact — from the mobile app to the Stellar blockchain.
┌──────────────────────────────────────────────────────────────────┐
│ EcoTask System │
│ │
│ ┌─────────────┐ ┌─────────────────┐ ┌───────────────┐ │
│ │ Mobile App │────▶│ Backend API │────▶│ Stellar │ │
│ │ (React │ │ (Node.js) │ │ Blockchain │ │
│ │ Native) │◀────│ │◀────│ (Soroban) │ │
│ └─────────────┘ └────────┬────────┘ └───────────────┘ │
│ │ │
│ ┌────────┼────────┐ │
│ ▼ ▼ ▼ │
│ ┌──────┐ ┌──────┐ ┌──────┐ │
│ │ DB │ │Redis │ │ IPFS │ │
│ │(PG) │ │Queue │ │Proof │ │
│ └──────┘ └──────┘ └──────┘ │
└──────────────────────────────────────────────────────────────────┘
How the three Soroban contracts (eco-token, task-registry, reward-engine) interact, their interfaces, and security considerations.
How EcoTask ensures that claimed tasks were actually completed — from photo analysis and GPS validation to community validators and on-chain proof hashes.
How ECO tokens are minted, distributed, and governed. Includes supply model, reward curve, governance rights, and carbon credit integration plans.
All EcoTask API endpoints documented with request/response examples.
| Endpoint Group | Description |
|---|---|
| Tasks API | Browse, create, and manage climate-action tasks |
| Proofs API | Submit and track proof of task completion |
| Users API | Profiles, wallet linking, and impact history |
| Analytics API | Platform-wide and per-user impact statistics |
Authentication
All protected endpoints require a JWT obtained by signing a challenge with your Stellar wallet private key:
# Step 1: Get a challenge
GET /api/auth/challenge?wallet=GXYZ...
# Step 2: Sign the challenge with your Stellar keypair and submit
POST /api/auth/login
{
"wallet": "GXYZ...",
"signature": "...",
"challenge": "..."
}
# Returns: { "token": "eyJ..." }| Guide | Audience |
|---|---|
| Getting Started | All contributors — start here |
| Mobile App Setup | Frontend / React Native developers |
| Contracts Setup | Blockchain / Rust developers |
| Backend Setup | Backend / Node.js developers |
| Stellar Basics | Developers new to Stellar & Soroban |
| Task Creation Guide | NGOs, sponsors, and task curators |
| Community Validator Guide | Community members who verify tasks |
| Repo | Description |
|---|---|
ecotask-app |
📱 React Native mobile dApp |
ecotask-contracts |
🔗 Stellar Soroban smart contracts |
ecotask-backend |
⚙️ Node.js API & verification engine |
ecotask-docs |
📄 You are here |
Good documentation is as important as good code. We welcome:
- 🐛 Fixing typos, broken links, or outdated information
- 📖 Expanding thin sections or adding missing guides
- 🌐 Translating docs into Swahili, French, Portuguese, or Hindi
- 🎨 Improving diagrams and architecture visuals
# 1. Fork and clone
git clone https://github.com/ecotask-network/ecotask-docs.git
cd ecotask-docs
# 2. Create a branch
git checkout -b docs/improve-verification-guide
# 3. Make your changes (Markdown files)
# 4. Submit a pull requestAll documentation is written in Markdown. Keep language clear, concise, and accessible — many of our users and contributors are not native English speakers.
MIT — see LICENSE for details.
Part of the EcoTask Network — Because the environment deserves an economy.