Technical Documentation

Protected Documentation

This technical documentation is password protected. Please enter the password to access the content.

1.1 High-Level Overview
1.2 Core Objectives and Value Propositions
1.3 Architecture in Brief
2.1 Overall Architecture Diagram
2.2 Frontend (Next.js, React, TypeScript)
2.3 Backend (Next.js API, Node.js, Express-Style Middleware)
2.4 Database Layer (PostgreSQL, R2/IPFS for Documents)
2.5 Containerization & Deployment (Docker, CI/CD)
2.6 Key Integrations (KYC/AML Providers, External APIs)
3.1 Authentication (JWT, MPC Wallet Integration)
- 3.1.1 JWT-Based Auth
- 3.1.2 MPC Wallets
3.2 Encryption (Data at Rest & In Transit)
- 3.2.1 Data in Transit
- 3.2.2 Data at Rest
3.3 Zod Validation & Business Logic Enforcement
- 3.3.1 Zod for Type-Safe Schemas
- 3.3.2 Enforcement in Business Logic
3.4 Role-Based Access Control
- 3.4.1 Role Hierarchy
- 3.4.2 Implementation
3.5 Activity Logging & Audit Trails
- 3.5.1 Log Structure
- 3.5.2 Use Cases
3.6 Backup & Disaster Recovery Strategies
- 3.6.1 Database Backups
- 3.6.2 Document Redundancy
- 3.6.3 Disaster Recovery
4.1 KYC/AML Integration (Sumsub, ShuftiPro)
- 4.1.1 Overview
- 4.1.2 Workflow
- 4.1.3 Risk & Sanction Alerts
4.2 Accredited Investor Checks & Self-Accreditation
- 4.2.1 Accredited Investor Requirements
- 4.2.2 Self-Accreditation Flow
- 4.2.3 Renewals & Expirations
4.3 Broker & Transfer Agent Approval Mechanisms
- 4.3.1 Broker Approval
- 4.3.2 Transfer Agent Oversight
4.4 Multiple Regulation Selection (e.g., Reg D 506(c), Reg S)
- 4.4.1 Purpose
- 4.4.2 Implementation
- 4.4.3 Documentation & Disclaimers
- 4.4.4 Automatic Warnings & Blocks
4.5 Regulatory Presets & Country-Based Disclaimers
- 4.5.1 Preset Library
- 4.5.2 Template Generation
- 4.5.3 Document Storage
4.6 GDPR & Other Data Privacy Considerations
- 4.6.1 Data Minimization & Retention
- 4.6.2 Right to Erasure
- 4.6.3 Consent Management
5.1 Deal Wizard (Zod-Validated Steps)
- 5.1.1 Purpose
- 5.1.2 Step Breakdown
- 5.1.3 Draft & Autosave
5.2 Required Documents & Templates (Offering Memorandum, Subscription Agreement)
- 5.2.1 Document Types
- 5.2.2 Template Generation
- 5.2.3 Document Storage
5.3 Key Terms, FAQ, and Document Repositories
- 5.3.1 Key Terms
- 5.3.2 FAQ
- 5.3.3 Document Repository
5.4 Lifecycle States (Draft → Pending → Active → Closed)
5.5 Broker Approval Workflow
- 5.5.1 When Broker Approval is Required
- 5.5.2 Broker Action
- 5.5.3 Logging & Notifications
5.6 Issuer Dashboard & Admin Oversight
- 5.6.1 Issuer Dashboard
- 5.6.2 Admin Panel
5.7 E-Signature Implementation
- 5.7.1 SignatureDialog Component
- 5.7.2 Technical Implementation
- 5.7.3 Integration with Document System
6.1 Smart Contract Architecture
- 6.1.1 Overview
- 6.1.2 Key Goals
6.2 Token Issuance & Management
- 6.2.1 Custom Security Tokens (Equity, Debt, Revenue Shares)
- 6.2.2 Transfer Restrictions & Automated Compliance Checks
- 6.2.3 Snapshot Functionality (Dividends & Governance Voting)
- 6.2.4 Metadata Linking to Legal Documents
6.3 Secondary Market (On-Chain Trading)
- 6.3.1 Live Marketplace Capabilities (Order Book, P2P Escrow)
- 6.3.2 Automated Regulatory Checks Before Trade Execution
- 6.3.3 Integration with Primary Issuance for Seamless Transitions
6.4 Investment Pooling & Fund Management
- 6.4.1 Tracking Individual Investor Contributions
- 6.4.2 Cap Table Management for Token Holders
- 6.4.3 Basic Aggregation vs. Future Advanced Pooling
6.5 Dividend & Reward Distribution
- 6.5.1 ERC-20 Snapshot Method
- 6.5.2 Calculating Dividends Proportionally
- 6.5.3 Governance Voting via Snapshot Points
- 6.5.4 Audit Trails for Distribution
6.6 Transaction Management & Logging
- 6.6.1 Gas Estimation & Transaction Monitoring
- 6.6.2 Gasless Transactions
- 6.6.3 Comprehensive On-Chain Logging & Status Tracking
- 6.6.4 Off-Chain Sync with Platform DB
7.1 TokenSale Contract (Crypto-Based Contributions)
- 7.1.1 Purpose
- 7.1.2 Payment Flows (ETH, Stablecoins)
- 7.1.3 Softcap/Hardcap & Refund Logic
- 7.1.4 Lockup & Vesting Schedules
- 7.1.5 Integration with Platform (Investor UI, Admin Tools)
7.2 P2PEscrow Contract (Secondary Trading)
- 7.2.1 Deal Listing & Whitelisting Mechanisms
- 7.2.2 Execution Flow (Ask/Bid, Transfer)
- 7.2.3 Cancel & Update Options for Sellers
- 7.2.4 Off-Chain Broker/Transfer Agent Checks
8.1 Fiat Payment Handling (Issuer Manual Confirmation)
- 8.1.1 Why Manual Confirmation
- 8.1.2 Workflow
- 8.1.3 Limitations & Safeguards
8.2 Crypto Payment Confirmation & On-Chain Settlement
- 8.2.1 TokenSale Integration
- 8.2.2 Direct vs. Payment Gateways
- 8.2.3 Monitoring & Automatic Reconciliation
8.3 Escrow vs. Direct Payment Models
- 8.3.1 Escrow Model
- 8.3.2 Direct Payment
- 8.3.3 Use Cases
8.4 Fee & Commission Structures
- 8.4.1 Platform Fees
- 8.4.2 Broker/Transfer Agent Commissions
- 8.4.3 Potential Referral Fees
9.1 Registration & Onboarding (KYC)
- 9.1.1 Account Creation
- 9.1.2 KYC/AML Flow
- 9.1.3 Optional Accreditation Declaration
9.2 Browsing & Evaluating Deals (Investor Perspective)
- 9.2.1 Deal Discovery
- 9.2.2 Deal Detail
- 9.2.3 Investment Decision
9.3 Deal Setup & Approval (Issuer & Broker Perspective)
- 9.3.1 Issuer Creating a Deal
- 9.3.2 Broker Review
9.4 Transfer Agent Oversight for Secondary Trades
- 9.4.1 Investor Trading
- 9.4.2 Transfer Agent Dashboard
9.5 Admin & Super Admin Dashboards
- 9.5.1 Admin Dashboard
9.6 Admin Panel Implementation
- 9.6.1 Admin Architecture
- 9.6.2 Admin Dashboard
- 9.6.3 User Management
- 9.6.4 Deal Administration
- 9.6.5 API Structure
10.1 In-App Notifications (Pending Approvals, Deal Updates)
- 10.1.1 Notification Center
- 10.1.2 Real-Time Feeds
10.2 Email & External Channels (Telegram, Slack, Webhooks)
- 10.2.1 Email Notifications
- 10.2.2 External Integrations (Telegram, Slack, Webhooks)
10.3 Configurable Alerts & Preferences
- 10.3.1 User Settings
- 10.3.2 Role-Specific Defaults
- 10.3.3 Unsubscribe / GDPR Compliance
11.1 Core Tables (Users, Deals, KYC, Applications, P2P Trades)
- 11.1.1 Users Table
- 11.1.2 Deals Table
- 11.1.3 KYC Data Table
- 11.1.4 Applications Table
- 11.1.5 P2P Trades Table
11.2 Additional Tables (TokenSale Records, Lockup Tracking)
- 11.2.1 TokenSale Records
- 11.2.2 Lockup Balances (If Off-Chain)
- 11.2.3 Activity Logs & Notifications
11.3 ER Diagram / Relationship Overview
11.4 API Endpoint Summaries (Auth, Deals, P2PEscrow, TGE)
- 11.4.1 Auth Endpoints
- 11.4.2 Deals Endpoints
- 11.4.3 P2PEscrow Endpoints
- 11.4.4 TGE/TokenSale Endpoints
11.5 Request & Response Samples
- 11.5.1 Deal Creation (POST /api/deals)
- 11.5.2 P2P Trade Execution (POST /api/p2p-trades/[id]/execute)
12.1 Load Testing Results & Benchmark Goals
- 12.1.1 Methodology
- 12.1.2 Key Findings
- 12.1.3 Target Benchmarks
12.2 Horizontal Scaling of Services & Databases
- 12.2.1 Next.js Application Scaling
- 12.2.2 Database Scaling
- 12.2.3 Caching & Edge
12.3 Caching Strategies (React Query, SSR, Edge Caching)
- 12.3.1 React Query (Client-Side)
- 12.3.2 Server-Side Rendering (SSR) Cache
- 12.3.3 Edge Delivery (CDN)
12.4 Monitoring & Alerting (Prometheus, Datadog, etc.)
- 12.4.1 Metrics & Observability
- 12.4.2 Alerts & Incident Response
13.1 Overall Security Enhancement Strategy
- 13.1.1 Ongoing Internal Code Reviews
- 13.1.2 Adherence to Regulatory Security Frameworks
13.2 Smart Contract Audits
- 13.2.1 Third-Party Audit Partnerships
- 13.2.2 Regular Re-Audit for Upgrades or Major Changes
- 13.2.3 Bug Bounty Programs & Responsible Disclosure
13.3 Penetration Testing & Threat Modeling
- 13.3.1 External Pen Tests for Frontend & API
- 13.3.2 Threat Modeling for On-Chain Logic
13.4 Security Roadmap & Timeline
- 13.4.1 Short-Term Actions (Bug Bounties, Automated Tools)
- 13.4.2 Mid-Term Goals (Scheduled Audits, SOC 2 Readiness)
- 13.4.3 Long-Term Vision (Zero-Knowledge Proofs, Additional MPC Enhancements)
14.1 Referral & Rewards System
- 14.1.1 User Invitation Mechanics
- 14.1.2 Conversion Analytics
- 14.1.3 Anti-Spam & KYC Requirements
14.2 DeFi Integrations (Collateralized Lending, Yield Farming)
- 14.2.1 Collateralization of Security Tokens
- 14.2.2 Yield Farming Partnerships
- 14.2.3 Risk & Regulatory Considerations
14.3 Advanced Analytics & AI-Driven Risk Management
- 14.3.1 Investor Analytics
- 14.3.2 Issuer & Admin Analytics
- 14.3.3 ML or Predictive Models
14.4 Layer-2 / Cross-Chain Expansions
- 14.4.1 Layer-2 Adoption
- 14.4.2 Cross-Chain Bridges
- 14.4.3 Multi-Chain UI
14.5 Additional Regulation Presets & Jurisdiction Support
- 14.5.1 Expanded Jurisdictions
- 14.5.2 More Complex Regulatory Integrations
- 14.5.3 Ongoing Legal Partnerships
15.1 Summary of Technical Strengths & Compliance Alignment
15.2 Next Steps & Implementation Guidance
15.3 Contact & Support Info