Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the fees table with the SDK transaction names for each Hedera API transaction name #781

Open
11 tasks
SimiHunjan opened this issue Sep 3, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Indicates a good issue for first-time contributors

Comments

@SimiHunjan
Copy link
Collaborator

Problem

🆕🐥 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

Update the fees table here: https://docs.hedera.com/hedera/networks/mainnet/fees with the SDK transaction names so that there is a mapping of the Hedera API transaction names and the SDK transaction names. This will make it easy for a developer to understand the fees for transactions when using the SDKs.

You can find the list of SDK transaction and query names here: https://hashgraph.github.io/hedera-sdk-js/modules/native.html. Most API transaction and query names for the SDKs append "Transaction" or "Query" to the end of the API name in the existing fees table. The SDK uses "Account" instead of "Crypto." The Hedera API name in the fees table for creating an account is CryptoCreate where in the SDK it is AccountCreateTransaction, for example.

Solution

Proposed Solution:

  • Go to the fees table and use this link https://hashgraph.github.io/hedera-sdk-js/modules/native.html to map the Hedera API names with the SDK API names for transactions and queries
  • Rename the "Operations" column to "Hedera API"
  • Add a column to the table to the right of Hedera API column titled "SDK API"
  • Enter the SDK API name for all Hedera API names

📋 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.

Alternatives

No response

@SimiHunjan SimiHunjan added enhancement New feature or request good first issue Indicates a good issue for first-time contributors labels Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Indicates a good issue for first-time contributors
Projects
None yet
Development

No branches or pull requests

1 participant