ConsenSysMesh / ConsenSysMesh/stow-js
Confusion over how and when to generate a dataHash
- Dominant language
- JavaScript
- Stars
- 18
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
There isn’t any documentation that shows how to generate the dataHash in StowJS. At best you can sort of infer that there is something in utilities, but there is only encryption and decryption.
If you don’t know about Web3 and are new to using Stow, you wouldn’t know how to generate a dataHash using ```stow.web3.utils.sha3```.
There are many ways to generate hash, like with MD5, sha5, etc. Is there a recommended hashing algorithm or some sort of way to let the user know that sha3 is being used. Where would we communicate that to other dev?
Currently, you would have to look at code from other projects to see how its done.
So, we nee documentation needs to add how to generate dataHash in the utils section of the library and the best practices of when to generate the hash (when we upload file to data store, aka IPFS, S3, etc).
So needs to refer to code snippet (that although not part of our core library, its part of web3, we need to explain that we are using the method here.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.