2017-12-16 20:39:30 +00:00
let async = require ( '../../utils/async_extend.js' ) ;
let SolcW = require ( './solcW.js' ) ;
class Solidity {
2018-06-04 17:12:51 +00:00
constructor ( embark , options ) {
Process logs API refactor
There are three separate instances of process log APIs: embark logs, blockchain logs (when in standalone mode), and child process logs (storage, communication, blockchain, etc). Each one was repeating the implementation of creating a process log API endpoint. This commit centralises the API declaration by using the class `ProcessLogsApi`.
`ProcessLogsApi` is started for all three components mentioned above: blockchain (in standalone) in the `BlockchainListener` module, embark in the `EmbarkListener` module, and for all child processes in the `ProcessLauncher`.
These listeners have two functions:
1. Create the process logs API endpoints for `get` and `ws`, and
2. Ensure that all logs are logged through the `LogHandler`, which normalises the output of the log and ensures each log has a timestamp and id (used in the cockpit for log ordering).
Also, this commit moved the pipeline in to a module, so that the `embark` object could be passed to the `ProcessLogsApi` (to be used for registering API endpoints).
2018-10-24 05:54:09 +00:00
this . embark = embark ;
2017-12-16 20:39:30 +00:00
this . logger = embark . logger ;
2017-12-30 21:48:53 +00:00
this . events = embark . events ;
2018-06-04 19:36:43 +00:00
this . ipc = options . ipc ;
2018-05-30 16:26:49 +00:00
this . contractDirectories = embark . config . contractDirectories ;
2018-05-18 17:41:25 +00:00
this . solcAlreadyLoaded = false ;
this . solcW = null ;
2018-06-14 23:37:52 +00:00
this . useDashboard = options . useDashboard ;
2018-08-20 13:27:23 +00:00
this . options = embark . config . embarkConfig . options . solc ;
2017-12-16 20:39:30 +00:00
embark . registerCompiler ( ".sol" , this . compile _solidity . bind ( this ) ) ;
2018-08-07 04:28:26 +00:00
embark . registerAPICall (
'post' ,
'/embark-api/contract/compile' ,
( req , res ) => {
2018-08-30 12:13:37 +00:00
if ( typeof req . body . code !== 'string' ) {
return res . send ( { error : 'Body parameter \'code\' must be a string' } ) ;
2018-08-29 06:12:28 +00:00
}
2018-08-30 12:13:37 +00:00
const input = { [ req . body . name ] : { content : req . body . code . replace ( /\r\n/g , '\n' ) } } ;
2018-10-02 08:30:20 +00:00
this . compile _solidity _code ( input , { } , true , { } , ( errors , result ) => {
2018-08-30 12:13:37 +00:00
const responseData = { errors : errors , result : result } ;
2018-08-13 11:44:42 +00:00
this . logger . trace ( ` POST response /embark-api/contract/compile: \n ${ JSON . stringify ( responseData ) } ` ) ;
res . send ( responseData ) ;
2018-08-07 04:28:26 +00:00
} ) ;
}
) ;
2017-12-16 20:39:30 +00:00
}
2018-08-13 11:44:42 +00:00
_compile ( jsonObj , returnAllErrors , callback ) {
2018-08-27 20:22:53 +00:00
const self = this ;
self . solcW . compile ( jsonObj , function ( err , output ) {
self . events . emit ( 'contracts:compile:solc' , jsonObj ) ;
if ( err ) {
2018-08-08 06:27:14 +00:00
return callback ( err ) ;
}
2018-08-28 12:25:38 +00:00
if ( output . errors && returnAllErrors ) {
return callback ( output . errors ) ;
}
2018-08-27 20:22:53 +00:00
2018-08-08 06:27:14 +00:00
if ( output . errors ) {
2018-08-27 20:22:53 +00:00
for ( let i = 0 ; i < output . errors . length ; i ++ ) {
2018-08-08 06:27:14 +00:00
if ( output . errors [ i ] . type === 'Warning' ) {
2018-08-27 20:22:53 +00:00
self . logger . warn ( output . errors [ i ] . formattedMessage ) ;
2018-08-08 06:27:14 +00:00
}
if ( output . errors [ i ] . type === 'Error' || output . errors [ i ] . severity === 'error' ) {
return callback ( new Error ( "Solidity errors: " + output . errors [ i ] . formattedMessage ) . message ) ;
}
}
}
2018-08-27 20:22:53 +00:00
self . events . emit ( 'contracts:compiled:solc' , output ) ;
2018-08-08 06:27:14 +00:00
callback ( null , output ) ;
} ) ;
}
2018-10-01 05:11:38 +00:00
compile _solidity _code ( codeInputs , originalFilepaths , returnAllErrors , options = { } , cb ) {
2018-08-07 04:28:26 +00:00
const self = this ;
2018-04-17 21:51:36 +00:00
2017-12-16 20:39:30 +00:00
async . waterfall ( [
function loadCompiler ( callback ) {
2018-05-18 17:41:25 +00:00
if ( self . solcAlreadyLoaded ) {
2017-12-16 20:39:30 +00:00
return callback ( ) ;
}
Process logs API refactor
There are three separate instances of process log APIs: embark logs, blockchain logs (when in standalone mode), and child process logs (storage, communication, blockchain, etc). Each one was repeating the implementation of creating a process log API endpoint. This commit centralises the API declaration by using the class `ProcessLogsApi`.
`ProcessLogsApi` is started for all three components mentioned above: blockchain (in standalone) in the `BlockchainListener` module, embark in the `EmbarkListener` module, and for all child processes in the `ProcessLauncher`.
These listeners have two functions:
1. Create the process logs API endpoints for `get` and `ws`, and
2. Ensure that all logs are logged through the `LogHandler`, which normalises the output of the log and ensures each log has a timestamp and id (used in the cockpit for log ordering).
Also, this commit moved the pipeline in to a module, so that the `embark` object could be passed to the `ProcessLogsApi` (to be used for registering API endpoints).
2018-10-24 05:54:09 +00:00
self . solcW = new SolcW ( self . embark , { logger : self . logger , events : self . events , ipc : self . ipc , useDashboard : self . useDashboard } ) ;
2017-12-16 20:39:30 +00:00
2018-05-08 21:49:46 +00:00
self . logger . info ( _ _ ( "loading solc compiler" ) + ".." ) ;
2018-05-18 17:41:25 +00:00
self . solcW . load _compiler ( function ( err ) {
self . solcAlreadyLoaded = true ;
2017-12-16 20:39:30 +00:00
callback ( err ) ;
} ) ;
} ,
function compileContracts ( callback ) {
2018-05-08 21:49:46 +00:00
self . logger . info ( _ _ ( "compiling solidity contracts" ) + "..." ) ;
2018-08-13 11:44:42 +00:00
let jsonObj = {
2018-01-27 20:07:48 +00:00
language : 'Solidity' ,
2018-08-07 04:28:26 +00:00
sources : codeInputs ,
2018-01-27 20:07:48 +00:00
settings : {
optimizer : {
2018-08-30 17:27:18 +00:00
enabled : ( ! options . disableOptimizations && self . options . optimize ) ,
2018-08-20 13:27:23 +00:00
runs : self . options [ "optimize-runs" ]
2018-01-27 20:07:48 +00:00
} ,
outputSelection : {
'*' : {
2018-10-12 22:22:17 +00:00
'' : [ 'ast' , 'legacyAST' ] , // legacyAST is needed by the debugger, for now
2018-08-07 19:26:39 +00:00
'*' : [
'abi' ,
'devdoc' ,
'evm.bytecode' ,
'evm.deployedBytecode' ,
'evm.gasEstimates' ,
'evm.legacyAssembly' ,
'evm.methodIdentifiers' ,
'metadata' ,
'userdoc'
]
2018-01-27 20:07:48 +00:00
}
}
}
} ;
2018-08-27 20:22:53 +00:00
self . _compile ( jsonObj , returnAllErrors , callback ) ;
2017-12-16 20:39:30 +00:00
} ,
function createCompiledObject ( output , callback ) {
let json = output . contracts ;
2018-01-17 20:09:19 +00:00
if ( ! output || ! output . contracts ) {
2018-05-08 21:49:46 +00:00
return callback ( new Error ( _ _ ( "error compiling for unknown reasons" ) ) ) ;
2018-01-17 20:09:19 +00:00
}
2018-08-28 13:52:00 +00:00
if ( Object . keys ( output . contracts ) . length === 0 && output . sourceList && output . sourceList . length > 0 ) {
2018-05-08 21:49:46 +00:00
return callback ( new Error ( _ _ ( "error compiling. There are sources available but no code could be compiled, likely due to fatal errors in the solidity code" ) ) . message ) ;
2017-12-27 18:07:13 +00:00
}
2017-12-16 20:39:30 +00:00
let compiled _object = { } ;
2018-01-27 20:07:48 +00:00
for ( let contractFile in json ) {
for ( let contractName in json [ contractFile ] ) {
let contract = json [ contractFile ] [ contractName ] ;
const className = contractName ;
2018-08-24 11:08:05 +00:00
let filename = contractFile ;
2018-01-27 20:07:48 +00:00
compiled _object [ className ] = { } ;
compiled _object [ className ] . code = contract . evm . bytecode . object ;
compiled _object [ className ] . runtimeBytecode = contract . evm . deployedBytecode . object ;
compiled _object [ className ] . realRuntimeBytecode = contract . evm . deployedBytecode . object . slice ( 0 , - 68 ) ;
compiled _object [ className ] . swarmHash = contract . evm . deployedBytecode . object . slice ( - 68 ) . slice ( 0 , 64 ) ;
compiled _object [ className ] . gasEstimates = contract . evm . gasEstimates ;
compiled _object [ className ] . functionHashes = contract . evm . methodIdentifiers ;
compiled _object [ className ] . abiDefinition = contract . abi ;
compiled _object [ className ] . filename = filename ;
2018-08-07 04:28:26 +00:00
compiled _object [ className ] . originalFilename = originalFilepaths [ filename ] ;
2018-01-27 20:07:48 +00:00
}
2017-12-16 20:39:30 +00:00
}
callback ( null , compiled _object ) ;
}
] , function ( err , result ) {
cb ( err , result ) ;
} ) ;
}
2018-10-01 05:11:38 +00:00
compile _solidity ( contractFiles , options , cb ) {
2018-08-07 04:28:26 +00:00
if ( ! contractFiles . length ) {
return cb ( ) ;
}
let self = this ;
let input = { } ;
let originalFilepath = { } ;
async . waterfall ( [
function prepareInput ( callback ) {
async . each ( contractFiles ,
2018-08-13 11:44:42 +00:00
function ( file , fileCb ) {
2018-08-07 04:28:26 +00:00
let filename = file . filename ;
for ( let directory of self . contractDirectories ) {
let match = new RegExp ( "^" + directory ) ;
filename = filename . replace ( match , '' ) ;
}
originalFilepath [ filename ] = file . filename ;
2018-08-13 11:44:42 +00:00
file . content ( function ( fileContent ) {
2018-08-07 04:28:26 +00:00
if ( ! fileContent ) {
self . logger . error ( _ _ ( 'Error while loading the content of ' ) + filename ) ;
return fileCb ( ) ;
}
input [ filename ] = { content : fileContent . replace ( /\r\n/g , '\n' ) } ;
fileCb ( ) ;
} ) ;
} ,
function ( err ) {
callback ( err ) ;
}
) ;
} ,
function compile ( callback ) {
2018-10-01 05:11:38 +00:00
self . compile _solidity _code ( input , originalFilepath , false , options , callback ) ;
2018-08-07 04:28:26 +00:00
}
] , function ( err , result ) {
cb ( err , result ) ;
} ) ;
}
2017-12-16 20:39:30 +00:00
}
module . exports = Solidity ;