hashgraph / hedera-docs Goto Github PK
View Code? Open in Web Editor NEWWelcome to the official Hedera documentation repository.
Home Page: https://docs.hedera.com
Welcome to the official Hedera documentation repository.
Home Page: https://docs.hedera.com
Add Greg's theft prevention demo to the docs list - https://docs.hedera.com/guides/resources/demo-applications
This section is manually update every release and has the possibility to be out of date. GitHub creates automated documentation each time the protobufs are updated that should stay up to date.
Update the HAPI section with the link to the auto-generated protobuf API docs https://hashgraph.github.io/hedera-protobufs/.
No response
Add links to tutorial when published
see above
No response
v1 SDKs are no longer supported. The documentation for v1 docs should be removed from the main page to a deprecation section in the docs.
Create a deprecation section to host documentation that is no longer supported.
No response
Currently, when reading the documentation, it is unclear that there are existing standards (namely HIP-405, & HIP-412) for token metadata. It actually even references ethereum standards, but not the Hedera community's own (via smart contracts). This leads projects to either recreate the wheel in attempting to define their own token metadata, or create assets who's metadata are not compatible with other applications/wallets/etc., within the ecosystem.
I think it would be nice to update this page (&/or potentially others) with reference to these token metadata standards
https://docs.hedera.com/guides/docs/sdks/tokens/define-a-token
Alternatively (&/or additionally) I think it could be nice to build in better support for these standards within the official SDKs.
Some of the examples do not provide the import and type statements.
Add the import the type statements for the Go examples.
No response
On this page: https://docs.hedera.com/guides/
the link under hashgraph consensus algorithm is broken. Would have submitted a PR but wasn't sure what exactly is the issue..
Received feedback from a user about parent/child txs.
For the first point:
A parent tx supports up to 999 child transactions since platform reserves 1000 ns per user submitted transaction. The nonce is the nanosecond offset from the parent consensus timestamp. But I wouldn't rely on that relationship of timestamp offset to nonce since it might change. Always use the consensus timestamps and transaction IDs w/ nonce in the records.
For the second point:
The feature doesn't actually work, so we need this issue resolved: hashgraph/hedera-sdk-js#1186
No response
@simi-hedera, both links under this section of the page:
https://docs.hedera.com/guides/core-concepts/smart-contracts/supported-erc-token-standards#examples
are broken.
I believe those links should point to these two examples:
which now live in this path:
https://github.com/hashgraph/hedera-services/tree/master/test-clients/src/main/resource/contract/contracts
Open https://github.com/hashgraph/hedera-services/tree/master/test-clients/src/main/resource/contract/contracts
Click example contracts linked in that section
Receive 404 error
No response
other
v0.25
Windows
Given endpoint route /api/v1/:transaction-id/stateproof
should be api/v1/transactions/:transaction-id/stateproof
In the 'Deploy a Contract Using the Hedera Token Service' tutorial page here: https://docs.hedera.com/guides/getting-started/try-examples/deploy-a-contract-using-the-hedera-token-service, there's a variable switch in step 1.
In HTS.sol there's this function:
function tokenTransfer(address tokenId, address fromAccountId , address toAccountId , int64 tokenAmount) external {
int response = HederaTokenService.transferToken(tokenId, toAccountId, fromAccountId, tokenAmount);
if (response != HederaResponseCodes.SUCCESS) {
revert ("Transfer Failed");
}
}
The tokenTransfer
function should be:
function tokenTransfer(address tokenId, address fromAccountId , address toAccountId , int64 tokenAmount) external {
int response = HederaTokenService.transferToken(tokenId, fromAccountId, toAccountId, tokenAmount);
if (response != HederaResponseCodes.SUCCESS) {
revert ("Transfer Failed");
}
}
as docs are saying here: https://docs.hedera.com/guides/docs/sdks/smart-contracts/hedera-service-solidity-libraries#transfertoken-token-sender-receiver-amount
No response
The mirror node information needs to be included where relavent in the docs. The mirror node content needs to be reviewed for accuracy.
Update mirror node documentation
No response
According to the teams response in the following issue, mirror nodes do not support use in a browser environment.
hashgraph/hedera-sdk-js#1114
#1114 was reported by a Swirlds Labs user, but a Discord user also reported running into this limitation.
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
No response
The try examples section in docs goal was to show the main transactions or queries that were related to using the feature in a handful of steps. The intent was to not include the setting up the env steps, creating relavent accounts, etc as the getting started section covers how to do this. This is causing more confusion than being helpful.
Update the try examples steps to include any necessary accounts or tokens that are needed for the example.
No response
@SimiHunjan could you follow up with LaunchBadge & see which of these (if any) should still be encouraged?
We can remove the iOS from Rejolut as that hasn't been worked on in some time.
cc @donaldthibeau to make sure he's okay with the changes
For smart contracts, we need to document a limitation of fallback() / receive() functions that has been reported via Discord by a power user in the DeFi space. The limitation is that fallback() / receive() functions in a contract do not execute when the contract receives HBAR via crypto transfer. The hbar arrives fine but the msg.sender and msg.value remain null, that's all due to those functions not getting triggered.
Michael T has been involved in chat responses with this user and is aware of the limitation.
No response
testnet
v0.26
Windows
saw a couple of these:
{% hint style="info" %} Hedera Token Service is now live on our networks. Learn more in the blog series, Get started with the Hedera Token Service. Hedera Token Service API information can be found in the SDK section here. {% endhint %}
v1 SDKS are no longer supported and should be removed from the SDK section to a section for deprecations.
Move v1 docs to the deprecation section
No response
I've completed the MVP for Hashgraph Chess, a NuxtJS application that lets users play chess over the HCS testnet. I'd like it added to https://docs.hedera.com/guides/resources/demo-applications as an example project.
My repo is: https://github.com/scalemaildev/hashgraph_chess
No response
In the swagger documentation, adding the transactiontype
parameter NODESTAKEUPDATE
throws a 400 error stating
{
"_status": {
"messages": [
{
"message": "Invalid parameter: transactiontype"
}
]
}
}
transactions
endpointNODESTAKEUPDATE
in transactiontype
query dropdowntestnet
v0.60.0
macOS
https://hedera.com/blog/mapping-hedera-token-service-standards-to-erc20-erc721-erc1155
Add content
No response
I see in https://docs.hedera.com/guides/getting-started/create-an-account there is the text "" at one spot. I'm assuming someone intended this as a reminder to add in some missing content...
Nice job with the getting started tutorial BTW.
Read the page.
No response
other
v1
macOS
Currently, there are no references to the Hedera StackOverflow.
Add links to the Hedera StackOverflow https://stackoverflow.com/questions/tagged/hedera-hashgraph.
No response
On the Mirror Node docs, it lists an accepted query parameter of contractId
for the /api/v1/contracts
endpoint, but a request to that endpoint returns a 400:
$ curl https://testnet.mirrornode.hedera.com/api/v1/contracts?contractId=0.0.34730039
{"_status":{"messages":[{"message":"Invalid parameter: contractid"}]}}
It seems like this endpoint is deprecated in favor of GET /api/v1/contracts/{contractId}
$ curl https://testnet.mirrornode.hedera.com/api/v1/contracts/0.0.34730039
{
"admin_key":null,
"auto_renew_account":null,
"auto_renew_period":7776000,
"contract_id":"0.0.34730039",
...
}
$ curl https://testnet.mirrornode.hedera.com/api/v1/contracts?contractId=0.0.34730039
{"_status":{"messages":[{"message":"Invalid parameter: contractid"}]}}
No response
testnet
No response
Reimagine the core concepts section in a way that captures the Hedera ecosystem. Much of the information is isolated or duplicated in other areas of the docs.
Update core concepts to reflect the system.
No response
The video link in the readme file is broken. It say "video not available" when I click on it. Might be set to private, not public.
Manually adding the rest API docs can cause for outdated information in the docs. GitBook has a widget that allows you to use the spec URL that will automatically keep it up to date with any changes made.
Update the mirror node APIs to use the OpenAPI spec
No response
I made a clone of the HCS express chat program that's built on NuxtJS. It also offers two advantages over the starter one: it uses promises instead of sleep statements, and uses json strings over strings demarcated by the Saturn symbol.
Can it be added to the starter projects list for Javascript?
Check it out here: https://github.com/scalemaildev/hashgraph_nuxt_chat
N/A
No response
Update documentation to support scheduled transactions which is currently slated for March Mainnet release (final date TBD).
Between the rest API, HAPI, and SDK documentation there is a lot of overlap/duplicate information. Consolidate these docs to have a single view of the APIs by task.
Consolidate these docs to have a single view of the APIs by task.
No response
When visiting https://github.com/hashgraph/hedera-docs the repository "about" section is blank, as well as the link.
If we could update this to include a 1 sentence description of the repo, and link to https://docs.hedera.com - that'd be great!
Is it possible to add examples for generating threshold/multi-sig keys to this page within the SDK docs?
It's also likely worth adding examples for multi-party signing wherever it makes sense.
It would be helpful to developers to provide a set of instructions on how to troubleshoot the network response code.
Add trouble shooting steps the network response codes.
No response
The URL for smart contracts renders twice, suggesting the endpoint is:
/api/v1/contracts/api/v1/contracts
When the endpoint is actually:
/api/v1/contracts
It appears this is because the baseUrl
has a value in this case in the Swagger where it is set to an empty string for other endpoints.
No response
mainnet, testnet, previewnet
No response
in v0.52 of the Mirror Node, we added the endpoint /api/v1/accounts/{accountId}/nfts
.
This endpoint is not yet documented in https://docs.hedera.com/guides/docs/mirror-node-api/rest-api#accounts-1
@SimiHunjan, a user flagged on Discord that we should add information about the new /api/v1/accounts/{accountId}/nfts
endpoint in https://docs.hedera.com/guides/docs/mirror-node-api/rest-api#accounts-1
No response
The HBAR Foundation is proud to support the Sustainable Blockchain Virtual Hackathon organized by IPFS and Filecoin June 23 - July 18, 2022!
$10,000 USD in HBAR for the best ReFi & Sustainability Project on Hedera
We're looking for the best implementation on Hedera in Sustainability & ReFi! This can include:
Hedera Hashgraph is a fully open source, proof-of-stake, public network and governing body for building and deploying decentralized applications. It offers developers three primary services: Solidity-based smart contracts, consensus, and token services. Hedera is unique in that it is incredibly fast, energy-efficient (carbon negative), and secure.
The HBAR Foundation Sustainable Impact Fund (SIF) has been established as the first fund of its type in the industry to help do our part in solving the climate crisis and address these challenges on Hedera.
The SIF supports projects through funding, support, and by raising awareness of projects that measurably change how the world works in a specific and attainable way across Environmental, Nature-based, and UN Sustainable Development Goal focused projects to facilitate systemic change for the planet.
To learn how to get started in developing on Hedera check out the getting started on Hedera page and how to guide.
For those interested in tokenizing carbon credits, building new methodologies or dMRV (digital measurement, reporting, and verification) policies check out the Guardian Demo Guide. For those interested we also have a discord, with a channel dedicated to sustainability support.
hi,
is it possible to find configuration of hashgraph test nodes
This issue was reported from a user who experienced higher-than-expected network fees when creating and minting NFTs.
The user suggested updating the information in docs, and according to him, "designers do not look at pricing calculator when making design decisions." - Looks like they're more likely to be looking at documentation to guide those decisions.
The user suggests: include a clause which indicates that "adding a supply key would impact your network charges (see pricing calculator - link)" It would be good to add a standard text for all other keys that impact costs, not just supply key.
No response
This is just a small issue in the documentation , and since it is of environment setup its more problematic for beginners
.
No response
testnet
v0.1.0
macOS
In the doc page for allowances (https://docs.hedera.com/guides/docs/sdks/cryptocurrency/approve-an-allowance), we have:
"Each account is limited to 100 allowances."
This actually confused various users in the ecosystem and made them think that this limitation was similar to the initial token association limit we used to have.
It is the approver account (ie the current token owner) has the 100 approval limitation.
It's NOT a limitation of the account receiving the approvals (ie Marketplace account).
We should write:
"Each owner account is limited to granting 100 allowances."
No response
When PRs are submitted you can't view a preview of the content that will be modified.
GitBook has a feature to enable previews on PRs. Enable this feature.
No response
When using the 'Discord chat' invite on this docs page:
https://docs.hedera.com/guides/#have-feedback
discord reports: Invalid Invite. This invite has expired or you might not have permission to join.
Expected behavior: not that.
Because of the doc design with three columns, we often are not afforded a great amount of space in the middle content column. This can have the unfortunate side effect of reducing readability. For example, see this page.
We are reserving a large amount of space on the page for the right column, but that column is not pulling its weight. Perhaps we should consider a design variation where the table of contents is displayed within the main page, rather than having ~25% of the horizontal screen real estate reserved for it?
As above.
No response
other
N/A
No response
Docs do not have clear content around the ability for contracts to hold HBAR and/or HTS tokens and any associated requirements for that (like keys, signing, etc)
Add info
No response
Update the release notes format to consume what happened in an easy way.
see above
No response
Separate the feedback page from the main page. There is more information to add.
Add information about how to contribute to docs or make feature requests.
No response
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.