completed

cReport - Catalyst analyzer & KPIs

$28,420.00 Received
$28,420.00 Requested
Ideascale logo View on ideascale
Community Review Results (1 reviewers)
Addresses Challenge
Feasibility
Auditability
Solution

Create a realtime, public report application to analyze catalyst data & generate reports to show and assess funded proposals KPIs & funds.

Problem:

Cardano, external users need quality reports, KPIs to have insightful, actionable data of funded proposals and general funds data.

Yes Votes:
₳ 63,408,746
No Votes:
₳ 1,089,494
Votes Cast:
336

This proposal was approved and funded by the Cardano Community via Project F8: Improve and Grow Auditability Catalyst funding round.

  • download
  • download
  • download
  • download
  • download
  • download
  • download
  • download
  • download
  • download
  • download
  • download

[IMPACT]

<u>Introduction</u>

Catalyst project has been home for Cardano's applications, developers and community people. Its fund is very important to help proposers turn out their ideas to real life applications.

Having a common place to provide Cardano users valuable reports, KPIs, trends and other data they need for their action is critical for project. This is cReport's mission.

cReport include a set of tool and application aim to collect data then transform to useable information, KPIs which users can use for their action.

This can be done by use the stated information in a funded proposal like: its requested fund, expect KPIs, wallet address, smart contract address to build a dataset which use for generating reports and audit proposal.

We aim to audit all funded proposals to provide user the overview of catalyst fund*,* products from funded proposals with various of matrix like: ROI, product performance, to result out the human understandable data like: excellent, out standing, or stopped.

The main parts of this project are:

  • Create a realtime report application to analyze catalyst data & generate reports at some levels
  • Extract data from Catalyst to init data for application
  • Application then works and provide reports, KPIs, assestment with realtime data.

A good example of the application use: someone needs to find the best potential tokens to invest early they then visit cReport view the best ranked products from funded proposals then view details like revenue, ROI, transactions and volume that data give them good insights to make right decisions.

<u>Architecture</u>

The Architecture contains backend API, frontend, database and scripts run on AWS and interact with Cardano network, IdeaScale, Github to form cReport, it includes:

  • Tool to query raw data from various sources: IdeaScale, Github, Cardano network.
  • Backend API, server logics and background jobs.
  • Database server to store raw and analyzed data.
  • Web Frontend and mobile application for Cardano users and CMS.

See our attached architecture and workflow images to have detail.

<u>Features</u>

  • Realtime valuable, specific and actionable report which help users to act at some level.
  • Maximum realtime feature in collect raw data this to provide user up to date information.
  • Simple, fast and stable application.

<u>Functions</u>

  • Generate reports for summarized proposal and fund insights: Top level report on funded proposal, allocation breakdown and assess its return into products and its impacts with some metric like network transactions, product revenue.
  • Assess fund and KPIs for a single proposal: released product performance: how it matched with stated KPIs, ROI can be counted by network transaction through product, revenue, smart contract calls, number of users.
  • Assess proposer and group proposers KPIs: which one is best in term of having success products.
  • Rank released products resulted from funded proposals count by some metrics like: smart contract calls, network transaction, number of users, generating revenue.
  • Function to input data and some tools for admin to query data from external sources.

See our attached demo screenshoots to have detail.

<u>Users and impact</u>

  • Catalyst management people who need insight data, project performance, KPIs.
  • Proposers they need to know the trend of Cardano applications.
  • Cardano developers they need to know which skills, knowledges are best to learn.
  • ADA holders, community people they need information about the potential of adopting Cardano applications to invest and support.

<u>Our present with latest update:</u>

https://docs.google.com/presentation/d/1k9NDVkyPNeSqBvvSfmV8zLqC01h18GhUjBps55PngS4/edit#slide=id.g11de99c79ca_0_1148

Whether you are Catalyst management, CAs, Proposers, community people or ADA holder cReport project is always a valuable product to you.

<u>cReport is formed by collaborating of seasoned software engineers and Catalyst CAs experts.</u>

We aim to audit all funded proposals around all funds F1 to F7, across all challenges and go on to next funds.

