A tool for developing smart contracts. Crafted with the finest cacaos.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
cliffoo 959016e91b
Merge pull request #5980 from trufflesuite/type-typo
3 days ago
.github github(action): disable job fail notifications 2 months ago
.husky root: add husky and lint-staged 1 year ago
packages codec: Fix typo 7 days ago
scripts CI(scripts): pin geth to v1.10.26 (#5900) 1 month ago
.eslintignore finalize rules & ignore 5 years ago
.eslintrc.json Put all BUNDLE globals in main .eslintrc.json 1 year ago
.eslintrc.package.json Expand pattern for tests in .eslintrc.json 1 year ago
.eslintrc.truffle.json feat: Add initial TS support for migrations 8 months ago
.gitattributes Include tabwidth=4 to .gitattributes 5 years ago
.gitignore ignoring potential python virtual environments 4 weeks ago
.nycrc update .nycrc 3 years ago
.prettierignore Add new line at the end of the file 5 months ago
.prettierrc.json Set quoteProps to 'consistent' in prettierrc 8 months ago
CODEOWNERS auto-request reviews from dev team on non-draft PRs 11 months ago
CONTRIBUTING.md Update CONTRIBUTING.md 10 months ago
LICENSE Update copyright holder to reflect reality 1 month ago
README.md added one comma, removed one comma 5 months ago
lerna.json Enable lerna `rejectCycles` to Truffle build (#5607) 6 months ago
package.json tweaking tests (and removing depcheck ignore) 4 weeks ago
yarn.lock Bump webpack from 5.73.0 to 5.76.0 2 weeks ago


npm npm GitHub Discussions Coverage Status gitpoap badge

Truffle is a development environment, testing framework, and asset pipeline for Ethereum, aiming to make life as an Ethereum developer easier. With Truffle you get:

  • Built-in smart contract compilation, linking, deployment and binary management.
  • Automated contract testing with Mocha and Chai.
  • Configurable build pipeline with support for custom build processes.
  • Scriptable deployment & migrations framework.
  • Network management for deploying to many public & private networks.
  • Interactive console for direct contract communication.
  • Instant rebuilding of assets during development.
  • External script runner that executes scripts within a Truffle environment.
Contributors: Please see the Development section of this README.


$ npm install -g truffle

Note: To avoid any strange permissions errors, we recommend using nvm.

Quick Usage

For a default set of contracts and tests, run the following within an empty project directory:

$ truffle init

From there, you can run truffle compile, truffle migrate and truffle test to compile your contracts, deploy those contracts to the network, and run their associated unit tests.

Truffle comes bundled with a local development blockchain server that launches automatically when you invoke the commands above. If you'd like to configure a more advanced development environment we recommend you install the blockchain server separately by running npm install -g ganache at the command line.

  • ganache: a command-line version of Truffle's blockchain server.
  • ganache-ui: A GUI for the server that displays your transaction history and chain state.


Please see the Official Truffle Documentation for guides, tips, and examples.


We welcome pull requests. To get started, just fork this repo, clone it locally, and run:

# Install
npm install -g yarn
yarn bootstrap

# Test
yarn test

# Adding dependencies to a package
cd packages/<truffle-package>
yarn add <npm-package> [--dev] # Use yarn

If you'd like to update a dependency to the same version across all packages, you might find this utility helpful.

Notes on project branches:

  • master: Stable, released version (v5)
  • beta: Released beta version
  • develop: Work targeting stable release (v5)
  • next: Not currently in use

Please make pull requests against develop.

There is a bit more information in the CONTRIBUTING.md file.