README.md

ChatterPay ICP Backend

ChatterPay is a Wallet for WhatsApp that integrates AI and Account Abstraction, enabling any user to use blockchain easily and securely without technical knowledge. This repository contains the Internet Computer backend implementation using Motoko.

Sponsored by:

Components:

• Landing Page (product, source code)
• User Dashboard Website (product, source code)
• Backend API (this Repo)
• Smart Contracts (source code)
• Data Indexing (Subgraph) (source code)
• Bot AI Admin Dashboard Website (product)
• Bot AI (Chatizalo) (product)

About this Repo

This repository contains the Internet Computer backend implementation using Motoko, providing a decentralized backend infrastructure for ChatterPay.

Built With:

• Platform: Internet Computer
• Language: Motoko
• Development Framework: DFX
• Interface Description: Candid

Getting Started

1. Install Requirements:

• DFX
• Node.js (for development tools)
• Git

2. Clone repository:

git clone https://github.com/P4-Games/ChatterPay-ICP-Backend
cd ChatterPay-ICP-Backend

3. Install DFX:

sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"

4. Start Local Network:

dfx start --background

5. Deploy Canisters:

dfx deploy

The backend will be available at the provided canister URLs.

Project Structure

• src/:
  • types.mo: Shared type definitions
  • transactions/: Transaction management canister
  • users/: User management canister
  • blockchains/: Blockchain configuration canister
  • tokens/: Token management canister
  • nfts/: NFT management canister
  • last_processed_blocks/: Block processing tracking canister
• dfx.json: Project configuration file
• .gitignore: Git ignore configuration
• README.md: This file

Canisters Overview

The backend is composed of several specialized canisters:

1. TransactionStorage:

   • Manages transaction records
   • Tracks transaction status and history
   • Provides transaction querying capabilities

2. UserStorage:

   • Handles user profiles and authentication
   • Manages wallet associations
   • Phone number to wallet mapping

3. BlockchainStorage:

   • Stores blockchain configurations
   • Manages smart contract addresses
   • Handles network-specific settings

4. TokenStorage:

   • Manages token information
   • Tracks token metadata
   • Chain-specific token configurations

5. NFTStorage:

   • Handles NFT minting and management
   • Stores NFT metadata
   • Manages NFT ownership and transfers

6. LastProcessedBlockStorage:

   • Tracks blockchain synchronization
   • Manages processing checkpoints
   • Network-specific block tracking

API Documentation

Each canister exposes its API through Candid interfaces. Here are the main endpoints for each canister:

Transactions

• addTransaction: Create a new transaction record
• getTransaction: Retrieve transaction by ID
• getTransactionsByWallet: Get transactions for a specific wallet
• getAllTransactions: List all transactions

Users

• createUser: Register a new user
• getUser: Retrieve user information
• getWalletByPhoneNumber: Get wallet address by phone number
• updateUser: Update user information

NFTs

• createNFT: Mint a new NFT
• getNFT: Retrieve NFT information
• getNFTsByWallet: Get NFTs owned by a wallet
• updateNFTMetadata: Update NFT metadata

For complete API documentation, deploy the canisters and visit the Candid interface.

Development

To start development:

1. Start local network:

dfx start --background

2. Deploy canisters:

dfx deploy

3. Test the API:

dfx canister call <canister_name> <method_name> '(<arguments>)'

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.