cReport main function is to provide KPIs of funded proposal, summarized fund allocation and proposal’s project statistic. Maximum automatic data collecting from available sources like Cardano Network, ideaScale, github… as much as possible. This help Cardano and outside users, groups to have insights about Catalyst project performance, trend:

  • The rate of full fund transferred, pending fund for each proposal and total.
  • The rate of proposals have released products and how good product is.
  • The number of transaction through dAPp and smart contract address.
  • The number of git commits and number of attended developers.

By offering users from various domains actionable, valuable reports and KPIs that cover most mattered aspects of Catalyst project cReport highly align with given challenge KPIs and beyond shown at our attached demo screenshots.

<u>Below challenges, risks that may block to deliver this project successfully:</u>

  • The availabilities of data from catalyst that support auto fetching scripts.
  • Unstructured and hard copy data are difficult to parse before to standard schemas.
  • The limit of fund to extend product beyond the basic outlines.
  • The difficulties of adopting a new applications to different user groups.

Solution to solve these risks: we need combine both manual input and script base auto fetching to get raw init data and communicate out the values of projects ask help from other resources.

[FEASIBILITY]

Q2-2022

<u>Project planning and POC</u>

  • Project outline, task breakdown and member assignment.
  • Setup development environment: gitHub, staging server.
  • Define detail system architecture and select technologies.
  • Develop POC to verify main logics and concepts.
  • Expect project to be funded and start development.

Q3-2022

<u>Develop main project components:</u>

  • Raw data collector and data parser
  • Database schema and data aggregation scripts.
  • Backend REST API and server logics.
  • UI/UX, frontend application for cReport admin, external users.

Functional and integration test for each of component and rebuild if need.

<u>Integrate full application with sample data and verify the working of application to meet designs and product KPIs:</u>

  • Raw data collector and data parser - parsed data must meet given expectations.
  • Database schema and data aggregation scripts: inserted data and the output of aggregation scripts must match design.
  • Backend REST API and server logics: API return exact data and perform expected logics.
  • UI/UX, frontend application: perform right user functions, generate reports, KPIs as designed.

Fix found bugs and refactor code to make sure everything is good to go:

  • Application architecture has clearly design and working well
  • Code is easy to maintain and extend
  • All functions are working properly as expectation KPIs

Deploy first version on AWS and make sure it ready to go.

Q4-2022

<u>Pilot and delivery application</u>

  • Select 10 experienced CAs who well understand Catalyst project as pilot user to have feedback, the feedback should contain:
  • CA is able to init data for a fund include: proposers, approved fund, wallet address … etc
  • The reports and KPIs meet their expectations and beyond: how many funded proposals got product went live, how many proposals are stopped, which is best potential products that resulted from Catalyst.
  • Once we have good feedbacks from pilot users that is time to go live that public product to massive user, everyone can have insight, value reports from cReport, they can also use tool for example view good proposal, meet good team and beyond.

We expect cReport become a central place to store processed Catalyst data provide valuable, actionable reports, KPIs, assessments that direct user to right action. This is cReport team only mission.

The requested cost is used to pay some type of work: the development cost use to pay for 04 engineers work in around 6 months. The infrastructure cost use to pay to Amazon AWS for server we use in development period & beta release the cost of extracting data from funded proposals for initiation is counted per extracted proposal.

<u>The project includes following works & costs:</u>

<u>Raw data collector sripts</u>

  • GitHub & youtube: 800$
  • Cardano smart contract & address: 1.500$
  • IdeaScale: 700$

<u>Summarized</u>: 3.000$

equivalent to 100 hours * 30$/hour for 02 engineers work in 01 month

<u>Database implementations</u>

  • Schema modeling: 1.500$
  • Aggregation scripts: 1.500$

<u>Summarized</u>: 3.000$

equivalent to 100 hours at 30$/hour for 02 engineers work in 03 months

<u>Backend REST API and server logics</u>

  • Common API & libraries: 3.000$
  • cReport APIs: 3.500$
  • Backend logics: 2.500$

*<u>Summarized</u> :*9.000$

equivalent to 300 hours at 30$/hour for 02 engineers work in 06 months

<u>UI/UX, frontend application for cReport admin, external user</u>

  • Dashboard: 1000$
  • Fund & challenges reports: 2.000$
  • Individual funded proposal KPIs: 1.500$
  • Admin input & tools: 2.000$

<u>Summarized</u>: 6.500$

equivalent to 300 hours at 30$/hour for 02 engineers work in 06 months

