Proposal for Funding the Development of the polkadot-typed-api Library

Purpose of the Proposal

We request funding for the further development of the polkadot-typed-api library, which provides a typed access to the Polkadot API. Our goal is to enhance the ecosystem by making development more convenient and safe through precise typing.

Project Description

The polkadot-typed-api library does not introduce new methods but wraps existing API calls in convenient functions that return typed data. This allows developers to use the Polkadot API with explicit type declarations, significantly reducing the likelihood of errors and simplifying the development process.

Current Results

Currently, the library covers about 5% of all available methods, with an emphasis on 20% of query calls. We plan to significantly increase this coverage, aiming to reach 50% for query calls by the end of 2024 and 100% by the end of 2025.

Challenges and Issues

One of the main challenges is the detailed study of tx calls, each of which requires considerable time investment. We are actively working on this task; however, it demands additional resources and time for comprehensive analysis.

UPDATE:

In the course of discussions with the community, we have chosen a new direction for our development: instead of manually defining types, we will implement dynamic type generation. This approach will be included in the second version of the library.

Dynamic type generation is crucial as it allows for real-time adaptation to changes in the Polkadot API, ensuring that the library remains current with the latest updates and enhancements. This will not only streamline our development process but also provide developers with a more robust and flexible toolset, reducing the likelihood of errors associated with manual typing.

As a result of this strategic shift, we have updated our timelines. We now plan to complete work on reading methods, achieving 100% coverage by the end of 2024, which will be included in version 2.0. Following that, we will focus on transaction methods, with completion targeted for Q1 2025.

Impact on the Developer Community

The development of the polkadot-typed-api library will have a significant impact on the developer community within the Polkadot ecosystem:

• Simplification of API Interaction. Typed access to the API frees developers from manually checking and processing data types, enabling faster integration of functions.
• Increased Code Security. Explicit typing reduces the risk of errors associated with incorrect data types, which is especially important in blockchain development, where mistakes can lead to financial losses.
• Accelerated Development. The library will provide convenient wrappers for existing method calls, allowing developers to focus on business logic and functionality.
• Access to Documented Methods. We plan to document every method of each pallet, creating a user-friendly resource for developers.
• Expansion of the Developer Community. Easier access to typed data will attract more developers to the Polkadot ecosystem, contributing to the development and resilience of the ecosystem.
• Support for New Developers. The library will serve as an excellent resource for newcomers, making the learning process more intuitive and less confusing.
• Incentive for Collaboration. The openness of the code and community support for the library can foster collaboration among developers.

Conclusion

We are not requesting significant funds, but it is crucial for us to understand that the community values our work. The development of the polkadot-typed-api library will be an important step towards improving the Polkadot ecosystem by supporting developers and enhancing code quality, ultimately contributing to the growth of the community.