Documenting that mirror nodes do not support use in a browser environment

[ed-marquez]

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

According to the teams response in the following issue, mirror nodes do not support use in a browser environment. https://github.com/hashgraph/hedera-sdk-js/issues/1114. Add this information to the mirror node section in docs.

Solution

• Go to https://docs.hedera.com/hedera/sdks-and-apis/hedera-consensus-service-api section in the docs GitHub repo

• Add the information to a callout noting that the mirror node does not support gRPC web proxies and browser storage

  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.

Problem

According to the teams response in the following issue, mirror nodes do not support use in a browser environment. https://github.com/hashgraph/hedera-sdk-js/issues/1114

1114 was reported by a Swirlds Labs user, but a Discord user also reported running into this limitation.

Solution

It may be worth adding a sentence or two in the documentation to include info on this limitation. Perhaps here (i think?): https://docs.hedera.com/guides/docs/mirror-node-api/hedera-consensus-service-api-1

Alternatives

No response

[radleylewis]

Problem

Unable to subscribe to topics in the browser environment (where gRPC-web is used). As per the above, and below reference, the explanation given being that the mirror nodes themselves don't support gRPC-web.

However, when in the context of the browser, it is possible to successfully invoke TopicMessageSubmitTransaction to send messages to the Hedera Network.

The get topic messages is, as discussed, not working.

Question

Is it possible to provide more information on the cause of the limitation? I'm assuming that gRPC-web requests are not supported/cannot succeed because the subscription would need to be routed back through the gRPC-web proxy. Would this assumption be accurate?

Reference

This issue is also discussed here. Specifically, that the mirror nodes themselves do not expose a gRPC-web endpoint.