<u>AWS infrastructure:</u> 1.920$

(02 T2 small server at 80$/month * 12 months)

This cost will use to pay Amazon AWS for server using for development

<u>Proposal hard copy extraction to have initial data:</u> 5.000$

(expect to extract 500 proposals at 10$ / 01 proposal at funding time)

Total cost of project to request: 28.420$ - twenty eight thousand four hundred twenty dollars.

Thang Tran

<u>Software expert, practical blockchain engineer, blockchain enthusiasm, fan of Cardano technologies.</u>

Experiences: Capable to design & develop software at all level. 10 years of experience with high volume, high availability critical mission system. More than 4 years as a blockchain engineer. Experienced with Cardano general technologies, Plutus, Marlowe, smart contract, tokens.

Project responsibilities: Product design and development. Engineering management. Main full stack & blockchain engineer.

Contact:

Telegram: <https://t.me/ThangTranNam>

Github: <https://github.com/saigonbitmaster>

Duc Tiger

<u>ADA lover, running one of largest Cardano community group in Vietnam, CA leader.</u>

Experiences: Business owner, digital marketing, community management, data analysis. Experienced with Cardano economic model. Full time working and well understand Catalyst.

Project responsibilities: Marketing management, finance management, community influencer.

Contact:

  • Telegram: <https://t.me/DucTIGERpool>
  • Linkedin: <https://www.linkedin.com/in/DucTIGER>

Trong Nguyen

<u>Software, cloud & mobile development engineer, Cardano fan, stake pool owner. </u>

Experience: a software engineer and IT specialist who worked for many big IT tech firms in Japan such as GNT, ISFNet, and IBM. Experienced in software product management, digital content with 10 years of mobile app development for Android and IOS. Experienced with Cardano technologies. CA and well understand Catalyst project.

Responsibilities: Product management, Digital content, Project Management, Software engineer.

Contact:

Toan Nguyen

<u>Senior full stack & blockchain engineer</u>

Experience: 8 years of experience with software and blockchain development, capable to build and run high volume products.

Responsibilities: Backend & APIs leader - APIs, blockchain, frontend, mobile development

Contact:

  • Linked: <https://www.linkedin.com/in/tritoan>
  • GitHub: <https://github.com/anytool>

Thanh Nguyen

<u>Senior full stack engineer</u>

Experience: more than 8 years of experience with software development backend, frontend and mobile apps.

Responsibilities: Frontend and mobile apps leader - Frontend, mobile development

Contact:

  • Linked: <https://www.linkedin.com/in/congthanh-nguyen-b152361a0>
  • GitHub: <https://github.com/makotovnjp>

Oanh Ngo

Experience: more than 8 years experience of QA/QC leader.

Responsibilities: QA/QC leader.

Contact:

  • Linked: <https://www.linkedin.com/in/oanh-ngo-06b331100>

And other resources from AdaBoys Lab: https://github.com/adaboys

[AUDITABILITY]

<u>Clear and trackable development progress</u>

  • Task breakdown and manage by Redmine which integrated with project github repo.
  • Daily and weekly report from QA/QC team to let every member aware with process.
  • Staging server are always with latest product development and available to everyone to check.

<u>The quantitive indicators to track progress</u>

  • Github commits, merges.
  • Unit, benchmark test "passed".
  • Done task.

<u>The development success consideration </u>

  • 100% main tasks are "done"
  • 100% unit test for main task is "passed"

Please see detail at breakdown tasks success KPIs or our present at attacked link.

<u>The project is success when it meets:</u>

  • Main software components are developed and tested: 100%
  • Extra software components are developed and tested: 70%-100%
  • System operations KPIs: 70%-100%
  • Product is published and available to users: 100%
  • Extra factors of product delivery: 70%-100%
  • Audited funded proposals: **70%-100% (**estimated audit 500 funded proposals in first 06 months)
  • Users access to use reports, data: 20k visits/day (this is free web application, no submission)
  • Rate of users satisfied with reports, KPIs, assessments from cReport: 70%
  • Rate of users prefer cReport to make investment decisions versus other data sources: 70%

List of success KPIs that have to achieve in order to make project success:

