Improve explanation how to get abi output.

This commit is contained in:
chriseth 2018-12-11 13:58:02 +01:00
parent 5355380f80
commit fe87cc7eb0

View File

@ -200,15 +200,27 @@ Input Description
"MyLib": "0x123123..." "MyLib": "0x123123..."
} }
} }
// The following can be used to select desired outputs. // The following can be used to select desired outputs based
// If this field is omitted, then the compiler loads and does type checking, but will not generate any outputs apart from errors. // on file and contract names.
// The first level key is the file name and the second is the contract name, where empty contract name refers to the file itself, // If this field is omitted, then the compiler loads and does type checking,
// while the star refers to all of the contracts. // but will not generate any outputs apart from errors.
// The first level key is the file name and the second level key is the contract name.
// An empty contract name is used for outputs that are not tied to a contract
// but to the whole source file like the AST.
// A star as contract name refers to all contracts in the file.
// Similarly, a star as a file name matches all files.
// To select all outputs the compiler can possibly generate, use
// "outputSelection: { "*": { "*": [ "*" ], "": [ "*" ] } }"
// but note that this might slow down the compilation process needlessly.
// //
// The available output types are as follows: // The available output types are as follows:
// abi - ABI //
// File level (needs empty string as contract name):
// ast - AST of all source files // ast - AST of all source files
// legacyAST - legacy AST of all source files // legacyAST - legacy AST of all source files
//
// Contract level (needs the contract name or "*"):
// abi - ABI
// devdoc - Developer documentation (natspec) // devdoc - Developer documentation (natspec)
// userdoc - User documentation (natspec) // userdoc - User documentation (natspec)
// metadata - Metadata // metadata - Metadata