Nessuna descrizione

Francisco Giordano 0a25c1940c 4.8.3 2 anni fa
.changeset 7bdd255a05 Update changelog 2 anni fa
.github ab9cc4c4db Ignore reentrancy in`executeBatch` and update Slither config (#3955) 2 anni fa
audit faf5820f03 Fix many spelling errors (#3274) 3 anni fa
certora 24fc709533 Set up codespell (#3643) 3 anni fa
contracts 0a25c1940c 4.8.3 2 anni fa
docs 82d47ca7b3 Add Subgraphs to docs sidebar 2 anni fa
hardhat 089f9b95af Ignore specific warnings and make the rest into errors (#3695) 3 anni fa
lib 9eee01c5a2 Bump and pin Forge Std submodule (#4102) 2 anni fa
scripts 53eb531255 Improve some NatSpec (#3809) 2 anni fa
test ea595f5960 Merge pull request from GHSA-93hq-5wgc-jc82 2 anni fa
.codecov.yml 93bc3b657b Remove Codecov Patch status outside PRs 3 anni fa
.editorconfig d3ff81b37f Remove line length configuration for markdown files 3 anni fa
.eslintrc 0d91b620b7 Report changes to contract construction cost in CI (#3579) 3 anni fa
.gitattributes ad5edd329f feat: add solidity syntax highlighting directive, fixes #671 7 anni fa
.gitignore 915ca181ba Add Certora's Governance verification rules (#2997) 3 anni fa
.gitmodules 9eee01c5a2 Bump and pin Forge Std submodule (#4102) 2 anni fa
.mocharc.js 8bcf0ad7ab Use Hardhat recommended Mocha configuration (#2805) 4 anni fa
.prettierrc ca755ce799 Add AddressToUintMap (#3150) 3 anni fa
.solcover.js 85f50d3e06 Update lockfile (#2412) 4 anni fa
.solhint.json 2d1e82c901 remove duplicated 'private-vars-leading-underscore' solhint rule (#2800) 4 anni fa
CHANGELOG.md 0a25c1940c 4.8.3 2 anni fa
CODE_OF_CONDUCT.md 4575a240f7 Create CODE_OF_CONDUCT.md (#1061) 7 anni fa
CONTRIBUTING.md 15d5174139 Fix minor typo in CONTRIBUTING.md. (#3284) 3 anni fa
DOCUMENTATION.md aaa5ef81cf Fix typos (#2343) 5 anni fa
GUIDELINES.md 0500c9e53e Use "OpenZeppelin Contracts" where appropriate (#2778) 4 anni fa
LICENSE 21c5d623d6 Update Copyright notice and include contributors 3 anni fa
README.md 48dd186870 Improve readme style (#3577) 3 anni fa
RELEASING.md 0500c9e53e Use "OpenZeppelin Contracts" where appropriate (#2778) 4 anni fa
SECURITY.md c739d1976b Update security email domain and Immunefi text 3 anni fa
hardhat.config.js 50501a751e Update docs pipeline to solidity-docgen@0.6 (#3707) 3 anni fa
logo.svg d1f336d8fd use svg logo for better scaling 5 anni fa
netlify.toml b56e00eb61 Fix documentation previews in pull requests (#2015) 5 anni fa
package-lock.json 0a25c1940c 4.8.3 2 anni fa
package.json 0a25c1940c 4.8.3 2 anni fa
renovate.json 0c27ecc536 configure renovate using openzeppelin shareable config 5 anni fa
slither.config.json ab9cc4c4db Ignore reentrancy in`executeBatch` and update Slither config (#3955) 2 anni fa

README.md

OpenZeppelin

Docs NPM Package Coverage Status gitpoap badge

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

:mage: Not sure how to get started? Check out Contracts Wizard — an interactive smart contract generator.

:building_construction: Want to scale your decentralized application? Check out OpenZeppelin Defender — a secure platform for automating and monitoring your operations.

Overview

Installation

$ npm install @openzeppelin/contracts

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

An alternative to npm is to use the GitHub repository (openzeppelin/openzeppelin-contracts) to retrieve the contracts. When doing this, make sure to specify the tag for a release such as v4.5.0, instead of using the master branch.

Usage

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

pragma solidity ^0.8.0;

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

contract MyCollectible is ERC721 {
    constructor() ERC721("MyCollectible", "MCO") {
    }
}

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 documentation site 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 that 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 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.

We have a bug bounty program on Immunefi. Please report any security issues you find through the Immunefi dashboard, or reach out to security@openzeppelin.com.

Critical bug fixes will be backported to past major releases.

Contribute

OpenZeppelin Contracts 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 Contracts is released under the MIT License.