poanetwork/solidity-flattener

Utility to combine Solidity project to a flat file

Solidity smart-contract flattened source file generation

Utility to combine all imports to one flatten .sol file

Installation from npm

npm i @poanet/solidity-flattener

Usage

./node_modules/.bin/poa-solidity-flattener ./contracts/example.sol

It will save flattened source of Solidity smart-contract into ./out directory

Installation from source

git clone https://github.com/poanetwork/solidity-flattener
cd solidity-flattener
npm install

You can start script either

npm start "path_to_not_flat_contract_definition_file.sol"

or without paramaters (path to input file will be extracted from ./config.json)

npm start

Expected result:

Success! Flat file ORIGINAL_FILE_NAME_flat.sol is generated to ./out directory

./flatContract.sol - flat .sol file is created in output directory (./out/ by default)

Note: utility doesn't support aliases at import statements

Config

path ./config.json

{
	"inputFilePath": "./demo/src/Oracles.sol",
	"outputDir": "./out"
}

solidity-flattener's Issues

4ccc21dc1ee4c018c5a4daac9f89139c26f0cef0

(Fix) rename repo and

Problem:

• repo has oracles in the name
• combine-solidity is not
  Solutions:
• remove oracles. not sure if we need to add poa- prefix

@rstormsf what do you think will be a good name?
solidity-flattener is taken

solc-flattener ?

Blank lines between classes and functions

The result file does not contains blank lines between classes and functions. That affects readability of source code. I believe there should be blank lines.

I've attached screenshot. Left side is result of sol-merger, right side is result of oracles-combine-solidity

0x79a84e29

(Fix) replace GitHub URL in README.md

Problem:
GitHub URL in README.md points to oraclesorg
Solution:
replace to poanetwork

node v18 support

Is there a chance to support 18 nodejs in a near future, please?

Bug when you have no `pragma experimental`

The output is empty because const { firstIndex, lastIndex } = getFirstPragmaExp(content) the firstIndex and lastIndex are -1 -1.

solidity-flattener/helpers/remove-duplicated-experimental-headers.js

Lines 7 to 22 in 85b7e3d

	function removeDuplicatedExpHeaders(content) {
	//1st pragma solidity declaration
	const { firstIndex, lastIndex } = getFirstPragmaExp(content)
	const contentPart = content.substr(lastIndex)
	let contentFiltered = contentPart
	//remove other pragma solidity declarations
	const regex = new RegExp(pragmaExperimentalstr,'gi')
	let result
	while ( (result = regex.exec(contentPart)) ) {
	const start = result.index
	const end = start + contentPart.substr(start).indexOf(SEMICOLON) + 1
	if (start != firstIndex) contentFiltered = contentFiltered.replace(contentPart.substring(start, end), EMPTY)
	}
	return contentFiltered
	}

Recursive search fails and hangs for ./ imports

The recursive search for imports such as import './BasicToken.sol'; fails and hangs.

For example it hangs like so after:

!!!zeppelin-solidity/contracts/token/StandardToken.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!
###zeppelin-solidity/contracts/token/StandardToken.sol SOURCE FILE FOUND###
!!!../myproject/node_modules/zeppelin-solidity/contracts/token/./BasicToken.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!

Flatten directory/find entry point

This contract has 14 files, no idea which one is the entry point:
https://etherscan.io/address/0x44c3fab0ae93ac02ae7a218c51e8a0e5e64c34df#code

please add ability to take multiple files as input, with one output.
Not sure what etherscan.io uses for this.

Issue with totalSupply()

Guys can someone help me with error i'm getting while testing ,

3 passing (5s)
1 failing

1. Contract: Color
   minting
   creates a new token:
   TypeError: contract.totalSupply is not a function

Weird behavior double contracts

Steps:

https://github.com/rstormsf/oracles-presale/tree/removeWhitelist - git clone this branch
run npm start contracts/PresaleOracles.sol

get generated file:
https://gist.github.com/rstormsf/d5f14b4280fe956f95df66582d78a461

Notice a few issues:

1. Double BasicToken
2. Double Safemath
3. Double PresaleOracles

Critical:
I don't understand where BasicToken comes from with safeSub code.
Example:
https://gist.github.com/rstormsf/d5f14b4280fe956f95df66582d78a461#file-presaleoracles_flat-sol-L197

