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

Include pseudo-code of compiler API

Browse Source
This commit is contained in:
Alex Beregszaszi 2017-02-02 21:10:19 +00:00
parent d46ec20f88
commit 21a0228485
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/using-the-compiler.rst
View File

@ -42,7 +42,18 @@ Using the Compiler API
The compiler API expects a JSON formatted input and outputs the compilations result in a JSON formatted output. The compiler API expects a JSON formatted input and outputs the compilations result in a JSON formatted output.
TBD See the following pseudo-code:
.. code-block:: none
// defined by the consumer of the API
importCallback(url:string) -> content:string
// invoking the compiler
solc.compile(inputJSON:string, importCallback:function) -> outputJSON:string
The compiler will ask the ``importCallback`` for each URL defined for a source file and will stop when it succeeds.
If all URLs failed, the compilation results in a failure.
Compiler Input and Output JSON Description Compiler Input and Output JSON Description
****************************************** ******************************************
@ -66,6 +77,7 @@ Input Description
"myFile.sol": "myFile.sol":
{ {
// Optional: keccak256 hash of the source file // Optional: keccak256 hash of the source file
// It is used to verify the retrieved content if imported via URLs.
"keccak256": "0x123...", "keccak256": "0x123...",
// Required (unless "content" is used, see below): URL(s) to the source file. // Required (unless "content" is used, see below): URL(s) to the source file.
// URL(s) should be imported in this order and the result checked against the // URL(s) should be imported in this order and the result checked against the