Streaming API for CardanoBI

[GENERAL] Name and surname of main applicant

Thomas Langlois

[GENERAL] Are you delivering this project as an individual or as an entity (whether formally incorporated or not)

Entity (Not Incorporated)

[GENERAL] Requested funds in ada

84000

[GENERAL] Please specify how many months you expect your project to last (from 2-12 months)

9

[GENERAL] Please indicate if your proposal has been auto-translated into English from another language.

No

[GENERAL] Summarize your solution to the problem (200-character limit including spaces)

Build a Fully Open-Source Streaming API Layer for Cardano.

[GENERAL] Does your project have any dependencies on other organizations, technical or otherwise?

No

[GENERAL] If YES, please describe what the dependency is and why you believe it is essential for your project’s delivery. If NO, please write “No dependencies.”

NA

[GENERAL] Will your project’s output/s be fully open source?

Yes

[GENERAL] Please provide here more information on the open source status of your project outputs

The entire source code of this project will be open-sourced under Apache License 2.0.

[METADATA] SDG rating

SDG goals:

Build resilient infrastructure, promote inclusive and sustainable industrialization and foster innovation

SDG subgoals:

Develop quality, reliable, sustainable and resilient infrastructure, including regional and transborder infrastructure, to support economic development and human well-being, with a focus on affordable and equitable access for all

Key Performance Indicator (KPI):

Proportion of the rural population who live within 2 km of an all-season road

Universal Human Rights Index (UHRI):

#proposertoolsdg

[SOLUTION] Please describe your proposed solution.

We propose to build the following capabilities:

• Fully Open-Source Business Intelligence Streaming API Layer:
• Purpose: Provide developers with a standardized way to subscribe and receive real-time business events related to various entities on the Cardano blockchain (such as accounts, addresses, transactions, pools, assets, epochs, scripts, votes, etc.).
• Integration: The proposed API will build upon the existing CardanoBI REST API, enhancing it with real-time streaming capabilities.
• Benefits: This approach allows developers to access and utilize, in real-time, data from Cardano's on-chain data in an efficient and standardized manner.
• Software as a Service (SaaS) Business Intelligence API:
• Purpose: By commoditizing real-time data access to Cardano's on-chain data and offering value-added data analytics and insights, this API aims to streamline access to business data and enable the creation of new event-driven services.
• Benefits: By enabling Streaming/Event-Driven data access to Cardano's on-chain data, we foster the growth of the entire Cardano ecosystem and accelerate the time to market of new projects requiring real-time events/workflows as part of their business processes.

[IMPACT] Please define the positive impact your project will have on the wider Cardano community.

While it is challenging to provide precise quantitative projections, the impact of the project can be measured in terms of increased developer adoption, usage of the API, and the number of new event-driven services built on Cardano.

The successful implementation of the proposed solution is expected to attract a significant number of developers to the community, stimulate higher transaction volumes, and foster a thriving ecosystem of applications and services that leverage Cardano's real-time data.

[CAPABILITY & FEASIBILITY] What is your capability to deliver your project with high levels of trust and accountability? How do you intend to validate if your approach is feasible?

We've successfully built and launched CardanoBI, the first Fully Open-Source Business Intelligence API for Cardano.

The proposed solution will be built by the same team.

We have 23+ years' experience in software development for the financial industry and will be as transparent in our project reporting as we have been for the initial CardanoBI project.

[Project Milestones] What are the key milestones you need to achieve in order to complete your project successfully?

1.Streaming API Definition:

• Define the core data entities and derived analytics entities that will be supported by the Streaming API.
• Design Avro schemas to provide a standardized structure for data serialization and deserialization.
• Specify the subscription and event notification mechanisms for real-time data access.

2.Streaming API Infrastructure:

• Set up the necessary infrastructure to support the Streaming API.
• Determine the required server and network resources to handle real-time data streaming.
• Select and configure the appropriate streaming technology stack (e.g. Apache Kafka), to handle the high-volume data flow efficiently.

3.Streaming API Backend Implementation:

• Develop the backend components of the Streaming API.
• Implement the necessary authentication and authorization mechanisms to ensure secure access to the API.
• Integrate with existing Cardano infrastructure (e.g. cardano-db-sync, carp) to retrieve and process the relevant data for streaming.

4.Streaming API Javascript SDK:

• Build a Javascript SDK to facilitate the integration of the Streaming API with Nodejs/javascript backends.
• Provide client libraries and tools that abstract the complexity of the API and simplify its usage for developers.
• Ensure the SDK supports the Avro schemas and provides methods for subscribing to real-time data and handling events.

5.Streaming API Documentation:

• Create comprehensive documentation for the Streaming API, including detailed guides, reference documentation, and code examples.
• Document the Avro schemas and provide instructions for their usage.
• Include information on authentication, authorization, and SDK integration.

Publish the documentation onto the CardanoBI API Reference Documentation (https://docs.cardanobi.io/).

NA

[RESOURCES] Who is in the project team and what are their roles?

The same team that delivered CardanoBI REST API will deliver the Streaming API:

1.Lead, architect, backend/frontend dev: Thomas Langlois

https://www.linkedin.com/in/langloisthomas

2.Data architect, event-driven architect, backend dev: Ahmed Abouelnour

https://www.linkedin.com/in/ahmed-abouelnour-91828b8/

[BUDGET & COSTS] Please provide a cost breakdown of the proposed work and resources.

Here are the expected resources and budget for each of our 5 milestones:

1.Streaming API Definition

1x Solution Architect @ ₳75/h for 40h (1 week)

1x Data Engineer @ ₳75/h for 80h (2 weeks)

2.Streaming API Infrastructure

1x Solution Architect @ ₳75/h for 40h (1 week)

1x Backend Developer @ ₳75/h for 240h (6 weeks)

3.Streaming API Backend Implementation

1x Solution Architect @ ₳75/h for 40h (1 week)

1x Backend Developer @ ₳75/h for 320h (8 weeks)

4.Streaming API Javascript SDK

1x Backend Developer @ ₳75/h for 240h (6 weeks)

5.Streaming API Documentation

1x Backend Developer @ ₳75/h for 120h (3 weeks)

The total ask is ₳84,000

[VALUE FOR MONEY] How does the cost of the project represent value for money for the Cardano ecosystem?

The cost of the project represents value for money for the Cardano ecosystem in several ways:

1. Enhancing Development and Innovation: The investment in developing the Streaming API and its associated components facilitates the creation of innovative applications and services on Cardano. This leads to increased developer engagement and brings new ideas and solutions to the ecosystem. The resulting innovation and growth contribute to the overall value and competitiveness of the Cardano platform.
2. Streamlining Data Access: The project's cost covers the development of infrastructure and backend systems that streamline real-time data access to Cardano's on-chain data. By providing developers with a standardized and efficient API layer, it reduces the complexity and time required to integrate with Cardano. This simplification attracts more developers and businesses to the ecosystem, fostering adoption and utilization of Cardano's capabilities.
3. Supporting Ecosystem Expansion: The costs associated with the project contribute to the expansion of the Cardano ecosystem by enabling the creation of new event-driven services. These services unlock the business value stored in Cardano's on-chain data, promoting the growth of the ecosystem as a whole. This expansion attracts more users, stakeholders, and investment, creating a virtuous cycle that amplifies the overall value proposition of Cardano

Furthermore the provided hourly rates are highly competitive when you consider the level of expertise of these resources.

[IMPORTANT NOTE] The Applicant agrees to Fund Rules and also that data in the submission form and other data provided by the project team during the course of the project will be publicly available.

I Accept