24 developer checklist

Overview

This checklist provides a comprehensive guide for developers building the platform. It covers all critical components and ensures nothing is missed.

Smart Contracts

ProjectRegistry Contract

• Implement ERC-721 or ERC-1155 (supply = 1 per project)

• Store project metadata hash

• Store PoAI proof hashes (bundle, asset, data, process)

• Store issuance cap

• Implement mintProjectRecord() function

• Implement isPoAIApproved() function

• Implement suspendProject() function

• Implement reactivateProject() function

• Emit ProjectRecordMinted event

• Emit ProjectSuspended event

• Emit ProjectReactivated event

• Add access control (GOVERNANCE_ROLE)

• Add PoAI validation (hashes must be non-zero)

• Add cap validation (cap > 0)

CarbonCredit1155 Contract

• Implement ERC-1155 standard

• Define UNIT constant (1e6 or 1e18)

• Store cap per tokenId

• Store issued per tokenId

• Store retired per tokenId

• Store projectActive per tokenId

• Store transferPolicy per tokenId

• Implement setProjectConfig() function

• Implement mintCredits() function

• Implement retire() function

• Implement balanceOf() function

• Override _beforeTokenTransfer() for policy enforcement

• Enforce cap: issued + amount <= cap

• Enforce balance: balance >= amount for retirement

• Enforce PoAI: Check projectRegistry.isPoAIApproved()

• Emit ProjectConfigured event

• Emit CreditsMinted event

• Emit CreditsRetired event

• Add access control (ISSUER_ROLE, GOVERNANCE_ROLE)

• Add pause functionality (optional)

• Add reentrancy protection

• Add integer overflow protection (Solidity 0.8+)

Governance Contract (Optional Separate)

• Implement proposal structure

• Implement createProposal() function

• Implement vote() function

• Implement executeProposal() function

• Enforce quorum threshold

• Enforce majority threshold

• Enforce voting window

• Enforce execution delay

• Emit ProposalCreated event

• Emit VoteCast event

• Emit ProposalExecuted event

• Add access control

Access Control

• Define roles (ISSUER_ROLE, GOVERNANCE_ROLE, PAUSER_ROLE)

• Implement role assignment

• Implement role revocation

• Implement role checking

• Use OpenZeppelin AccessControl (recommended)

---

Off-Chain Services

PoAI Service

• Implement PoAI case management

• Implement document ingestion

• Implement integrity checks (Asset, Data, Process)

• Implement reviewer workflow

• Implement proof bundle generation

• Implement proof hash generation

• Implement proof bundle signing (optional)

• Implement proof bundle storage (encrypted)

• Implement PoAI state machine

• Implement audit logging

• Create PoAI API endpoints

• Implement PoAI database schema

Project Management Service

• Implement project CRUD operations

• Implement document upload

• Implement document hash generation

• Implement document storage (encrypted)

• Implement project status management

• Implement project search

• Create project API endpoints

• Implement project database schema

Indexer Service

• Listen to ProjectRecordMinted events

• Listen to CreditsMinted events

• Listen to CreditsTransferred events (if enabled)

• Listen to CreditsRetired events

• Listen to ProjectConfigured events

• Listen to governance events

• Parse event data

• Update database

• Handle missed events (re-sync)

• Handle reorgs

• Handle contract upgrades

• Implement event ordering

Reporting Engine

• Implement certificate PDF generation

• Implement certificate JSON generation

• Implement ESG report generation

• Implement audit trail report generation

• Support multiple formats (PDF, CSV, JSON, Excel)

• Implement report storage

• Implement report download links

• Implement email delivery (optional)

• Include PoAI proof references in certificates

• Include transaction hashes in certificates

Marketplace Pricing Engine

• Implement base price calculation

• Implement dynamic pricing (optional)

• Implement fee calculation

• Implement price history

• Create marketplace API endpoints

Auth & RBAC Service

• Implement JWT authentication

• Implement wallet signature verification

• Implement role-based access control

• Implement user management

• Implement organization management

• Implement team member management

• Create auth API endpoints

---

Frontend Modules

Public Pages

• Landing page

• Marketplace (project grid/list)

• Project details page

• Filters and search

• PoAI badge component

Retail Modules

• Wallet connection

• Retail dashboard

• Holdings view

• Purchase flow

• Retirement flow

• Certificates view

• Certificate download

Enterprise Modules

• Enterprise dashboard

• Organization setup

• Team management

• Emissions mapping form

• Project portfolio selection

• Purchase interface

• Holdings view

• Retirement scheduler

• Reports export

Admin Modules

• Admin panel

• Project submissions list

• PoAI review interface

• Governance proposal support

• Support ticket management

---

APIs

Projects API

• POST /projects (create)

• GET /projects (list)

• GET /projects/:id (detail)

• PUT /projects/:id (update)

• POST /projects/:id/documents (upload)

• GET /projects/:id/documents (list)

• POST /projects/:id/poai/submit

• GET /projects/:id/poai/status

PoAI API

• GET /poai/cases (list)

• GET /poai/cases/:id (detail)

• POST /poai/cases/:id/assign

• POST /poai/cases/:id/checks

• POST /poai/cases/:id/approve

• POST /poai/cases/:id/reject

Retail API

• GET /me/holdings

• POST /purchase

• POST /retire

• GET /certificates

Enterprise API

• POST /org (create)

• POST /org/users (add team member)

• POST /org/emissions

• POST /org/retirement-schedule

• POST /org/reports

• GET /org/reports/:id

Indexer API

• GET /indexer/status

• POST /indexer/sync/:blockNumber

---

Database Schema

Core Tables

• users table

• organizations table

• projects table

• project_documents table

• project_records table (on-chain sync)

• poai_cases table

• poai_checks table

• poai_proofs table

• credit_balances table (on-chain sync)

• orders table

• retirements table

• certificates table

• governance_proposals table

• audit_logs table

---

Security

Smart Contract Security

• Access control implemented

• Reentrancy protection

• Integer overflow protection

• Pause mechanism (optional)

• Input validation

• Gas optimization

Backend Security

• API authentication (JWT)

• Rate limiting

• Input validation

• Encrypted document storage

• Secure file uploads

• SQL injection prevention

• XSS prevention

Frontend Security

• Wallet connection validation

• Transaction signing confirmation

• Secure storage of sensitive data

• HTTPS only

• Content Security Policy

---

Testing

Smart Contract Tests

• Unit tests for all functions

• Integration tests for flows

• Edge case tests

• Gas optimization tests

• Security tests (fuzzing, etc.)

Backend Tests

• API endpoint tests

• Service unit tests

• Integration tests

• Database tests

Frontend Tests

• Component tests

• Integration tests

• E2E tests

• User flow tests

---

Documentation

• API documentation

• Smart contract documentation

• Frontend component documentation

• Deployment guides

• User guides

• Developer guides

---

Deployment

• Smart contract deployment scripts

• Backend deployment configuration

• Frontend deployment configuration

• Environment variable management

• Database migration scripts

• Monitoring and logging setup