[RIP00026] PDF Report Generator for YAM (Dev Competition)

LoganSulpizio

[Developer Competition] PDF Report Generator for YAM

🇫🇷 Version francophone en deuxième partie de message

Summary

I propose the development of a PDF Report Generator for YAM. This tool would allow users to generate detailed reports of their YAM transactions, facilitating record-keeping and financial analysis.

Objective

The goal is to create an application that enables users to export their transaction history (buys and sells) for a specific period of time into a structured and readable PDF report. This would help users track their YAM activity and monitor the evolution of their portfolio value.

How it works?

The YAM PDF report generator will be accessible through a web browser via a specific URL. On the web page, the user will enter one or more wallet addresses and select a time period. After submission, a clear and structured PDF report summarizing their transactions will be generated and made available for download.

Differences with other existing YAM history tracking

Although an activity history already exists in the official YAM website, this PDF report generator will offer a more user-friendly format, making it easier for users to track their transactions. This application will allow for filtering by time period and transaction type (buy/sell), giving users more control over the data they see. The first version will be simple but highly functional. Future iterations could easily include additional filters, such as currency selection, sorting options, and more, based on community feedback and requests.

Application Architecture

The application will be structured into four main components:

Transaction Indexing Module – A dedicated module responsible for continuously indexing all YAM transactions into a database. This database will enable quick access and efficient retrieval of transaction history. The indexing strategy would not rely on The graph as it is frequently down and not well-regarded by the YAM community.
Data Retrieval Engine – Upon a user’s request for a report, this component will query the indexed database to retrieve the relevant transactions based on the specified wallet addresses and time period.
PDF Generation Module – Using the retrieved transaction data, this module will format and generate a nice PDF report, ensuring clarity and providing comprehensive financial insights.
User Interface – A user-friendly web interface where users can input their wallet addresses, specify a time range, and request reports. The interface will be intuitive, offering clear navigation and seamless access to the generated reports

Development timeline

The development timeline for this project aligns with the competition requirements, with an estimated completion time of 1 to 2 months. The initial version will be fully functional, allowing users to generate detailed and accurate transaction reports. Additional features and refinements can be integrated based on community feedback, ensuring the tool evolves to meet user needs while staying within the expected timeframe.

About Me

As a frequent RealToken investor passionate about blockchain and tech, I understand how difficult it can be to track your YAM transactions efficiently. This tool is something I wish existed, and I'm excited to make it happen for the community.

One of my previous projects includes developing a Telegram bot The YAMSaleNotifyBot that sends notifications to users when some of their RealToken are sold on YAM. This bot has already sent over 10,000 notifications, keeping RealToken users informed whenever one of their offers has been bought. I am committed to contributing to the RealToken ecosystem and continuously looking for ways to improve it, and I look forward to engaging with the community to create even more valuable features.

Additionally, I am an application engineer working in a Belgian tech company, which allows me to bring a professional perspective and expertise to the development of solutions that benefit the community.

====================================================================

🇫🇷 [Concours Développeur] Générateur de Rapport PDF pour le YAM

Résumé

Je propose le développement d’un générateur de rapports PDF pour YAM. Cet outil permettra aux utilisateurs de générer des rapports détaillés de leurs transactions YAM, facilitant ainsi leur analyse financière et le reporting de celui-ci.

Objectif

L’objectif est de créer une application permettant aux utilisateurs d’exporter leur historique de transactions (achats et ventes) sur une période donnée, sous forme d’un rapport PDF structuré et lisible. Cela aidera les utilisateurs à suivre leur activité sur YAM et à surveiller l’évolution de leur achat et ventes sur le YAM.

Comment ça fonctionne ?

Le générateur de rapport PDF YAM sera accessible via un navigateur web à une URL spécifique. Sur la page web, l’utilisateur pourra entrer une ou plusieurs wallet adresses et sélectionner une période de temps. Après soumission, un rapport PDF clair et structuré résumant leurs transactions sera généré et disponible en téléchargement.

Différences avec les outils existants de suivi de l’historique YAM

Bien qu’un historique d’activité existe déjà sur le site officiel du YAM, ce générateur de rapport PDF offrira un format plus convivial, facilitant le suivi des transactions. L’application permettra de filtrer par période de temps et par type de transaction (achat/vente), offrant ainsi un meilleur contrôle sur les données affichées. La première version sera simple mais fonctionnelle. Des versions futures pourront inclure des filtres supplémentaires, comme le choix du stablecoin, des options de tri, etc., en fonction des retours et demandes de la communauté.

