Cardanobi.io (Streaming API)

[GENERAL] Name and surname of main applicant

Thomas Langlois

[GENERAL] Email address of main applicant

thomas.langlois@mac.com

Additional applicants

None

[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] 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.” .

No dependencies.

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

Yes

[GENERAL] If NO, please describe which outputs are not going to be open source. If YES, please write “Project will be fully open source.”

Project will be fully open source.

[METADATA] Category of Proposal

Dev Tools, API or Library

[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

[IMPACT] 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] How does your proposed solution address the challenge and what benefits will this bring to the Cardano ecosystem?

Our proposed solution addresses the challenge of real-time data access and standardized subscription to business events on the Cardano blockchain.

By providing a Fully Open-Source Business Intelligence Streaming API layer, developers will have an efficient and reliable way to access real-time data related to Cardano data entities.

This solution enhances the existing CardanoBI REST API, enabling developers to create new event-driven services and derive valuable insights from on-chain data.

The benefits of this solution to the Cardano ecosystem are significant. Firstly, it simplifies the process of accessing and utilizing real-time data, attracting developers and businesses to leverage Cardano's capabilities. This increased interest and participation in the ecosystem contribute to its growth and vitality.

Moreover, the standardized and streamlined data access through the proposed Streaming API enables the creation of value-added services and analytics.

This opens up opportunities for businesses to derive insights and build innovative applications on top of Cardano's blockchain. By commoditizing real-time data access and enhancing the business value locked in Cardano's on-chain data, the proposed solution strengthens the overall ecosystem and supports its expansion.

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.

[IMPACT] How do you intend to measure the success of your project?

To measure the success of the project and evaluate its benefits for the Cardano ecosystem, several metrics and indicators will be considered:

1. Developer Adoption: The number of developers who integrate the CardanoBI Streaming API into their applications can serve as a measure of adoption. Tracking the growth in the developer community and the rate of new applications built on Cardano can provide insights into the project's success.
2. Usage and Transaction Volume: Monitoring the usage and transaction volume through the API can indicate the level of engagement and activity within the ecosystem. An increase in the number of transactions and the volume of data accessed through the Streaming API can demonstrate the value it brings to developers and businesses.
3. Feedback and User Opinions: Gathering qualitative feedback from developers and users regarding their experience with the Streaming API can provide valuable insights. Conducting surveys, collecting testimonials, and monitoring community discussions can help gauge user satisfaction and identify areas for improvement.
4. New Services and Applications: Tracking the number and diversity of new event-driven services and applications built on Cardano using the Streaming API can illustrate the project's impact on ecosystem growth. This metric demonstrates the innovation and value that developers derive from the real-time data access and analytics capabilities provided.
5. Ecosystem Expansion: Monitoring the growth of the Cardano ecosystem as a whole, including factors such as the number of active addresses, the total value locked, and the participation of new stakeholders, can indicate the long-term impact of the project. A thriving and expanding ecosystem signifies increased productivity and adoption.

[IMPACT] Please describe your plans to share the outputs and results of your project?

Once delivered the Streaming API will be visible in these locations:

• CardanoBI API Reference Documentation (https://docs.cardanobi.io/):
• The Streaming API endpoints will be documented within their respective domains, enabling developers to discover them and learn how to use them.
• Dedicated tutorials will be offered as part of the CardanoBI tutorial collection to guide developers on how to use the Streaming endoints.
• CardanoBI Github (https://github.com/cardanobi):
• The corresponding repositories will be accessible through our github and fully-open source (Apache-2.0 license)
• CardanoBI SaaS portal (https://cardanobi.io/) will offer a commoditized access to the Streaming API.

[CAPABILITY/ FEASIBILITY] What is your capability to deliver your project with high levels of trust and accountability?

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.

[CAPABILITY/ FEASIBILITY] What are the main goals for the project and how will you validate if your approach is feasible?

The main goals for the project are as follows:

1.Develop and deploy a fully functional Business Intelligence Streaming API layer for Cardano, providing standardized real-time data access and pub/sub capabilities to developers.

Validation:

• Implementation and successful deployment of the Streaming API layer on Cardano's network (mainnet, preprod, preview).
• Testing the API's functionality, performance, and reliability under various load scenarios.
• Conducting developer feedback sessions to assess usability and effectiveness.
• Monitoring adoption and usage metrics, such as the number of active API subscribers and the volume of real-time data accessed.

2.Support the growth of the Cardano ecosystem as a whole by providing a reliable and scalable Fully Open-Source infrastructure for real-time data analytics.

Validation:

• Tracking the adoption of the API by third-party developers and organizations.
• Gathering user feedback on how the API has contributed to their ability to create innovative applications and services on Cardano.

Regarding implementation, the project will follow a software development process that includes requirements gathering, architectural design, development, testing, and deployment.

Agile methodologies may be employed to ensure iterative development, feedback incorporation, and continuous improvement throughout the project's lifecycle.

[CAPABILITY/ FEASIBILITY] Please provide a detailed breakdown of your project’s milestones and each of the main tasks or activities to reach the milestone plus the expected timeline for the delivery.

Milestone Breakdown for the Project:

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 SDK:

• Build an SDK to facilitate the integration of the Streaming API into various programming languages and framework (Nodejs/javascript)
• 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/).

[CAPABILITY/ FEASIBILITY] Please describe the deliverables, outputs and intended outcomes of each milestone.

Here are the expected deliverables for each of our 5 milestones:

1. Streaming API Definition
2. High Level Design Document (HLDD) that includes the list of entities (Core, BI) that will be covered by the Streaming API
3. Avro schemas
4. High Level Architecture Document (HLAD) that defines the subscription and event delivery mechanisms for real-time data access.
5. Streaming API Infrastructure
6. High Level Architecture Document (HLAD) that defines the overall solution architecture for the Streaming API Infrastructure.
7. Evaluate and Set Up Debezium.
8. Implement components for data ingestion, event processing and streaming to clients.
9. Define mapping between data sources and corresponding topics in the streaming platform.
10. Streaming API Backend Implementation
11. High Level Architecture Document (HLAD) that defines the overall solution architecture for the Streaming API Backend.
12. Implement Event Consumers and Processors.
13. Integrate authentication and authorization into the Streaming API backend with CardanoBI Identity Server.
14. Implement subscription and real-time message delivery.
15. Streaming API SDK
16. Implement Nodejs/javascript SDK using websockets to allow clients to subscribe to topics of their choice.
17. Streaming API Documentation
18. Integrate Streaming API endpoints to the CardanoBI API Reference Documentation.
19. Build tutorials to help new developers to leverage both our SaaS Streaming API but also the Fully Open-Source packages.

[RESOURCES & VALUE FOR MONEY] Please provide a detailed budget 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 @ $50/h for 40h (1 week)

1x Data Engineer @ $30/h for 80h (2 weeks)

2.Streaming API Infrastructure

1x Solution Architect @ $50/h for 40h (1 week)

1x Backend Developer @ $30/h for 160h (4 weeks)

3.Streaming API Backend Implementation

1x Solution Architect @ $50/h for 40h (1 week)

1x Backend Developer @ $30/h for 240h (6 weeks)

4.Streaming API SDK

1x Backend Developer @ $30/h for 200h (5 weeks)

5.Streaming API Documentation

1x Backend Developer @ $30/h for 80h (2 weeks)

The total ask in USD is $28,800

With ADA @ 0.29 USD the total ask in ADA is: ₳99,310

Actual execution time is estimated to 9 months because the team works FIAT jobs too!

[RESOURCES & 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 agreed to Fund10 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