From 21a022848540dc488b312f94b62d62fce66aafc7 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Thu, 2 Feb 2017 21:10:19 +0000 Subject: Include pseudo-code of compiler API --- docs/using-the-compiler.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst index b89af912..703a1c57 100644 --- a/docs/using-the-compiler.rst +++ b/docs/using-the-compiler.rst @@ -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. -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 ****************************************** @@ -66,6 +77,7 @@ Input Description "myFile.sol": { // Optional: keccak256 hash of the source file + // It is used to verify the retrieved content if imported via URLs. "keccak256": "0x123...", // 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 -- cgit v1.2.3