<u>Main components development success KPIs</u>

  • The accomplishment of function and component development: functions, components, scripts are developed and tested in term of quantity and functionality: <u>100%</u> they are developed and tested.
  • The accomplishment of full product development: all components are integrated and full application is developed and tested met designs: <u>100%</u>.
  • Code quality and visibility: source code is clear, easy to re-use and maintain: 1***<u>00%</u>*.** full source code is public at registered Github link that available for other people to view, improve or re-use: <u>100%</u>

<u>Extra components development success KPIs</u>

The accomplishment of extra function and components development: functions, components, scripts are developed and tested in term of quantity and functionality: 8<u>0%</u> they are developed and tested.

<u>Product delivery success KPIs</u>

  • Product is published and available to everyone through the internet: <u>100%</u>
  • Product is free and everyone is able to use its full functions for their works: <u>100%</u>

<u>Extra factors of product delivery success KPIs</u>

  • We expect to have around 60% of catalyst users, 40% of other Cardano users and around 100k external users will be cReport users: <u>80%-100%</u>
  • Rate of user satisfied with reports, information from products: <u>70%</u>

<u>System operation KPIs</u>

  • System uptime: 99.9%
  • Latency to basic access: 20-100ms depend on your internet connection: 100%
  • Latency to generate computed reports: 40-300 ms for generating a basic report. 01-05 minutes for generating long report for example print all funded proposal at fund7: 100%

<u>References</u>

Success criteria: success KPI >=70%.

KPI >=70% means a task is done (function is developed & tested or works meet expectations), the rest 30% used for outstanding assessments for factors that surpass success criteria.

e.g a develop an API task has KPI 80% means it is DONE and code runs faster than expected.

The meaning of numbers in % indicate the percentage of completion of task use in success KPIs:

  • 0%-70%: the task is not completed, it is 'on-working'.
  • 70%-80%: task is completed & tested or work is done, good to go.
  • 80%-100%: task is completed and has excellent output e.g response time faster than expected.

This proposal is a part of our focused efforts to adopt Cardano technologies into true life.

The first proposal that we have been funded in the Fund-7 is cPAY - TrustOrder Anti SpamOrder.

In this fund-8, we are submitting some more proposals that utilize the power of blockchain and smart contract to solve some existing toughest problems & create new values across some domains:

Your vote for us is a hand to help solving problems for human life, creating more value for the better world.

Let's "VOTE" for us.

Thank you!

SDG Rating

Not at all

Community Reviews (1)

Comments

Monthly Reports

We are starting work on this project as desired in proposal. Project planning and POC:

  • Project outline, task breakdown and member assignment.
  • Setup development environment: gitHub, staging server.
  • Define detail system architecture and select technologies.
  • Develop POC to verify main logics and concepts.
  • Expect project to be funded and start development.
Disbursed to Date
$28,420
Status
Still in progress
Completion Target
12/31/2022
Comments 0

Login or Register to leave a comment!

Please see more detail update with below links github code and commits: https://github.com/saigonbitmaster/cReportPublic

staging servers (user/pass: master/123456): http://creport.bworks.app:4001/web/#

screenshoots: https://drive.google.com/drive/u/1/folders/1HpfzH5NVzcyN6t891UFWngTxEBdmQljq

Disbursed to Date
$28,420
Status
Still in progress
Completion Target
9/24/2022
Comments 0

Login or Register to leave a comment!

Git link: https://github.com/saigonbitmaster/cReportPublic Staging servers: http://creport.bworks.app:4001/web/# ScreenShoot: https://drive.google.com/drive/folders/1r1dxEzM9VovhjdORPLoVkSEFLdiv1QL9

In july we have DONE: Develop common library and utils

  • REST fetch liblary for web & mobile client: - Perform various REST query types: getList, getOne, Post, custom get, custom post - Format data: text, html, date, number … to let data is able to load to UI components.
  • Backend library to use for NONE CRUD query (search, customized app logics): Perform server logic then return to client:
    • Accept the client query via REST with data and query params.
    • Connect mongo Database and other data sources like file, amazon s3, other REST or SOAP data sources
    • Perform server backend logics.
    • Format data before return to client to let it has uniformed data." Done

Git branch: https://github.com/saigonbitmaster/cReportPublic/tree/libs

Git commits: 2d523f7e011183f5a1348d13cb133deae51e7e9e 041f704d66f906efe623371919fbd3cb536dcf77"

