{"id":21658934,"url":"https://github.com/OpenZeppelin/openzeppelin-sdk","last_synced_at":"2025-07-17T21:32:02.381Z","repository":{"id":41086433,"uuid":"143195936","full_name":"OpenZeppelin/openzeppelin-sdk","owner":"OpenZeppelin","description":"OpenZeppelin SDK repository for CLI and upgrades.js. No longer actively developed.","archived":true,"fork":false,"pushed_at":"2022-01-23T22:30:11.000Z","size":18392,"stargazers_count":431,"open_issues_count":267,"forks_count":201,"subscribers_count":37,"default_branch":"master","last_synced_at":"2024-11-13T02:04:22.927Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenZeppelin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-01T18:53:24.000Z","updated_at":"2024-09-29T08:06:05.000Z","dependencies_parsed_at":"2022-08-10T01:42:51.168Z","dependency_job_id":null,"html_url":"https://github.com/OpenZeppelin/openzeppelin-sdk","commit_stats":null,"previous_names":["zeppelinos/zos"],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenZeppelin","download_url":"https://codeload.github.com/OpenZeppelin/openzeppelin-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226077476,"owners_count":17570164,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T09:30:04.711Z","updated_at":"2024-11-25T09:30:28.099Z","avatar_url":"https://github.com/OpenZeppelin.png","language":"JavaScript","readme":"\u003e OpenZeppelin SDK is not being actively developed. We recommend using [Upgrades Plugins](https://docs.openzeppelin.com/upgrades-plugins/1.x/) instead.\n\u003e\n\u003e 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).\n\n# OpenZeppelin SDK\n\n[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)\n[![CircleCI](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master.svg?style=shield)](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master)\n[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)\n\n\u003e Formerly known as ZeppelinOS\n\nOpenZeppelin is a platform to develop, deploy and operate smart contract\nprojects on Ethereum and every other EVM and eWASM-powered blockchain.\n\nThis repository includes the OpenZeppelin\n[Command-Line Interface](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/cli#readme) and\n[Upgrades Library](https://github.com/OpenZeppelin/openzeppelin-sdk/tree/master/packages/lib#readme).\n\n## Install\n\nFirst, install [Node.js](http://nodejs.org/) and [npm](https://npmjs.com/).\nThen, install the OpenZeppelin SDK running:\n\n```sh\nnpm install --global @openzeppelin/cli\n```\n\n\u003e 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.\n\n## Usage\n\nWe recommend to use the OpenZeppelin SDK through the `openzeppelin sdk` command-line interface.\n\nTo start, create a directory for the project and access it:\n\n```sh\nmkdir my-project\ncd my-project\n```\n\nUse `npm` to create a `package.json` file:\n\n```sh\nnpm init\n```\n\nAnd initialize the OpenZeppelin SDK project:\n\n```sh\nopenzeppelin init my-project\n```\n\nNow it is possible to use `openzeppelin deploy` to create instances for these contracts that \nlater can be upgraded, and many more things.\n\nRun `openzeppelin --help` for more details about thes and all the other functions of the\nOpenZeppelin CLI.\n\nThe\n[OpenZeppelin SDK documentation](https://docs.openzeppelin.com/cli/)\nexplains how to build a project using our platform, how to upgrade contracts,\nhow to share packages for other projects to reuse, how to vouch for the quality\nof a package, how to use the JavaScript libraries to operate the project, and\nit explains details of the platform and some advanced topics.\n\n## Security\n\nIf you find a security issue, please contact us at security@openzeppelin.com. We\ngive rewards for reported issues, according to impact and severity.\n\n## Maintainers\n\n* [@spalladino](https://github.com/spalladino)\n* [@jcarpanelli](https://github.com/jcarpanelli)\n* [@ylv-io](https://github.com/ylv-io)\n\n## Community\n\nJoin our [Community Forum](https://forum.openzeppelin.com) or\n[community channel on Telegram](https://t.me/zeppelinos), where you can talk to\nall the OpenZeppelin developers, contributors, partners, and users.\n\nYou can also follow the recent developments of the project in the OpenZeppelin [blog](https://blog.openzeppelin.com/) and\n[Twitter account](https://twitter.com/openzeppelin).\n\n## Contributing\nTo set up a local development environment for contributing, clone the repository and run `yarn` in the root of the project. \n\nPlease refer to the [contributing guide](CONTRIBUTING.md) for more details on how to contribute.\n\n## License\n\n[MIT](LICENSE) © OpenZeppelin\n","funding_links":[],"categories":["Development Tutorial","JavaScript"],"sub_categories":["[Ethereum](https://github.com/ethereum)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenZeppelin%2Fopenzeppelin-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenZeppelin%2Fopenzeppelin-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenZeppelin%2Fopenzeppelin-sdk/lists"}