aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2016-11-16 21:25:40 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2017-02-09 05:53:07 +0800
commit073871c248b097b654fb354fd756559009d7c3e9 (patch)
tree6863715eb6182cb85d91033af82e5ed8aca23e80
parent04089edc4e651493f7596bf2372c7c0487fc2dad (diff)
downloaddexon-solidity-073871c248b097b654fb354fd756559009d7c3e9.tar
dexon-solidity-073871c248b097b654fb354fd756559009d7c3e9.tar.gz
dexon-solidity-073871c248b097b654fb354fd756559009d7c3e9.tar.bz2
dexon-solidity-073871c248b097b654fb354fd756559009d7c3e9.tar.lz
dexon-solidity-073871c248b097b654fb354fd756559009d7c3e9.tar.xz
dexon-solidity-073871c248b097b654fb354fd756559009d7c3e9.tar.zst
dexon-solidity-073871c248b097b654fb354fd756559009d7c3e9.zip
Update the metadata JSON spec
-rw-r--r--docs/using-the-compiler.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst
index a49bfb8e..4fc5c71d 100644
--- a/docs/using-the-compiler.rst
+++ b/docs/using-the-compiler.rst
@@ -204,12 +204,15 @@ that can be used to query a location of the binary (and whether the version is
version: "soljson-2313-2016-12-12",
keccak: "0x123..."
},
+ // This is a subset of the regular compiler input
sources:
{
"abc": {keccak: "0x456..."}, // here, sources are always given by hash
"def": {keccak: "0x123..."},
- "dir/file.sol": {keccax: "0xabc..."}
+ "dir/file.sol": {keccax: "0xabc..."},
+ "xkcd": {swarm: "0x456..."}
},
+ // This is a subset of the regular compiler input
settings:
{
remappings: [":g/dir"],
@@ -219,9 +222,12 @@ that can be used to query a location of the binary (and whether the version is
"def:MyLib": "0x123123..."
}
},
+ // This is a subset of the regular compiler output
output:
{
abi: [ /* abi definition */ ],
+ userdoc: [],
+ devdoc: [],
natspec: [ /* user documentation comments */ ]
}
}