OpenZeppelin SDK JavaScript Library (@openzeppelin/upgrades)
![CircleCI](https://circleci.com/gh/OpenZeppelin/openzeppelin-sdk/tree/master.svg?style=shield)
JavaScript library for the OpenZeppelin smart contract platform.
OpenZeppelin SDK is a platform to develop, deploy and operate smart contract
projects on Ethereum and every other EVM and eWASM-powered blockchain.
This is the repository for the OpenZeppelin SDK JavaScript library. It is mainly used
by the
openzeppelin-sdk
command-line interface,
which is the recommended way to use the OpenZeppelin SDK; but this library can also be
used directly to operate projects when a programmatic interface is
preferred or more flexibility and lower-level access is required.
Install
First, install Node.js and npm.
Then, install the OpenZeppelin SDK JavaScript Library running:
npm install @openzeppelin/upgrades
Usage
Suppose there is a contract called MyContract
in the file
contracts/MyContract.sol
, already compiled to
build/contracts/MyContract.json
, and that there is a development blockchain
network running locally in port 9545.
Open a Node.js console:
node
> const { ZWeb3, Contracts, SimpleProject } = require('@openzeppelin/upgrades')
>
> ZWeb3.initialize("http://localhost:9545")
>
> const MyContract = Contracts.getFromLocal('MyContract')
>
> myProject = new SimpleProject('MyProject', { from: await ZWeb3.defaultAccount() })
>
> myProject.createProxy(MyContract).then(proxy => myProxy = proxy)
>
> const MyContractUpgraded = Contracts.getFromLocal('MyContract')
> myProject.upgradeProxy(proxy, MyContractUpgraded)
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.
API
TODO.
Maintainers
Contribute
To contribute, join our
community channel on Telegram where you can talk to
all the OpenZeppelin developers, contributors, partners and users.
You can also follow the recent developments of the project in our
blog and
Twitter account.
License
MIT © OpenZeppelin