Create API Endpoint to Retrieve All Donations

[mubarak23]

We need to implement a comprehensive API endpoint to retrieve donations data with flexible filtering, sorting, and pagination capabilities. This will support various use cases including donation history, campaign analytics, user dashboards, and administrative reporting.
User Stories

As a campaign creator, I want to view all donations made to my campaigns so I can track fundraising progress and thank supporters
As a donor, I want to see my donation history across all campaigns so I can track my contributions
As an admin, I want to access comprehensive donation data for reporting and analytics purposes
As a public user, I want to see anonymized donation statistics for transparency

API Endpoints

Primary: GET /api/v1/donations - Retrieve all donations (admin only)
Campaign Donations: GET /api/v1/campaigns/{campaign_id}/donations
User Donations: GET /api/v1/users/{user_id}/donations
My Donations: GET /api/v1/users/me/donations

Core Features

Pagination: Support for page-based pagination with configurable page sizes
Sorting: Multiple sort options (date, amount, campaign, donor)
Filtering: Advanced filtering by date range, amount range, status, campaign, donor
Search: Text search across campaign names and descriptions
Aggregation: Summary statistics (total amount, donor count, averages)

Query Parameters Support

Pagination: page, limit, sort_by, sort_order
Date filtering: from_date, to_date
Amount filtering: min_amount, max_amount
Entity filtering: campaign_id, donor_id, donation_token
Status filtering: status, confirmed
Search: search parameter for text matching

Response Data Structure
Each donation should include:

Transaction details (hash, block number, gas fee)
Campaign information (ID, reference, title)
Donor information (ID, address, name - respecting privacy settings)
Amount details (raw amount, USD equivalent, token information)
Status and confirmation data
Timestamps (created, confirmed)
Optional message and anonymity flags

[BrayanMQ]

I'm a Computer Science Engineer with backend experience in building scalable APIs using Node.js, TypeScript, and C#. As a maintainer of AquaStark on OnlyDust, I’ve designed and implemented complex data flows and filtering logic. I’d be excited to work on this issue because it involves designing a robust, flexible API that serves multiple user roles and real-world use cases.

To solve it, I would design a modular controller-service architecture, where the main endpoint /api/v1/donations and its variations support dynamic query parameters for pagination, sorting, and filtering. I'd use a query builder (e.g., with Prisma, TypeORM, or raw SQL) to construct efficient database queries that respond to the from_date, min_amount, search, and other filters. Aggregations like total amounts or donor counts would be handled in the service layer, and the final response structure would ensure privacy rules (e.g., hiding donor info when needed) and be consistent across roles.

[blurbeast]

can i jump on this ?

[BrayanMQ]

Working on it. Thanks!

[BrayanMQ]

Hi @mubarak23! I'm currently working on the PR, but when I run pnpm dev I encounter several errors in the seeder.ts file. It seems that some files are missing from their expected directories. Could you please help clarify these issues?

Error: Cannot find module '../../components/v1/auth/authEntities/userAccess.entity'