solidity-flattener - GitLite

KO | EN

gitlite — search

#javascript #react #android #rust #nodejs #macos #windows #cli #awesome-list #vue #security #pytorch #ios #open-source

solidity-flattener

(★ 333)

Utility to combine Solidity project to a flat file

File Explorer

Download Latest Version (.zip)

- - config.yml
- - BallotsManager.sol
  - KeysManager.sol
  - Oracles.sol
  - owned.sol
  - ValidatorsManager.sol
- change-relative-path-to-absolute.js
- clean-path.js
- constants.js
- deduplicate-lines.js
- find-all-import-paths.js
- find-file.js
- logger.js
- replace-all-imports-in-current-layer.js
- replace-all-imports-recursively.js
- update-import-object-location-in-target.js
- variables.js
- - dep.sol
  - dep2.sol
  - test.sol
  - testMock1.sol
- - change-relative-path-to-absolute.js
  - clean-path.js
- index.js
.eslintrc.json
.gitignore
.travis.yml
config.json
index.js
LICENSE.md
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

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

Downloads the entire project code from GitHub to your computer.

cd solidity-flattener

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start "path_to_not_flat_contract_definition_file.sol"

Starts the development/run server.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Solidity smart-contract flattened source file generation

[![Build Status](https://travis-ci.org/poanetwork/solidity-flattener.svg?branch=master)](https://travis-ci.org/poanetwork/solidity-flattener)
[![Known Vulnerabilities](https://snyk.io/test/github/poanetwork/solidity-flattener/badge.svg)](https://snyk.io/test/github/poanetwork/solidity-flattener)
[![Coverage Status](https://coveralls.io/repos/github/poanetwork/solidity-flattener/badge.svg?branch=master)](https://coveralls.io/github/poanetwork/solidity-flattener?branch=master)

## 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"
}
```