@openzeppelin/contracts-ethereum-package

    3.0.0 • Public • Published

    OpenZeppelin

    OpenZeppelin Contracts Ethereum Package

    NPM Package Build Status

    OpenZeppelin Contracts is a library for secure smart contract development. It provides implementations of standards like ERC20 and ERC721 which you can deploy as-is or extend to suit your needs, as well as Solidity components to build custom contracts and more complex decentralized systems.

    This fork of OpenZeppelin is set up as a reusable Ethereum Package. It is deployed to the kovan, rinkeby, and ropsten test networks, as well as to the main Ethereum network. You can reuse any of the pre-deployed on-chain contracts by simply linking to them using the OpenZeppelin SDK, or reuse their Solidity source code as with the vanilla version of OpenZeppelin Contracts.

    Differences with openzeppelin-contracts

    This package contains the same contracts as the vanilla openzeppelin-contracts, but modified to be safe for upgrades. The main difference is that all contracts in this package are potentially upgradeable: you will notice that no contracts have constructors defined, but use initializer functions instead. Also, this package is set up as an Ethereum package, and provides a small set of pre-deployed logic contracts that can be used directly via the OpenZeppelin SDK, without needing to deploy them again.

    All contracts have an UpgradeSafe suffix to avoid confusion with their counterparts in OpenZeppelin Contracts. For example, ERC20 becomes ERC20UpgradeSafe.

    All in all, you should use this package instead of openzeppelin-solidity if you are managing your project via the OpenZeppelin CLI.

    Install

    npm install @openzeppelin/contracts-ethereum-package
    

    Deployed logic contracts

    Using via the OpenZeppelin CLI

    You can easily create upgradeable instances of any of the logic contracts listed above using the OpenZeppelin CLI. This will rely on the pre-deployed instances in mainnet, kovan, ropsten, or rinkeby, greatly reducing your gas deployment costs. To do this, just create a new OpenZeppelin SDK project and link to this package.

    $ npm install -g @openzeppelin/cli
    $ openzeppelin init
    $ openzeppelin link @openzeppelin/contracts-ethereum-package
    > Installing...
    $ openzeppelin deploy @openzeppelin/contracts-ethereum-package/ERC20PresetMinterPauserUpgradeSafe
    > Creating...

    To create an instance of a contract, use the openzeppelin create command. As an example, you can run the following to create an upgradeable ERC20 named MyToken, with symbol TKN and 8 decimals, and an initial supply of 100 tokens assigned to the address HOLDER, with a MINTER and a PAUSER. Remember to replace $HOLDER, $MINTER, and $PAUSER with actual addresses when you run this command; you can specify more than one (or none at all) minters and pausers.

    $ openzeppelin create
    ? Pick a contract to instantiate: @openzeppelin/contracts-ethereum-package/ERC20PresetMinterPauserUpgradeSafe
    ? Pick a network: development
    ✓ Deploying @openzeppelin/contracts-ethereum-package dependency to network
    ? Do you want to call a function on the instance after creating it?: Yes
    ? Select which function: * initialize(name: string, symbol: string)
    ? name (string): MyToken
    ? symbol (string): MYT
    ✓ Setting everything up to create contract instances
    ✓ Instance created at 0x2612Af3A521c2df9EAF28422Ca335b04AdF3ac66
    

    OpenZeppelin will create an upgradeable ERC20 instance and keep track of its address in the .openzeppelin/rinkeby.json file. Should you update your version of the openzeppelin contracts ethereum package later down the road, you can simply run openzeppelin update to upgrade all your ERC20 instances to the latest version.

    You can also deploy a ERC721 token by choosing the ERC721PresetMinterPauserAutoIdUpgradeSafe contract when running openzeppelin create. Refer to the initialize function of each of the predeployed logic contracts to see which parameters are required for initialization.

    Extending contracts

    If you prefer to write your custom contracts, import the ones from this package and extend them through inheritance. Note that you must use this package and not @openzeppelin/contracts if you are writing upgradeable contracts.

    pragma solidity ^0.5.0;
     
    import '@openzeppelin/contracts-ethereum-package/contracts/Initializable.sol';
    import '@openzeppelin/contracts-ethereum-package/contracts/presets/ERC721PresetMinterPauserAutoId.sol';
     
    contract MyNFT is Initializable, ERC721PresetMinterPauserAutoId {
      function initialize() public initializer {
        ERC721PresetMinterPauserAutoId.initialize("name", "SYM");
      }
    }

    On our site you will find a few guides to learn about the different parts of OpenZeppelin, as well as documentation for the API. Keep in mind that the API docs are work in progress, and don’t hesitate to ask questions in our forum.

    Security

    OpenZeppelin Contracts is maintained by OpenZeppelin the company, and developed following our high standards for code quality and security. OpenZeppelin Contracts 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 Contracts 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.

    Install

    npm i @openzeppelin/contracts-ethereum-package

    DownloadsWeekly Downloads

    1,575

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    6.85 MB

    Total Files

    137

    Last publish

    Collaborators

    • spalladino
    • frangio