Koios Rust Client Library

[GENERAL] Name and surname of main applicant

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

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

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

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

Developing a user-friendly Rust Client Library for the Koios API, providing Rust developers with efficient library to utilize Koios, query data on Cardano to consume within their applications.

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

[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?

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

The project will be fully open-source, available on GitHub under the MIT license, free to use, and open to contributions from developers through pull requests and issues.

[SOLUTION] Please describe your proposed solution

I am developing a Rust Client Library for the Koios API to address the critical need for more accessible and efficient data integration within the Cardano ecosystem for Rust developers. This library aims to reduce the extensive time and effort developers currently face in manual API integration, thereby improving their development experience.

This Rust library will serve as a comprehensive library, encapsulating the Koios API functionalities into a Rust package. Developers will be able to add this library to their projects using Cargo. The library will facilitate easy interaction with the Koios API by providing high-level functions that abstract away the details of HTTP requests and JSON parsing. Users will simply need to instantiate the client and call methods corresponding to specific API endpoints to fetch or interact with Cardano data. This approach will shield developers from frequent API changes and the intricacies of handling raw API requests.

By abstracting the complexities associated with direct API calls, this Rust library will make Cardano's on-chain data accessible to a wider audience of developers with Koios, including those new to Cardano development. Thus, accelerating the development of data-driven dApps on Cardano.

Koios client libraries are available in eight languages across nine implementations, but Rust is notably missing. Given Rust's popularity and critical role in blockchain ecosystems, introducing a Rust implementation addresses a significant gap. This addition will attract Rust developers and expand the variety of applications built on the Cardano ecosystem using Koios, thereby promoting its growth.

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

The Rust client library for the Koios API will improve the Cardano ecosystem by making it easier for developers to query Cardano data though abstracted complexities of manuel interaction with Koios API. This attracts more Rust developers, thus increased developer activity will lead to a wider range of robust dapps, growing the ecosystem.

I will measure the library's success by tracking its downloads and GitHub stars, supplemented by direct feedback from developers through dev channels in Discord and forum. This will help us assess its usability and impact on development efficiency.

The library will be freely available on GitHub for easy access and community collaboration. I will provide clear documentation and usage examples to assist developers in using the library effectively, and I will engage with the Cardano community through forums, Discord and issues in Github to ensure the library meets ongoing developer needs.

[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?

I have a proven track record of successfully completing projects while maintaining high levels of trust and accountability. I have extensive experience in developing Rust SDKs and APIs, with a strong understanding of Cardano ecosystem. Previously developed Python SDK library for Arbitrum, demonstrating my ability to deliver high-quality, user-friendly libraries.

I have experience working with well-known protocols such as Solana, Arbitrum, Filecoin etc. showcasing my ability to handle multiple ecosystems and expertise. I have developed more than 15+ grantee projects for 10+ protocols so far which are well received by the communities and developers. All of these projects are open-source and available on GitHub.

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

Library Setup and Basic Functionality

Milestone Outputs

• Setup of the Rust project and configuration of the development environment.
• Implementation of fundamental functionalities within the library to connect to the Koios API and handle HTTP requests and JSON parsing. This includes core API services such as Network and Block.
• Basic authentication mechanisms for accessing protected endpoints.

Acceptance Criteria

• Successful setup of the Rust library structure.
• Ability to connect to the Koios API and fetch data for Network and Block endpoints.
• Code is reviewed and committed to the GitHub repository.

Evidence of Milestone Completion

• GitHub commits showing the setup and merged pr of Network and Block functionalities.
• Test results demonstrating successful API calls.

Expanded Functionality and Testing

Milestone Outputs

• Development of additional API functionalities: Transactions, Stake Account, Address, and Asset endpoints.
• Implementation of comprehensive error handling and unit tests to ensure the robustness of the library.

Acceptance Criteria

• Library successfully handles API calls across the newly added functionalities without errors.
• Unit tests are developed for new functionalities with at least 80% coverage.

Evidence of Milestone Completion

• GitHub commits showing the developed code for expanded functionalities.
• Unit test results verifying the functionality and reliability.

Completion, Documentation, and Release

Milestone Outputs

• Integration of the remaining functionalities such as Pool, Script, and advanced queries.
• Development of detailed documentation and usage examples for using the library.
• Final testing to ensure compatibility and performance across all supported features.

Acceptance Criteria

• Complete functionality of the library with all planned endpoints integrated.
• Comprehensive documentation that allows developers to easily understand implementation and utilization of the library.
• All modules and features pass final integration.

Evidence of Milestone Completion

• GitHub commits showing the developed code for final functionalities.
• Completed documentation accessible via GitHub readme and GitHub Pages.
• Test scripts and final testing results showing successful queries across all functionalities.

Project Close-out and Public Release

Milestone Outputs

• Packaging and releasing the library on crates.io for easy installation and broad accessibility.
• Creating a close-out report and a demonstration video showcasing the library's features and usage.

Acceptance Criteria

• Documentation and tutorials are comprehensive, clearly written, and easily accessible to developers.
• The close-out report and demonstration video effectively shows the library's capability and how to implement it in projects.

Evidence of Milestone Completion

• Links to the close-out report and the hosted demonstration video.
• Release of the library on crates.io, ensuring easy installation and broad accessibility for the Rust developer community.

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

Mert Köklü

I worked as Intelligent Video Analytics Team Leader in a NVIDIA distributer company that develops video analytics solutions for 2 years. After diving into Web3 ecosystem, I have become a grantee for multiple blockchain ecosystems by developing innovative projects. As a certified NVIDIA instructor, and ambassador for organizations such as Microsoft and The Graph protocol, I have become a trusted voice within the communities.

Here are some of my previous projects:

• Arbitrum Python SDK: https://github.com/justmert/arbitrum-python-sdk
• Ape Python plugin: https://github.com/justmert/ape-cairo

Links to my profiles

LinkedIn: https://www.linkedin.com/in/mertkoklu/

GitHub: https://github.com/justmert

Discord: mertkkl

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

Total Dev Months - 4 Months

The funding will be used to cover the costs of development and maintenance of the Rust Client Library for the Koios API. The breakdown of costs is as follows:

4 months x 14,500 ADA = 58,000 ADA

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

The cost of developing the Rust Client Library for the Koios API offers significant value for the Cardano ecosystem. This project simplifies querying data on Cardano for Rust developers, making it easier to build applications on Cardano. This contribution will increase the growth among Rust developers within the ecosystem by making development with Koios more accessible and efficient.

The allocation of funds ensures that each phase of the project from initial development to maintenance. The investment into the libraries directly translates into enhanced productivity for developers, leading to a broader range of applications and use-cases being developed on Cardano, thus offering excellent value for money.