Develop UI/UX applications for cReport Admin (admin authentication)"

  • Design UI/UX:
    • App layout
    • Screen details
  • Input funded proposals function:
  • Add
  • Edit
  • Delete
  • Search" Done "

Git branch: https://github.com/saigonbitmaster/cReportPublic/commits/frontEnd

Git commits: https://github.com/saigonbitmaster/cReportPublic/commit/8524926b1478173400cdce26370a0cce0ec2547a https://github.com/saigonbitmaster/cReportPublic/commit/f8dd8138bd6b72fe2ef1e8e0d3ec6c5246292fc6"

Develop UI/UX applications for cReport external users (none authentication) "- Design UI/UX:

Git commits: https://github.com/saigonbitmaster/cReportPublic/commit/f8dd8138bd6b72fe2ef1e8e0d3ec6c5246292fc6" Database schema and data aggregation scripts. "- Funded proposal model

Git commits: https://github.com/saigonbitmaster/cReportPublic/commit/2ea39dc841e53f5cd005e1749f6475836618d522" Backend REST API and server logics. "CRUD REST APIs:

Git commits: https://github.com/saigonbitmaster/cReportPublic/commit/2ea39dc841e53f5cd005e1749f6475836618d522"

Disbursed to Date
$28,420
Status
Still in progress
Completion Target
3. In the next 6 months
Comments 0

Login or Register to leave a comment!

We have done: -Backend REST API and server logics. -Develop UI/UX applications for cReport external users (none authentication)

Disbursed to Date
$28,420
Status
Still in progress
Completion Target
4. After 6 months
Comments 0

Login or Register to leave a comment!

Develop a backend script to analyze and audit the GitHub code of a funded proposal. Develop a frontend to show GitHub commits, and activities of a funded proposal. Develop scripts to fetch Cardano to verify fund transfers to the proposer's wallet. Develop a frontend UI to audit fund percentage delivered.

Disbursed to Date
$28,420
Status
Still in progress
Completion Target
3. In the next 6 months
Comments 0

Login or Register to leave a comment!

CMS application: Functions: - Develop proposal KPIs function to report funded proposals KPIs to show if the projects are really working. - Auto rate the project activity through git repo auto scan.

Frontend: - Develop proposal KPIs UI and web components to rank a funded projects. - Develop seamless UI feature to let user easy to have more information within a single screen by click.

Backend: - Develop API and logic to return KPIs data for a proposal. - Develop aggregation script to extract data from database and rank a proposal.

Output: - user use CMS web application is able to view proposal information and its current activities include git commits, last month commits .. - user can quick overview a proposal through its staring quick rank in the web.

Public web application: - Init public web application to let anyone can use the reports and other catalyst data e.g fund, challenges, proposals without authentication. - design functions for public web which decide what data and tools public users can use.

Common project tasks: Common project tasks are system implements tasks to help better product quality code management: - Migrate Api from strong loop to nestJs to earn advantage of micro-service architecture. This to earn the abilities to deploy micro-service based at backend to run separated background jobs e.g git scan, cardano network scan …
- Migrate frontend app to react 17 to separate from whole app state to single UI state management to use hook based at frontend project CMS, JSK, EMP. - Switched project to strict typed typescript to achieve much better quality of the apps: stabilities and speed. - Implement responsive to all the screen across all frontend apps CMS, JSK, EMP.

List of git commits for this month: https://github.com/saigonbitmaster/creport_2.0/commit/d1fdc17548feaf17e6eedf99c91ea141001011b7 - Remove data modify functions for public web. https://github.com/saigonbitmaster/creport_2.0/commit/c6eae51f21aa72147682996e1a7b8f1c8b3fe56b - init public web project for public users. https://github.com/saigonbitmaster/creport_2.0/commit/3486abc68ab8798cfd2d2dbade8b59d681e58b05 - UI & api for proposal git repo scan & show. https://github.com/saigonbitmaster/creport_2.0/commit/2cbfb87885cecf6164e104dd627e2cf85f6d479c - Frontend UIs to show funded proposal KPIs https://github.com/saigonbitmaster/creport_2.0/commit/dcd2f039927a1553522eb873198d8d688e212ff4 - Aggregation scrips and APIs to show funded proposal KPIs

