aboutsummaryrefslogtreecommitdiffstats
path: root/docs/using-the-compiler.rst
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2016-11-17 18:31:46 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2017-02-09 05:53:07 +0800
commit559c4c7a451bbe0518441bd0442b8325f40b279a (patch)
treeb75b4873c16e193e9b1a841419c1642c6d7ca507 /docs/using-the-compiler.rst
parent073871c248b097b654fb354fd756559009d7c3e9 (diff)
downloaddexon-solidity-559c4c7a451bbe0518441bd0442b8325f40b279a.tar.gz
dexon-solidity-559c4c7a451bbe0518441bd0442b8325f40b279a.tar.zst
dexon-solidity-559c4c7a451bbe0518441bd0442b8325f40b279a.zip
Update the metadata JSON spec
Diffstat (limited to 'docs/using-the-compiler.rst')
-rw-r--r--docs/using-the-compiler.rst33
1 files changed, 23 insertions, 10 deletions
diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst
index 4fc5c71d..de9e104a 100644
--- a/docs/using-the-compiler.rst
+++ b/docs/using-the-compiler.rst
@@ -197,29 +197,43 @@ that can be used to query a location of the binary (and whether the version is
"official") at a registry contract.
{
+ // The version of the metadata format (required field)
version: "1",
+ // Required field
language: "Solidity",
+ // Required field, the contents are specific to the language
compiler: {
- commit: "55db20e32c97098d13230ab7500758e8e3b31d64",
- version: "soljson-2313-2016-12-12",
- keccak: "0x123..."
+ name: "solc",
+ version: "0.4.5-nightly.2016.11.15+commit.c1b1efaf.Emscripten.clang",
+ // Optional hash of the compiler binary which produced this output
+ keccak256: "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..."},
- "xkcd": {swarm: "0x456..."}
+ "myFile.sol": {
+ "keccak256": "0x123...",
+ "url": "bzzr://0x56..."
+ },
+ "Token": {
+ "keccak256": "0x456...",
+ "url": "https://raw.githubusercontent.com/ethereum/solidity/develop/std/Token.sol"
+ },
+ "mortal": {
+ "content": "contract mortal is owned { function kill() { if (msg.sender == owner) selfdestruct(owner); } }"
+ }
},
// This is a subset of the regular compiler input
+ // Its content is specific to the compiler (determined by the language and compiler fields)
settings:
{
remappings: [":g/dir"],
optimizer: {enabled: true, runs: 500},
- compilationTarget: "myFile.sol:MyContract",
+ compilationTarget: {
+ "myFile.sol": MyContract"
+ },
libraries: {
- "def:MyLib": "0x123123..."
+ "MyLib": "0x123123..."
}
},
// This is a subset of the regular compiler output
@@ -228,7 +242,6 @@ that can be used to query a location of the binary (and whether the version is
abi: [ /* abi definition */ ],
userdoc: [],
devdoc: [],
- natspec: [ /* user documentation comments */ ]
}
}