https://github.com/OpenZeppelin/openzeppelin-sdk
OpenZeppelin SDK repository for CLI and upgrades.js. No longer actively developed.
https://github.com/OpenZeppelin/openzeppelin-sdk
Last synced: 9 months ago
JSON representation
OpenZeppelin SDK repository for CLI and upgrades.js. No longer actively developed.
- Host: GitHub
- URL: https://github.com/OpenZeppelin/openzeppelin-sdk
- Owner: OpenZeppelin
- License: mit
- Archived: true
- Created: 2018-08-01T18:53:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-23T22:30:11.000Z (over 4 years ago)
- Last Synced: 2024-11-13T02:04:22.927Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 17.5 MB
- Stars: 431
- Watchers: 37
- Forks: 201
- Open Issues: 267
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-block - openzepplin sdk
- awesome-blockchain - openzepplin sdk
- awesome-blockchain - openzepplin sdk
README
> OpenZeppelin SDK is not being actively developed. We recommend using [Upgrades Plugins](https://docs.openzeppelin.com/upgrades-plugins/1.x/) instead.
>
> For more information, see [Building for interoperability: why we’re focusing on Upgrades Plugins](https://forum.openzeppelin.com/t/building-for-interoperability-why-we-re-focusing-on-upgrades-plugins/4088).
# OpenZeppelin SDK
[](https://github.com/RichardLitt/standard-readme)
[](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master)
[](https://lernajs.io/)
> Formerly known as ZeppelinOS
OpenZeppelin is a platform to develop, deploy and operate smart contract
projects on Ethereum and every other EVM and eWASM-powered blockchain.
This repository includes the OpenZeppelin
[Command-Line Interface](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/cli#readme) and
[Upgrades Library](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/lib#readme).
## Install
First, install [Node.js](http://nodejs.org/) and [npm](https://npmjs.com/).
Then, install the OpenZeppelin SDK running:
```sh
npm install --global @openzeppelin/cli
```
> If you get an `EACCESS permission denied` error while installing, please refer to the [npm documentation on global installs permission errors](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally). Alternatively, you may run `sudo npm install --unsafe-perm --global @openzeppelin/cli`, but this is highly discouraged, and you should rather either use a node version manager or manually change npm's default directory.
## Usage
We recommend to use the OpenZeppelin SDK through the `openzeppelin sdk` command-line interface.
To start, create a directory for the project and access it:
```sh
mkdir my-project
cd my-project
```
Use `npm` to create a `package.json` file:
```sh
npm init
```
And initialize the OpenZeppelin SDK project:
```sh
openzeppelin init my-project
```
Now it is possible to use `openzeppelin deploy` to create instances for these contracts that
later can be upgraded, and many more things.
Run `openzeppelin --help` for more details about thes and all the other functions of the
OpenZeppelin CLI.
The
[OpenZeppelin SDK documentation](https://docs.openzeppelin.com/cli/)
explains how to build a project using our platform, how to upgrade contracts,
how to share packages for other projects to reuse, how to vouch for the quality
of a package, how to use the JavaScript libraries to operate the project, and
it explains details of the platform and some advanced topics.
## Security
If you find a security issue, please contact us at security@openzeppelin.com. We
give rewards for reported issues, according to impact and severity.
## Maintainers
* [@spalladino](https://github.com/spalladino)
* [@jcarpanelli](https://github.com/jcarpanelli)
* [@ylv-io](https://github.com/ylv-io)
## Community
Join our [Community Forum](https://forum.openzeppelin.com) or
[community channel on Telegram](https://t.me/zeppelinos), where you can talk to
all the OpenZeppelin developers, contributors, partners, and users.
You can also follow the recent developments of the project in the OpenZeppelin [blog](https://blog.openzeppelin.com/) and
[Twitter account](https://twitter.com/openzeppelin).
## Contributing
To set up a local development environment for contributing, clone the repository and run `yarn` in the root of the project.
Please refer to the [contributing guide](CONTRIBUTING.md) for more details on how to contribute.
## License
[MIT](LICENSE) © OpenZeppelin