This repository has been archived by the owner. It is now read-only.
Zeppelin, a framework to build secure smart contracts on Ethereum
Clone or download
Pull request Compare This branch is 4 commits ahead, 1062 commits behind OpenZeppelin:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
contracts
docs
migrations
scripts
test
.babelrc
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
package.json
truffle.js

README.md

Zeppelin Solidity

NPM Package Build Status

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

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

NOTE: New to smart contract development? Check our introductory guide.

Getting Started

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

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/Ownable.sol";

contract MyContract is Ownable {
  ...
}

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/Ownable.sol";

contract MyContract is Ownable {
  ...
}

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 and any security problem you might experience.

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

Developer Resources

Building a distributed application, protocol or organization with Zeppelin?

Interested in contributing to Zeppelin?

Collaborating organizations and audits by Zeppelin

among others...

License

Code released under the MIT License.