Architecture de l’application

L’application sera structurée autour de quatre modules principaux :

Module d’indexation des transactions – Un module dédié à l’indexation continue de toutes les transactions YAM dans une base de données interne à l’application. Cette base permettra un accès rapide et efficace à l’historique des transactions. La stratégie d’indexation ne reposera pas sur The Graph, souvent indisponible et peu apprécié par la communauté.
Moteur de récupération des données – Lorsqu’un utilisateur demande un rapport, ce module interrogera la base indexée pour extraire les transactions pertinentes selon les adresses et la période choisies.
Module de génération PDF – À partir des données récupérées, ce module formatera et générera un rapport PDF lisible, offrant des insights financiers clairs et complets.
Interface utilisateur – Une interface web intuitive où les utilisateurs pourront saisir leurs adresses, définir une période, et demander leurs rapports. La navigation sera fluide et l’accès aux rapports générés sera simple.

Calendrier de développement

Le calendrier de développement respectera les exigences du concours, avec une estimation de finalisation entre 1 et 2 mois. La version initiale sera pleinement fonctionnelle, permettant aux utilisateurs de générer des rapports de transactions détaillés et fiables. Des fonctionnalités supplémentaires pourront être intégrées par la suite selon les retours de la communauté, pour faire évoluer l’outil en fonction des besoins, tout en respectant les délais prévus.

À propos de moi

Investisseur régulier sur RealT et passionné par la blockchain et la tech, je sais à quel point il peut être difficile de suivre efficacement ses transactions sur le YAM. Cet outil est quelque chose que j’aurais aimé avoir, et je suis enthousiaste à l’idée de le créer pour la communauté.

Parmi mes projets précédents, j’ai développé un bot Telegram The YAMSaleNotifyBot qui envoie des notifications aux utilisateurs lorsqu’un de leurs RealTokens est vendu sur le YAM. Ce bot a déjà envoyé plus de 10 000 notifications, tenant les utilisateurs informés lorsque leur offre est achetée.

Je suis déterminé à contribuer à l’écosystème RealToken et j’ai hâte de collaborer avec la communauté pour créer encore plus de fonctionnalités utiles.

Par ailleurs, je suis aussi ingénieur application dans une entreprise technologique belge, ce qui me permet d’apporter une expertise professionnelle au développement de solutions bénéfiques pour la communauté.

Battistu

Hi LoganSulpizio,
That’s a great idea! It would definitely help tokenholders keep track of their records for tax and other accounting purposes. I’m not sure if it’s possible, but what about adding a feature that shows all RealToken transfers to wallets not owned by the user?

A user might have multiple wallets.
A user can transfer tokens to any of their own wallets (and of course, those wallets must be whitelisted to receive RealTokens).
=> If a user transfers tokens to someone else’s wallet, that transaction could be interpreted as a donation.

I’m not sure where the data confirming a user’s various addresses is stored, but some community tools may have access to this information.

GL & HF 🙂

LoganSulpizio

Battistu
Hello Battistu,
It would definitely be possible to add all the RealToken transfers to the PDF, and it’s a good suggestion. However, it would require another indexing module, as the one I’m proposing here would only handle the YAM transactions. So why not include it in a second version because I just don’t think I’ll have the time to include it in the first one.

LoganSulpizio

📄 Project Title: PDF Report Generator for YAM

🔍 Summary:
This project will deliver a web-based tool that lets users generate structured PDF reports of their YAM transactions 📊. It will help users keep clear records and analyze their YAM activity over any chosen time period — ideal for portfolio tracking and financial reporting.

✅ Features of the project:
🧾 Enter one or more wallet addresses and a time range via a simple web interface.
🔍 Filter transactions by type (buy/sell) and time period.
📁 Generate a clean, structured, downloadable PDF report summarizing the user's YAM activity.
🌐 Accessible through a dedicated web page

More details here: https://forum.realtoken.community/d/57-dev-competition-pdf-report-generator-for-yam

PhilP

Cette proposition ayant obtenu la troisième place dans le nombre vote "pour" du concours, la prime de 2000 $ (en armmv3XDAI ou armmv3USDC) sera attribuée a son développeur, une fois :

l'application déployée sur le github de la communauté et fonctionnelle,
validation par RealT,
un dernier vote pour exécuter le transfert de la prime.