openzeppelin-contracts

Zeppelin Solidity

Zeppelin is a library for writing secure Smart Contracts on Ethereum.

With Zeppelin, you can build distributed applications, protocols and organizations:

• using common contract security patterns (See Onward with Ethereum Smart Contract Security)
• in the Solidity language.

Getting Started

Zeppelin integrates with Truffle, an Ethereum development environment. Please install Truffle and initialize your project with truffle init.

sudo npm install -g truffle
mkdir myproject && cd myproject
truffle init

To install the Zeppelin library, run:

npm i zeppelin-solidity

After that, you'll get all the library's contracts in the contracts/zeppelin folder. You can use the contracts in the library like so:

import "./zeppelin/Rejector.sol";

contract MetaCoin is Rejector { 
  ...
}

NOTE: The current distribution channel is npm, which is not ideal. We're looking into providing a better tool for code distribution, and ideas are welcome.

Truffle Beta Support

We also support Truffle Beta npm integration. If you're using Truffle Beta, the contracts in node_modules will be enough, so feel free to delete the copies at your contracts folder. If you're using Truffle Beta, you can use Zeppelin contracts like so:

import "zeppelin-solidity/contracts/Rejector.sol";

contract MetaCoin is Rejector { 
  ...
}

For more info see the Truffle Beta package management tutorial.

Security

Zeppelin is meant to provide secure, tested and community-audited code, but please use common sense when doing anything that deals with real money! We take no responsibility for your implementation decisions.

If you find a security issue, please email security@openzeppelin.org.

Developer Resources

Building a distributed application, protocol or organization with Zeppelin?

• Ask for help and follow progress at: https://zeppelin-slackin.herokuapp.com/

Interested in contributing to Zeppelin?

• Framework proposal and roadmap: https://medium.com/zeppelin-blog/zeppelin-framework-proposal-and-development-roadmap-fdfa9a3a32ab#.iain47pak
• Issue tracker: https://github.com/OpenZeppelin/zeppelin-solidity/issues
• Contribution guidelines: https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/CONTRIBUTING.md

Projects using Zeppelin

• Blockparty

Contracts

TODO

License

Code released under the MIT License.