Create an Example for "Create File" functionality #2512
Labels
enhancement
New feature or request
good first issue
Issues which are ideal for a first time or new project contributor.
hacktoberfest
Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution.
🆕🐥 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
The Hedera Java SDK includes a simple but essential example, CreateFileExample.java, which demonstrates how to create, manage, and delete a file on the Hedera network. This example showcases a key functionality of the Hedera File Service, helping developers understand how to interact with files on Hedera.
However, there is no equivalent example available in the Hedera JavaScript SDK. Developers using the JavaScript SDK would benefit from a similar example that guides them through the process of creating a file, setting the file's contents, and managing the file lifecycle (including deletion).
Solution
Below is a link to the existing Java implementation, which can serve as a basis for creating the JavaScript example:
CreateFileExample.java
Steps to Implement
Client
in the JavaScript SDK usingsetOperator
.FileCreateTransaction
to create a new file, specifying the operator's public key as the owner.FileDeleteTransaction
.Expected Outcome
The new example will help developers using the JavaScript SDK understand how to create, manage, and delete files using the Hedera File Service. It will also highlight key SDK features such as handling file contents, associating keys with files, and managing transaction fees.
By providing this JavaScript example, we align the JavaScript SDK with the Java SDK in terms of documentation and usability, making it easier for developers to build Hedera-based applications.
📋 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.
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🎉 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.
The text was updated successfully, but these errors were encountered: