Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect evidence parameter documentation #17

Closed
eccentricexit opened this issue Nov 4, 2020 · 3 comments
Closed

Incorrect evidence parameter documentation #17

eccentricexit opened this issue Nov 4, 2020 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@eccentricexit
Copy link
Contributor

eccentricexit commented Nov 4, 2020

The docs and the IEvidence contract display an incorrect parameter documentation for the Evidence event.

* @param _evidence A URI to the evidence JSON file whose name should be its keccak256 hash followed by .json.
:

* @param _evidence A URI to the evidence JSON file whose name should be its keccak256 hash followed by .json.

The _evidence parameter should be its multihash without file extension , not its keccak256 hash followed by the extension. See ethereum/EIPs#1497.

It is acceptable to have a custom name + .json extension if the URI points to a content-addressed storage (and therefore uses multihash in the link) like as ipfs, such that the full URI looks like (for example):

  • ipfs://QmUQMJbfiQYX7k6SWt8xMpR7g4vwtAYY1BTeJ8UY8JWRs9/evidence.json
  • bzz://1e0e21894d731271e50ea2cecf60801fdc8d0b23ae33b9e808e5789346e3355e/evidence.json
  • /ipfs/QmUQMJbfiQYX7k6SWt8xMpR7g4vwtAYY1BTeJ8UY8JWRs9/evidence.json
@eccentricexit eccentricexit added the bug Something isn't working label Nov 4, 2020
@epiqueras
Copy link

The doc should just point to the evidence standard.

@0xferit 0xferit self-assigned this Apr 15, 2021
@0xferit 0xferit added this to To do in Ferit's Taskboard via automation Apr 15, 2021
@0xferit 0xferit moved this from To do to In progress in Ferit's Taskboard May 28, 2021
@0xferit
Copy link
Member

0xferit commented May 28, 2021

Do we support bzz? None of the applications implement anything except IPFS.

@0xferit
Copy link
Member

0xferit commented May 28, 2021

Updated to IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'. Closing. Reopen if you think it's not good.

@0xferit 0xferit closed this as completed May 28, 2021
Ferit's Taskboard automation moved this from In progress to Done May 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
No open projects
Development

No branches or pull requests

3 participants