Merge pull request #385 from ethereum/new-callback-backport

Backport new callback API to 0.5

Author: axic

README.md

@@ -46,6 +46,8 @@ It also accepts an optional callback function to resolve unmet dependencies. Thi
 It cannot be used together with callback-based, asynchronous, filesystem access. A workaround is to collect the names of dependencies, return an error, and keep re-running the compiler until all
 of them are resolved.
 
+Starting 0.5.12 it also accepts an object in place of the callback to supply different kind of callbacks, however only file imports are supported.
+
 *Note*: as an intermittent backwards compatibility feature, between versions 0.5.0 and 0.5.2, `compileStandard` and `compileStandardWrapper` also exists and behave like `compile` does.
 
 #### Example usage without the import callback
@@ -106,8 +108,12 @@ function findImports (path) {
 		return { error: 'File not found' }
 }
 
+// Current syntax
 var output = JSON.parse(solc.compile(JSON.stringify(input), findImports))
 
+// New syntax (supported from 0.5.12)
+var output = JSON.parse(solc.compile(JSON.stringify(input), { import: findImports }))
+
 // `output` here contains the JSON output as specified in the documentation
 for (var contractName in output.contracts['test.sol']) {
 	console.log(contractName + ': ' + output.contracts['test.sol'][contractName].evm.bytecode.object)

test/package.js

@@ -396,6 +396,51 @@ tape('Compilation', function (t) {
     st.end();
   });
 
+  t.test('compiling standard JSON (with imports)', function (st) {
+    // <0.1.6 doesn't have this
+    if (!solc.features.multipleInputs) {
+      st.skip('Not supported by solc');
+      st.end();
+      return;
+    }
+
+    var input = {
+      'language': 'Solidity',
+      'settings': {
+        'outputSelection': {
+          '*': {
+            '*': [ 'evm.bytecode' ]
+          }
+        }
+      },
+      'sources': {
+        'cont.sol': {
+          'content': 'import "lib.sol"; contract x { function g() public { L.f(); } }'
+        }
+      }
+    };
+
+    function findImports (path) {
+      if (path === 'lib.sol') {
+        return { contents: 'library L { function f() public returns (uint) { return 7; } }' };
+      } else {
+        return { error: 'File not found' };
+      }
+    }
+
+    var output = JSON.parse(solc.compile(JSON.stringify(input), findImports));
+    var x = getBytecodeStandard(output, 'cont.sol', 'x');
+    st.ok(x);
+    st.ok(x.length > 0);
+    var L = getBytecodeStandard(output, 'lib.sol', 'L');
+    st.ok(L);
+    st.ok(L.length > 0);
+
+    var outputNewApi = JSON.parse(solc.compile(JSON.stringify(input), { import: findImports }));
+    st.deepEqual(output, outputNewApi);
+    st.end();
+  });
+
   t.test('compiling standard JSON (using libraries)', function (st) {
     // <0.1.6 doesn't have this
     if (!solc.features.multipleInputs) {

wrapper.js

@@ -27,6 +27,11 @@ function setupMethods (soljson) {
 
   // This calls compile() with args || cb
   var runWithReadCallback = function (readCallback, compile, args) {
+    // Forward compatibility with 0.6.x
+    if (typeof readCallback === 'object') {
+      readCallback = readCallback.import;
+    }
+
     if (readCallback === undefined) {
       readCallback = function (path) {
         return {