It should only have this BasicToken contract:
https://gist.github.com/rstormsf/d5f14b4280fe956f95df66582d78a461#file-presaleoracles_flat-sol-L90

Everything below line 187 should be removed:
https://gist.github.com/rstormsf/d5f14b4280fe956f95df66582d78a461#file-presaleoracles_flat-sol-L187

Another question: Where does it get wrong BasicToken with old usage of old SafeMath lib?

Uncertainty of pragma compiler directive

Result file contains only one pragma compiler version that was chosen with some algorithm.
If input files contain different pragma compiler versions then it could makes sense to display warning about that.

contracts under openzeppelin are not included

used poa-solidity-flattener to flatten my contract to upload to etherscan. xxx_flat.sol was generated successfully but we have some @OpenZeppelin dependencies, like IERC20, Context... were not be included in the final xxx_falt.sol. Not sure what happened. Here are some messages saying those files are not found in the beginning, but found later. But they are not included in the output file.

{"name":"solidity-flattener","hostname":"kimiwude-mbp.lan","pid":96101,"level":40,"msg":"!!! @openzeppelin/contracts-ethereum-package/contracts/math/SignedSafeMath.sol SOURCE FILE WAS NOT FOUND. I'M TRYING TO FIND IT RECURSIVELY !!!","time":"2020-10-26T07:47:54.428Z","v":0}
{"name":"solidity-flattener","hostname":"kimiwude-mbp.lan","pid":96101,"level":30,"msg":"@openzeppelin/contracts-ethereum-package/contracts/math/SignedSafeMath.sol SOURCE FILE WAS FOUND","time":"2020-10-26T07:47:54.439Z","v":0}
...
{"name":"solidity-flattener","hostname":"kimiwude-mbp.lan","pid":95092,"level":40,"msg":"!!! @openzeppelin/contracts/token/ERC20/IERC20.sol SOURCE FILE WAS NOT FOUND. I'M TRYING TO FIND IT RECURSIVELY !!!","time":"2020-10-26T07:32:36.865Z","v":0}
{"name":"solidity-flattener","hostname":"kimiwude-mbp.lan","pid":95092,"level":30,"msg":"@openzeppelin/contracts/token/ERC20/IERC20.sol SOURCE FILE WAS FOUND","time":"2020-10-26T07:32:36.875Z","v":0}

poa-solidity-flattener version: 3.0.6
build environment: buidler

File outside of allowed directories

Getting this error:

Error: Source "util/Ownable.sol" not found: File outside of allowed directories.
import "../util/Ownable.sol";

Usually can be solved with solc using:

--allow-paths `pwd`/util

But how about your tool?

there is issue with the commit: "change-relative-path-to-absolute helper"

After i reverted the change, the lib works.
It stops when try to find "../math/SafeMath.sol".

Error message is:

!!!zeppelin-solidity/contracts/crowdsale/Crowdsale.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!
###zeppelin-solidity/contracts/crowdsale/Crowdsale.sol SOURCE FILE FOUND###
!!!zeppelin-solidity/contracts/token/MintableToken.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!
###zeppelin-solidity/contracts/token/MintableToken.sol SOURCE FILE FOUND###
###./Token.sol SOURCE FILE FOUND###
!!!../math/SafeMath.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!

Wrong order again

Still doesn't work:

https://github.com/rstormsf/ico_per_week/blob/002_whitelisted/contracts/BlockchainLabsCrowdsale.sol

try to look at:
https://github.com/BlockCatIO/solidity-flattener

Can unflatten also be supported?

Can unflatten also be supported?

Error: Cannot find module 'glob'

I'm getting the following:

module.js:557
    throw err;
    ^

Error: Cannot find module 'glob'
    at Function.Module._resolveFilename (module.js:555:15)
    at Function.Module._load (module.js:482:25)
    at Module.require (module.js:604:17)
    at require (internal/module.js:11:18)
    at Object.<anonymous> (/Users/glaksmono/Documents/solidity-flattener/index.js:3:14)
    at Module._compile (module.js:660:30)
    at Object.Module._extensions..js (module.js:671:10)
    at Module.load (module.js:573:32)
    at tryModuleLoad (module.js:513:12)
    at Function.Module._load (module.js:505:3)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `node index.js "../LYKECOIN/contracts/LykeCoinCrowdsale.sol"`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm WARN Local package.json exists, but node_modules missing, did you mean to install?

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/glaksmono/.npm/_logs/2018-02-19T14_01_14_587Z-debug.log

