Create Documentation for Integration

[mohammadranjbarz]

System Architecture Documentation (Phase 1)

Overview

This document provides a clear overview of our current system architecture and proposes enhancements to better manage organizational preferences and project presentations. It outlines managing organizations, projects, and tokens within a blockchain-based environment, focusing on scalability and robustness.

Current Architecture

Entity Relationship Diagram

Entity Descriptions

• Organization: Represents entities like NGOs or social enterprises, managing multiple projects and having access to various tokens.
• Project: Specific initiatives or campaigns managed by an organization.
• Token: Different types of cryptocurrency tokens, each associated with a networkId identifying the blockchain network.

Proposed Enhancements

Updated Entity Relationship Diagram

Changes to Organization Entity

• notificationDisabled: A boolean indicating whether notifications or emails should be sent for projects of this organization.
• coverImageUrl: A URL pointing to a cover image for projects associated with the organization.
• recurringDonationsEnabled: A boolean to enable or disable recurring donations for projects.

Examples

Current Organizations

• Trace
• Giveth
• Giving Blocks

Proposed Organization Examples

• Trace

  • Notification Disabled: True
  • Cover Image URL: "https://example.com/trace-cover.jpg"
  • Recurring Donations Enabled: True

• Giveth

  • Notification Disabled: True
  • Cover Image URL: "https://example.com/giveth-cover.jpg"
  • Recurring Donations Enabled: True

• Giving Blocks

  • Notification Disabled: False
  • Cover Image URL: "https://example.com/givingblocks-cover.jpg"
  • Recurring Donations Enabled: True

Tokens examples:

• ETH (Ethereum) - networkId: 1
• WBTC (Wrapped Bitcoin) - networkId: 10
• USDC (USD Coin) - networkId: 100