Skip to content

Commit de857c2

Browse files
committed
Modify the metadata document.
1 parent 800088e commit de857c2

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/metadata.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,12 @@ the :ref:`Standard JSON Interface<compiler-api>`.
2121

2222
You have to publish the metadata file to IPFS, Swarm, or another service so
2323
that others can access it. You create the file by using the ``solc --metadata``
24-
command that generates a file called ``ContractName_meta.json``. It contains
25-
IPFS and Swarm references to the source code, so you have to upload all source
26-
files and the metadata file.
24+
command together with the ``--output-dir`` parameter. Without the parameter,
25+
it will only be written to standard out.
26+
It contains IPFS and Swarm references to the source code, so you have to
27+
upload all source files and the metadata file. For IPFS, The hash contained
28+
in the CID returned by ``ipfs add`` (not the direct sha2-256 hash of the file)
29+
shall match with the one contained in the bytecode.
2730

2831
The metadata file has the following format. The example below is presented in a
2932
human-readable way. Properly formatted metadata should use quotes correctly,

0 commit comments

Comments
 (0)