Please see more details at: Our git repo: https://github.com/saigonbitmaster/creport_2.0/commits/master Our screenshoots folder: https://drive.google.com/drive/folders/1dkjPMf1-j2fBU5VTguLzkp6-wPrBR8uF

Disbursed to Date
$28,420
Status
Still in progress
Completion Target
2. In the next 3 months
Comments 0

Login or Register to leave a comment!

cReport

Functions: Develop functions to fetch data from external source and import to db. This to let cReport data to be continuous updated and let external users have abilities to update data and admin to validate data before import.

Frontend: - Develop UIs to let admin perform import fund, challenges and proposals data through public google sheets.

Backend: - Develop APIs and logics to authenticate and fetch data from public googleSheets, validate data and import.

Output:

  • Admin is able to import data from googleSheet through cReport CMS UI.
  • Admin and external proposers are able to import/update data through public googleSheets then this data will be use to import to cReport db.

List of git commits for this month: https://github.com/saigonbitmaster/creport_2.0/commit/b2c8c3678dce0514b88db81f3821d3de0521ab03 - import googleSheet UI https://github.com/saigonbitmaster/creport_2.0/commit/caca664f56f493087e40e58cfa6970359a94a5b9 - fetch data from googleSheet logics https://github.com/saigonbitmaster/creport_2.0/commit/a0d0d626b0cf6621ec567344d5e04be6f8831b41 - validate and import/update funds, challenges, proposal data from googleSheets. https://github.com/saigonbitmaster/creport_2.0/commit/c99eba1c5e4355eae5a091b93a6d75845d294569 - validate data types.

Please see more details at: Our git repo: https://github.com/saigonbitmaster/creport_2.0/commits/master Our screenshoot folder: https://drive.google.com/drive/folders/1Nrlr6-KRUB8y2VBI5gGqTipvNu8OWFiq

Disbursed to Date
$28,420
Status
Still in progress
Completion Target
2. In the next 3 months
Comments 0

Login or Register to leave a comment!

Functions: Develop functions to show analyzed data funds, proposals on dashboards: - fund summary - proposal list: complete, pending - fund allocation, project status charts

Frontend: - Develop dashboard to let admin/user overview the summarized data over funds, projects.

Backend: - Develop APIs to perform logics for dashboard functions.

Data: - Extract and import data: - funds: all 09 funds. - challenges: all challenges. - proposers: all proposers. - proposals: from fund 2 to fund 5.

Output:

  • Admin and users are able to use dashboard to overview the funds, projects data through chart and sum data widgets.
    • funds, challenges, proposers, proposal from f2-f5 are import and work for applications.

List of git commits for this month: https://github.com/saigonbitmaster/creport_2.0/commit/250df6d0eb50debf275f593d68ea68f106c40315 - funds, project charts https://github.com/saigonbitmaster/creport_2.0/commit/19135d1edb416967539b4a6bc289f9d1d25849d6 - fund allocation dashboard https://github.com/saigonbitmaster/creport_2.0/commit/9320d32732e4a0fbf09aec9b98d8f76a2d0befe5- fund analyze

Please see more details at: Our git repo: https://github.com/saigonbitmaster/creport_2.0/commits/master Our screenshoot folder: https://drive.google.com/drive/u/1/folders/1Q4zEmg4UG0MR0QPGNQYj250Z0wLX9aCt

Disbursed to Date
$28,420
Status
Still in progress
Completion Target
2. In the next 3 months
Comments 0

Login or Register to leave a comment!

close

Playlist

  • EP2: epoch_length

    Authored by: Darlington Kofa

    3m 24s
    Darlington Kofa
  • EP1: 'd' parameter

    Authored by: Darlington Kofa

    4m 3s
    Darlington Kofa
  • EP3: key_deposit

    Authored by: Darlington Kofa

    3m 48s
    Darlington Kofa
  • EP4: epoch_no

    Authored by: Darlington Kofa

    2m 16s
    Darlington Kofa
  • EP5: max_block_size

    Authored by: Darlington Kofa

    3m 14s
    Darlington Kofa
  • EP6: pool_deposit

    Authored by: Darlington Kofa

    3m 19s
    Darlington Kofa
  • EP7: max_tx_size

    Authored by: Darlington Kofa

    4m 59s
    Darlington Kofa
0:00
/
~0:00