provide binary for your package

"bin": {
  "oracles-combine-solidity": "index.js"
}

something like that
http://blog.npmjs.org/post/118810260230/building-a-simple-command-line-tool-with-npm

so I can do the following:

npm i oraclesorg/oracles-combine-solidity --save-dev
./node_modules/.bin/oracles-combine-solidity "path_to_not_flat_contract_definition_file.sol"

Flattener hangs due to css import rule

Contracts may use the css @import rule when constructing svgs, the flattener mistakes these for solidity imports and hangs due to being unable to find the file, which doesn't exist

string[0] memory parts;
parts[0] = '<svg xmlns="http://www.w3.org/2000/svg"><style>@import url("https://use.typekit.net/nln0qsp.css");</style></svg>';

Publish to NPM

Hey thanks for working on this.

Is there any reason this isn't published to npm?

Not combining all scripts at windows

Hi,
i tested oracles-combine-solidity with my smart contracts and smart contracts that were published on github for educational purposes - and used in youtube tutorial (https://www.youtube.com/watch?v=ShW2zQcY4LY) .

Issue is that when i run npm start path_to_sol_file i get this otuput:

[email protected] start C:\oracles-combine-solidity

node index.js "C:\emx\contracts\emxCrowdSale.sol"

!!!zeppelin-solidity/contracts/crowdsale/Crowdsale.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!
###zeppelin-solidity/contracts/crowdsale/Crowdsale.sol SOURCE FILE FOUND###
!!!zeppelin-solidity/contracts/token/MintableToken.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!
###zeppelin-solidity/contracts/token/MintableToken.sol SOURCE FILE FOUND###
###./emrToken.sol SOURCE FILE FOUND###
!!!zeppelin-solidity/contracts/token/MintableToken.sol SOURCE FILE NOT FOUND. TRY TO FIND IT RECURSIVELY!!!
###zeppelin-solidity/contracts/token/MintableToken.sol SOURCE FILE FOUND###
Success! Flat file is generated to ./out directory

but in output file there are only functions/contracts that i created (or the ones from test project that i mentioned above) and not any other like MintableToken etc. What could i do?

My npm details:

npm version
{ 'oracles-combine-solidity': '1.0.0',
npm: '5.4.2',
ares: '1.10.1-DEV',
cldr: '31.0.1',
http_parser: '2.7.0',
icu: '59.1',
modules: '57',
nghttp2: '1.25.0',
node: '8.5.0',
openssl: '1.0.2l',
tz: '2017b',
unicode: '9.0',
uv: '1.14.1',
v8: '6.0.287.53',
zlib: '1.2.11' }

best regards,
Tadej

Remove duplicate license items

To elimiate errors like this:

ParserError: Multiple SPDX license identifiers found in source file. Use “AND” or “OR” to combine multiple licenses. Please see https://spdx.org for more information.

Import from node_modules

It doesn't work for imports like:

import "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol";

Allow functionality to be used in node.js directly.

Hi,

I have a project that wants to use this library directly from within nodejs. I'd like to import the functions in .e.g. the index.js file. Hence, these functions should be exported. Right now, I'm using the provided binary. It's really messy though: https://github.com/0xdefaceme/etherscan-uploader/blob/master/index.js#L41

If I have time today, I'll send a PR.

issue on node 14.0.0

error [email protected]: The engine "node" is incompatible with this module. Expected version "^12". Got "14.0.0"

Contracts placed in wrong order

Sometimes Iterface/Parent contracts are placed after the inheritant contract, will lead to the following error:

Error: Identifier not found or not unique.
  --> out/SignedRequest_flat.sol:18:27:
   |
18 | contract SecurityStore is DataStore
   |                           ^^^^^^^^^

Doesn't work

@vbaranov
https://github.com/AigangNetwork/aigang-crowdsale-contracts/blob/master/contracts/PreSale.sol - try to npm start it

Wrong order

myc:32:24: TypeError: Definition of base has to precede definition of derived contract
contract BasicToken is ERC20Basic {
                       ^--------^

when I tried to combine some token contract it didn't give me the correct order.