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.
64 lines
3.3 KiB
64 lines
3.3 KiB
# OpenZeppelin Solidity
|
|
[](https://www.npmjs.org/package/openzeppelin-solidity)
|
|
[](https://travis-ci.org/OpenZeppelin/openzeppelin-solidity)
|
|
[](https://coveralls.io/github/OpenZeppelin/openzeppelin-solidity?branch=master)
|
|
|
|
OpenZeppelin is a library for writing secure [Smart Contracts](https://en.wikipedia.org/wiki/Smart_contract) on Ethereum.
|
|
|
|
With OpenZeppelin, you can build distributed applications, protocols and organizations:
|
|
- using common contract security patterns (See [Onward with Ethereum Smart Contract Security](https://medium.com/bitcorps-blog/onward-with-ethereum-smart-contract-security-97a827e47702#.y3kvdetbz))
|
|
- in the [Solidity language](https://solidity.readthedocs.io/en/develop/).
|
|
|
|
> NOTE: New to smart contract development? Check our [introductory guide](https://medium.com/zeppelin-blog/the-hitchhikers-guide-to-smart-contracts-in-ethereum-848f08001f05#.cox40d2ut).
|
|
|
|
## Getting Started
|
|
|
|
OpenZeppelin integrates with [Truffle](https://github.com/ConsenSys/truffle), an Ethereum development environment. Please install Truffle and initialize your project with `truffle init`.
|
|
|
|
```sh
|
|
npm install -g truffle
|
|
mkdir myproject && cd myproject
|
|
truffle init
|
|
```
|
|
|
|
To install the OpenZeppelin library, run the following in your Solidity project root directory:
|
|
```sh
|
|
npm init -y
|
|
npm install -E openzeppelin-solidity
|
|
```
|
|
|
|
**Note that OpenZeppelin does not currently follow semantic versioning.** You may encounter breaking changes upon a minor version bump. We recommend pinning the version of OpenZeppelin you use, as done by the `-E` (`--save-exact`) option.
|
|
|
|
After that, you'll get all the library's contracts in the `node_modules/openzeppelin-solidity/contracts` folder. You can use the contracts in the library like so:
|
|
|
|
```solidity
|
|
import 'openzeppelin-solidity/contracts/ownership/Ownable.sol';
|
|
|
|
contract MyContract is Ownable {
|
|
...
|
|
}
|
|
```
|
|
|
|
|
|
## Security
|
|
OpenZeppelin 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](mailto:security@openzeppelin.org).
|
|
|
|
## Developer Resources
|
|
|
|
Building a distributed application, protocol or organization with OpenZeppelin?
|
|
|
|
- Read documentation: https://openzeppelin.org/api/docs/open-zeppelin.html
|
|
|
|
- Ask for help and follow progress at: https://slack.openzeppelin.org/
|
|
|
|
Interested in contributing to OpenZeppelin?
|
|
|
|
- Framework proposal and roadmap: https://medium.com/zeppelin-blog/zeppelin-framework-proposal-and-development-roadmap-fdfa9a3a32ab#.iain47pak
|
|
- Issue tracker: https://github.com/OpenZeppelin/openzeppelin-solidity/issues
|
|
- Contribution guidelines: https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/CONTRIBUTING.md
|
|
- Wiki: https://github.com/OpenZeppelin/openzeppelin-solidity/wiki
|
|
|
|
## License
|
|
Code released under the [MIT License](https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/LICENSE).
|
|
|