Created an example for 'Get file contents' functionality

[b-l-u-e]

Description:
This PR adds a get-file-contents example to demonstrate how to retrieve file contents using the Hedera JavaScript SDK. This functionality is important for developers who need to access and work with file data stored on the Hedera network.

• Add get-file-contents.js example file
• Implement file contents query using FileContentsQuery
• Include error handling and logging for better developer experience
• Demonstrate proper use of ECDSA keys or ED25519 keys with the SDK

Related issue(s):

Fixes # 2513

[ivaylogarnev-limechain]

Have you tested this example to ensure it runs correctly? 🔧

Will this work on a local network setup as well? 👾

[b-l-u-e]

Thank you for your guidance. let me update my code and do further tests

…

On Mon, Oct 7, 2024 at 3:51 PM ivaylogarnev ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In examples/get-file-contents.js <#2561 (comment)> : > + // Step 2: File contents query + const fileId = FileId.fromString(fileIdStr); // Convert fileId to FileId object + console.log(`Querying contents of file with ID: ${fileId}`); + const query = new FileContentsQuery() + .setFileId(fileId) + .setMaxQueryPayment(new Hbar(2)); // Set max payment to 2 HBAR + + // Step 3: Processing the file contents + const contents = await query.execute(client); + console.log("File contents retrieved successfully."); + + // Output the file contents + console.log("File contents:"); + console.log(contents.toString("utf8")); // Convert contents to a readable string + } catch (error) { + // Step 5: Error handling Small typo, its step 4 here :) ------------------------------ In examples/get-file-contents.js <#2561 (comment)> : > +import { + Client, + PrivateKey, + AccountId, + FileContentsQuery, + Hbar, + FileId, +} from ***@***.***/sdk"; +import dotenv from "dotenv"; + +dotenv.config(); + +async function main() { + console.log("Get File Contents Example Start!"); + + // Step 1: Client and operator setup Could you use this template format for comments to make them more noticeable? /* * Step 1: * Client and operator setup. */ ------------------------------ In examples/get-file-contents.js <#2561 (comment)> : > + +dotenv.config(); + +async function main() { + console.log("Get File Contents Example Start!"); + + // Step 1: Client and operator setup + const operatorId = AccountId.fromString(process.env.OPERATOR_ID); + const operatorKey = PrivateKey.fromStringECDSA(process.env.OPERATOR_KEY); + const client = Client.forName(process.env.HEDERA_NETWORK || "testnet"); + client.setOperator(operatorId, operatorKey); + + console.log("Client and operator setup complete."); + + // For this example, we'll use a known file ID. In practice, you'd use an existing file ID. + const fileIdStr = process.env.FILE_ID; You want to avoid using a hardcoded value for the FileId, as this ID may corresponds to a file on the testnet network. Instead, refer to the Java <https://github.com/hashgraph/hedera-sdk-java/blob/main/examples/src/main/java/com/hedera/hashgraph/sdk/examples/GetFileContentsExample.java> example, where we first execute a FileCreate transaction to create the file on the network specified by the client. After that, we retrieve the contents of the newly created file. Please review the Java example again and proceed by following that flow. ------------------------------ In examples/get-file-contents.js <#2561 (comment)> : > + ); + } + if ("receipt" in error && error.receipt) { + console.error( + `Transaction receipt: ${JSON.stringify(error.receipt, null, 2)}`, + ); + } + } + } finally { + // Close the client + client.close(); + console.log("Get File Contents Example Complete!"); + } +} + +main().catch((error) => { We don't expect any unexpected errors here, as any issues should be caught earlier in the process. Please take a look at the other JavaScript examples <https://github.com/hashgraph/hedera-sdk-js/tree/main/examples> and review the conventions we follow when creating a JS example. ------------------------------ In examples/get-file-contents.js <#2561 (comment)> : > + console.log(`Querying contents of file with ID: ${fileId}`); + const query = new FileContentsQuery() + .setFileId(fileId) + .setMaxQueryPayment(new Hbar(2)); // Set max payment to 2 HBAR + + // Step 3: Processing the file contents + const contents = await query.execute(client); + console.log("File contents retrieved successfully."); + + // Output the file contents + console.log("File contents:"); + console.log(contents.toString("utf8")); // Convert contents to a readable string + } catch (error) { + // Step 5: Error handling + console.error("Error occurred during file query:"); + if (typeof error === "object" && error !== null) { You can simply log the error to the console here—there’s no need to overcomplicate it with specific error-handling. The main point is just to display the error, as this isn’t our primary focus. Let's keep it straightforward. — Reply to this email directly, view it on GitHub <#2561 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHXJXRHQH4N7LQLKF7TRA53Z2J7V3AVCNFSM6AAAAABPMFR4RWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDGNJQHA3TGMBTHA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[b-l-u-e]

The code is tested and run it on local node. updated the file
its working fine now.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[ivaylogarnev-limechain]

Thank you so much for you work! I just have a small request regarding the PR. Could you please create a new PR by cloning from the main branch and include the new file in a single commit? This will help avoid any issues with references or CI errors due to the existing 32 commits.

Thanks again for your contribution, and I appreciate your understanding!

[b-l-u-e]

@ivaylogarnev-limechain thanks for the feedback.
I have a question. since there are 2 issues am working on right now. and based on the suggestion that i create a new PR and use get file contents" does it mean i dont have to create 2 pull requests for two separate issues. i can still maintain one PR as i work on different issues

[b-l-u-e]

I created the PR what happens to this now? should i close it or delete it? Please advice

[agadzhalov]

Closing due to new PR opened for this issue