openzeppelin-contracts-upgradeable

(β˜… 1,172)

Upgradeable variant of OpenZeppelin Contracts, meant for use in upgradeable contracts.

  • .codecov.yml
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .prettierrc
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • eslint.config.mjs
  • foundry.toml
  • FUNDING.json
  • fv-requirements.txt
  • GUIDELINES.md
  • hardhat.config.ts
  • LICENSE
  • logo.svg
  • netlify.toml
  • package-lock.json
  • package.json
  • README.md
  • RELEASING.md
  • remappings.txt
  • renovate.json
  • SECURITY.md
  • slither.config.json
  • solhint.config.cjs

# Installation Guide

1. Get the code
git clone https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

Downloads the entire project code from GitHub to your computer.

cd openzeppelin-contracts-upgradeable

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
$ npm install @openzeppelin/contracts-upgradeable

Downloads and installs the libraries listed in package.json.

$ npm install @openzeppelin/contracts-upgradeable@dev

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

3. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd fv

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation