https://github.com/NomicFoundation/truffle-flattener

Truffle Flattener concats solidity files from Truffle and Buidler projects with all of their dependencies
https://github.com/NomicFoundation/truffle-flattener

buidler ethereum smart-contracts solidity truffle

Last synced: 5 days ago
JSON representation

Truffle Flattener concats solidity files from Truffle and Buidler projects with all of their dependencies

• Host: GitHub
• URL: https://github.com/NomicFoundation/truffle-flattener
• Owner: NomicFoundation
• License: mit
• Created: 2017-10-25T20:25:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-13T05:34:47.000Z (12 months ago)
• Last Synced: 2024-06-18T12:41:31.148Z (18 days ago)
• Topics: buidler, ethereum, smart-contracts, solidity, truffle
• Language: JavaScript
• Homepage:
• Size: 333 KB
• Stars: 374
• Watchers: 11
• Forks: 98
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - truffle-flattener

README

        
# truffle-flattener

[![npm](https://img.shields.io/npm/v/truffle-flattener.svg)](https://www.npmjs.com/package/truffle-flattener)

Truffle Flattener concats solidity files from Truffle and Buidler projects 

with all of their dependencies.

This tool helps you to verify contracts developed with Truffle and Buidler 

on [Etherscan](https://etherscan.io), or debugging them on

[Remix](https://remix.ethereum.org), by merging your files and their

dependencies in the right order.

If you are still using Truffle, we recommend you try [Buidler](https://github.com/nomiclabs/buidler), 

our Ethereum development environment, which is much faster and flexible.

# Hardhat support

If you are using Hardhat, you don't need this project. Use `npx hardhat flatten` instead.

## Installation

`npm install truffle-flattener -g`

## Usage

Just install it with npm in your truffle project and run

`truffle-flattener `.

## Limitations

Aliased imports (eg: `import {symbol1 as alias, symbol2} from "filename";`) are

not supported by `truffle-flattener`.