ZeppelinOS JavaScript Library (zos-lib)

JavaScript library for the ZeppelinOS smart contract platform.

ZeppelinOS 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 ZeppelinOS JavaScript library. It is mainly used by the zos command-line interface, which is the recommended way to use ZeppelinOS; but this library can also be used directly to operate ZeppelinOS 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 ZeppelinOS JavaScript Library running:

npm install zos-lib

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

> // Connect web3 to the local provider.
> var Web3 = require('web3')
> web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:9545"))
> // Load the contract.
> const { Contracts, SimpleProject } = require('cc-zos-lib')
> const MyContract = Contracts.getFromLocal('MyContract')
> // Instantiate a project.
> myProject = new SimpleProject('MyProject', { from: web3.eth.accounts[0] });
> // Create a proxy for the contract.
> myProject.createProxy(MyContract).then(proxy => myProxy = proxy)
> // Make a change on the contract, and compile it.
> const MyContractV1 = Contracts.getFromLocal('MyContract')
> myProject.upgradeProxy(proxy, MyContractV1)

## Security

If you find a security issue, please contact us at [email protected]. We
give rewards for reported issues, according to impact and severity.

## API

TODO.

## Maintainers

* [@facuspagnuolo](https://github.com/facuspagnuolo/)
* [@spalladino](https://github.com/spalladino)

## Contribute

To contribute, join our
[community channel on Telegram](https://t.me/zeppelinos) where you can talk to
all the ZeppelinOS developers, contributors, partners and users.

You can also follow the recent developments of the project in our
[blog](https://blog.zeppelin.solutions/) and
[Twitter account](https://twitter.com/zeppelinorg).

## License

[MIT](LICENSE.md) © Zeppelin