Skip to content

Incorrect evidence parameter documentation #17

Closed
@eccentricexit

Description

@eccentricexit

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

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions