core-rs-albatross icon indicating copy to clipboard operation
core-rs-albatross copied to clipboard

Feature Request: Enhance TypeScript Type Safety for nimiq-client RPC

Open blouflashdb opened this issue 2 months ago • 0 comments

Description

I am currently utilizing a community-maintained TypeScript RPC client for interacting with the Nimiq Albatross network. However, I've encountered issues with incorrect typings for some response types. Additionally, when new RPC endpoints with different responses are added to the nimiq-client, it necessitates manual updates to the typings in the third-party package.

Proposed Solution

To address these challenges and improve the developer experience, I propose the creation of a dedicated typings package based on the nimiq-client RPC server. This package would automatically publish to npm (similar to @nimiq/core) after every release. By doing so, third-party packages can achieve end-to-end type safety, ensuring that all typings remain up-to-date with the latest RPC endpoints and responses.

Benefits

  • Enhanced Type Safety: Developers building on top of Nimiq via TypeScript will benefit from accurate and up-to-date typings, reducing runtime errors and improving code reliability.
  • Improved Developer Experience: Automating the publication of typings ensures that developers do not need to manually update typings for new RPC endpoints, streamlining the development process.
  • Seamless Integration: The typings could be integrated directly into @nimiq/core, eliminating the need for a separate package and simplifying dependency management.

Offer to Contribute

I would love to help implement this feature request, but I would need some more context on how to achieve this solution. Any guidance or resources you can provide would be greatly appreciated.

Thank you for considering this feature request. I believe it will greatly benefit the Nimiq developer community.

blouflashdb avatar Dec 02 '24 12:12 blouflashdb