cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Modify the metadata document.

Browse Source
This commit is contained in:
Luoh Ren-Shan (LCamel) 2022-07-21 20:55:45 +08:00
parent 800088e38b
commit de857c27f3
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/metadata.rst
View File

@ -21,9 +21,12 @@ the :ref:`Standard JSON Interface<compiler-api>`.
You have to publish the metadata file to IPFS, Swarm, or another service so
that others can access it. You create the file by using the ``solc --metadata``
command that generates a file called ``ContractName_meta.json``. It contains
IPFS and Swarm references to the source code, so you have to upload all source
files and the metadata file.
command together with the ``--output-dir`` parameter. Without the parameter,
it will only be written to standard out.
It contains IPFS and Swarm references to the source code, so you have to
upload all source files and the metadata file. For IPFS, The hash contained
in the CID returned by ``ipfs add`` (not the direct sha2-256 hash of the file)
shall match with the one contained in the bytecode.
The metadata file has the following format. The example below is presented in a
human-readable way. Properly formatted metadata should use quotes correctly,