mirror of openzeppelin-contracts
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.
Francisco Giordano b9d72d2991 Clean up build directory when publishing 4 days ago
.circleci Migrate from truffle to test-environment (#2007) 7 months ago
.github Update support request (#2148) 3 months ago
audit Add latest audit to repository (#1664) 1 year ago
contracts Add readme notices with link to docs site (#2300) 1 week ago
docs Fix remaining preset links 1 week ago
migrations Clean up npm package (#904) 2 years ago
scripts Address ERC1155 changes (#2267) 1 month ago
test feat: add wrapper function for low level calls (#2264) 1 month ago
.codecov.yml Disable Travis in favor of Circle (#1866) 11 months ago
.editorconfig Configure line length in .editorconfig 2 months ago
.eslintrc Migrate from truffle to test-environment (#2007) 7 months ago
.gitattributes feat: add solidity syntax highlighting directive, fixes #671 2 years ago
.gitignore Fix documentation previews in pull requests (#2015) 7 months ago
.solcover.js Create2 feature pending tasks (#2013) 5 months ago
.solhint.json Adhere to naming convention (#2150) 3 months ago
CHANGELOG.md 3.1.0 2 weeks ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#1061) 2 years ago
CODE_STYLE.md Update CODE_STYLE.md (#1842) 11 months ago
CONTRIBUTING.md Fixing instructions by correcting instruction to (#1877) 11 months ago
DOCUMENTATION.md Update start docs command line (#2255) 1 month ago
GUIDELINES.md Create GUIDELINES.md from wiki content. (#1776) 1 year ago
LICENSE Update LICENSE (#2247) 1 month ago
README.md Update readme to reflect docsite, fixes #2168 1 month ago
RELEASING.md Remove ethpm.json and update releasing docs (#2205) 2 months ago
logo.png Rebrand readme (#1832) 11 months ago
netlify.toml Fix documentation previews in pull requests (#2015) 7 months ago
package-lock.json Clean up build directory when publishing 4 days ago
package.json Clean up build directory when publishing 4 days ago
renovate.json configure renovate to run weekly 1 month ago
test-environment.config.js Migrate from truffle to test-environment (#2007) 7 months ago

README.md

OpenZeppelin

Docs NPM Package Build Status Coverage Status

A library for secure smart contract development. Build on a solid foundation of community-vetted code.

Overview

Installation

$ npm install @openzeppelin/contracts

OpenZeppelin Contracts features a stable API, which means your contracts won't break unexpectedly when upgrading to a newer minor version.

Usage

Once installed, you can use the contracts in the library by importing them:

pragma solidity ^0.6.0;

import "@openzeppelin/contracts/token/ERC721/ERC721.sol";

contract MyNFT is ERC721 {
    constructor() ERC721("MyNFT", "MNFT") public {
    }
}

If you're new to smart contract development, head to Developing Smart Contracts to learn about creating a new project and compiling your contracts.

To keep your system secure, you should always use the installed code as-is, and neither copy-paste it from online sources, nor modify it yourself. The library is designed so that only the contracts and functions you use are deployed, so you don't need to worry about it needlessly increasing gas costs.

Learn More

The guides in the sidebar will teach about different concepts, and how to use the related contracts that OpenZeppelin Contracts provides:

  • Access Control: decide who can perform each of the actions on your system.
  • Tokens: create tradeable assets or collectives, and distribute them via Crowdsales.
  • Gas Station Network: let your users interact with your contracts without having to pay for gas themselves.
  • Utilities: generic useful tools, including non-overflowing math, signature verification, and trustless paying systems.

The full API is also thoroughly documented, and serves as a great reference when developing your smart contract application. You can also ask for help or follow Contracts's development in the community forum.

Finally, you may want to take a look at the guides on our blog, which cover several common use cases and good practices.. The following articles provide great background reading, though please note, some of the referenced tools have changed as the tooling in the ecosystem continues to rapidly evolve.

Security

This project is maintained by OpenZeppelin, and developed following our high standards for code quality and security. OpenZeppelin is meant to provide 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 problems you might experience.

The core development principles and strategies that OpenZeppelin is based on include: security in depth, simple and modular code, clarity-driven naming conventions, comprehensive unit testing, pre-and-post-condition sanity checks, code consistency, and regular audits.

The latest audit was done on October 2018 on version 2.0.0.

Please report any security issues you find to security@openzeppelin.org.

Contribute

OpenZeppelin exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the contribution guide!

License

OpenZeppelin is released under the MIT License.