Automatically generate/update Status.js and RequestType.js

[janaakhterov]

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to Hedera or any open source project in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'good first issue' is to help you make your first contribution to Hedera.

👾 Description of the issue

Problem

Currently, both Status.js and RequestType.js must be manually updated whenever new statuses or request types are introduced. While tools and scripts can streamline this process, it still requires manual execution and oversight. In particular, files like Status.js are prone to human error when manually updating the various status codes and response codes associated with Hedera transactions. Automating this process would eliminate the need for human intervention, ensure accuracy, and save time when new statuses or request types are added to the Hedera system.

For example, Status.js currently contains manually hardcoded status codes:

case Status.Ok:
  return "OK";
case Status.InvalidTransaction:
  return "INVALID_TRANSACTION";
case Status.PayerAccountNotFound:
  return "PAYER_ACCOUNT_NOT_FOUND"

Here are examples for manually adding the statuses:
Example 1
Example 2
Example 3

If a new status code is introduced in the Hedera protobuf definitions, this file would need to be manually updated to reflect that change.

Solution

Automate the generation or updating of Status.js and RequestType.js by connecting the process directly to the Hedera protobuf definitions. This way, whenever new status codes or request types are introduced in the protobuf schema, the corresponding JavaScript files will be automatically updated or regenerated. This could be done by writing a script that parses the protobuf definitions and generates the JavaScript constants, ensuring that all relevant status codes and request types are always up-to-date.

Steps to Implement

1. Create or modify a script to parse the Hedera protobuf definitions (such as ResponseCodeEnum).
2. The script should automatically generate or update the content of Status.js and RequestType.js, appending new statuses and request types as needed.
3. Integrate this script into the build or CI/CD pipeline so that the files are always updated whenever new protobuf definitions are added.

Additional Context

Given that Hedera is tightly integrated with protobuf, having the ability to pull in new status codes from the protobuf schema directly into the JavaScript files would ensure consistency across the ecosystem, especially during frequent updates.

Affected Environment

Hedera SDK Version: Any
Operating System: Platform-independent (process needs to work across all environments)

📋 Step by step guide to do a contribution

If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file.
A more detailed general documentation of the GitHub PR workflow can be found here.

• Claim this issue: Comment below that you are interested in working on the issue
• Wait for assignment: A community member with the given rights will add you as an assignee of the issue
• Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
• Check out the forked repository
• Create a feature branch for the issue. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
• Solve the issue in your branch.
• Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org). More details can be found in our CONTRIBUTING.md
• Start a Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
• Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hedera developer community for support.
• Wait for reviews: Members of the Hedera developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.
• You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of the Hedera community as an open-source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

🤔 Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.

[janaakhterov]

Something to note here, with Java auto-generating these files already the hick-up we faced was when the protobufs renamed HederaFunctionality.Prng -> HederaFunctionality.UtilPrng. This would cause (and did cause) a breaking change in Java. So, the question is, should the SDKs keep up to date with the names in the protobufs for certain enums such as ResponseCodeEnum and HederaFunctionality, or should the SDKs hard-code a name?

[hendrikebbers]

We discussed about the issue in the hackathon today and have some questions about status and requestType. Before somebody work on the issues we should check if we can find a better solution. See hashgraph/hedera-sdk-java#2040