Please describe your proposed solution
Understanding of the Problem
The primary challenge we are addressing is the limited availability of tools for seamless integration of .NET applications with the Cardano blockchain. This gap significantly hinders innovation and the broader adoption of blockchain technology within .NET-centric industries. According to the Stack Overflow 2023 Developer Survey, .NET enjoys a substantial popularity among developers, with over 25.29% of respondents using it across various frameworks and libraries. This high usage underscores the critical need for effective integration solutions to tap into this sizable developer base and foster enhanced blockchain functionality within their applications.
Approach and Implementation
OgmiosDotnet Client: Streamlined Integration with Cardano
Simplified Connection: The OgmiosDotnet Client is designed to streamline .NET integration with the Cardano blockchain by automating websocket communication and managing the complexities of interacting with the blockchain and repetitive mapping actions. Leveraging Ogmios, it facilitates seamless communication with Cardano nodes.
Ease of Use: This client library acts as a plug-and-play solution, enabling easy installation and integration into any .NET application with just a few lines of code. It provides direct, simplified access to Cardano blockchain data.
Advanced Features: It includes configurable options that allow developers to start interacting with the blockchain from a specified slot, incrementally read data, and access the current memory pool for unconfirmed transactions, enhancing its utility for real-time applications.
Quick Start .NET Worker Application: Practical Demonstration
Immediate Engagement: The quick start application exemplifies the practical use of the OgmiosDotnet Client, enabling developers to immediately begin working with the Cardano blockchain. It serves as a real-world application model that developers can follow.
Database Integration and Flexibility: Utilizing Entity Framework, the application demonstrates how to read and store transaction data in a Postgres database. Entity Framework supports multiple database providers like Cosmos, SQL Server, MySQL, and Oracle, allowing easy switching with minimal code adjustments.
Future-Proof Architecture: The architecture of this application is designed to be robust, adaptable and highly customizable, making it capable of evolving in line with future changes to Ogmios.
Comprehensive Documentation: Both the client and the worker application will be accompanied by detailed documentation that not only simplifies the setup and operation but also supports developers in customizing and extending the application to meet their specific needs.
This approach ensures that developers have a clear path to integrating Cardano's blockchain capabilities into their .NET projects, with robust support for future developments and a practical example to help them start immediately. The goal here is to make integration as easy as possible by abstracting away any specific Cardano complexities or repetitive development.
Delivery Structure Overview
- OgmiosDotnet.Client (Public downloadable package to facilitate Cardano blockchain access via Ogmios)
- OgmiosDotnet.Worker (Real world example of a .NET worker application that will use the OgmiosDotnet.Client to read blockchain data & save transaction data into a Postgres database)
Engagement: The project targets developers and enterprises using .NET for building applications. By providing them with the necessary tools to integrate Cardano's blockchain technology into their existing tech stack. The documentation will be optimised for searchability and discovery, ensuring that it appears prominently on GitHub when developers search for Cardano dotnet related blockchain integration tools.