Merge pull request #9913 from ethereum/documentGeneratedSources

Document generated sources.
ethereum · Sep 28, 2020 · e18c445 · e18c445
2 parents f1deb41 + add9867
commit e18c445
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst
@@ -314,6 +314,7 @@ Input Description
         //   evm.bytecode.opcodes - Opcodes list
         //   evm.bytecode.sourceMap - Source mapping (useful for debugging)
         //   evm.bytecode.linkReferences - Link references (if unlinked object)
+        //   evm.bytecode.generatedSources - Sources generated by the compiler
         //   evm.deployedBytecode* - Deployed bytecode (has all the options that evm.bytecode has)
         //   evm.deployedBytecode.immutableReferences - Map from AST ids to bytecode ranges that reference immutables
         //   evm.methodIdentifiers - The list of function hashes
@@ -427,6 +428,18 @@ Output Description
                 "opcodes": "",
                 // The source mapping as a string. See the source mapping definition.
                 "sourceMap": "",
+                // Array of sources generated by the compiler. Currently only
+                // contains a single Yul file.
+                "generatedSources": [{
+                  // Yul AST
+                  "ast": { ... }
+                  // Source file in its text form (may contain comments)
+                  "contents":"{ function abi_decode(start, end) -> data { data := calldataload(start) } }",
+                  // Source file ID, used for source references, same "namespace" as the Solidity source files
+                  "id": 2,
+                  "language": "Yul",
+                  "name": "#utility.yul"
+                }]
                 // If given, this is an unlinked object.
                 "linkReferences": {
                   "libraryFile.sol": {