README.md

ChatterPay

ChatterPay is a Wallet for WhatsApp that integrates AI and Account Abstraction, enabling any user to use blockchain easily and securely without technical knowledge.

Built for: Level Up Hackathon - Ethereum Argentina 2024 & Ethereum Uruguay 2024

Built By: mpefaur, tomasfrancizco, TomasDmArg, gonzageraci, dappsar

Components:

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

About this Repo

This repository contains the backend API source code.

Built With:

• Framework: Bun.js
• Language: TypeScript
• Database: mongodb
• Database ODM: mongoose
• web3 SDK: Alchemy
• web3 Library: ethers.js
• web3 swap/bridges SDK: LI.FI
• web3 ERC-4337 Library: Stackup userOps.js
• web3 Data Feed: api3
• Source Code Documentation: jsDoc

Getting Started

1. Install these Requirements:

• git
• bun
• mongoDb

2. Clone repository:

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

3. Complete .env file:

Create a .env file in the root folder and populate it with keys and values described in .env.example file.

4. Install Dependencies:

bun install

5. Start Server:

bun run dev

Then, open in: http://localhost:3000.

Additional Info

Project Structure

• src/:
  • api/: Definition of API paths.
  • controllers/: Helpers that interact with the DB and other services.
  • services/: Business logic.
  • models/: Data model definitions.
  • middleware/: Custom middleware.
  • utils/: Utility functions.
  • config/: Application configurations.
  • types/: Type and interface definitions.
  • constants/: Constants and enumerations.
  • errors/: Custom error classes.
  • index.ts: Application entry point.
• tests/: Unit Tests.
• .gitignore: Specifies files and directories ignored by Git.
• package.json: Project configuration and dependencies.
• tsconfig.json: TypeScript configuration.
• README.md: This File.
• .env.example: Example Environment File.

Source Code Documentation

• We use JSDoc (in english) to document our code.