Skip to content
ZeppelinOS multi-package repository
JavaScript TypeScript Solidity Other
Branch: authereum
Clone or download
Pull request Compare This branch is 6 commits ahead, 116 commits behind OpenZeppelin:master.
Latest commit bb23ccf Jul 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci New quickstart documentation (OpenZeppelin#961) Jun 24, 2019
.githooks Adds `unpack` command (OpenZeppelin#822) Apr 30, 2019
examples wip Jul 4, 2019
packages wip Jul 4, 2019
tests wip Jul 4, 2019
.eslintrc.base.js Add ESLint and Prettier configs; Apply linting; (OpenZeppelin#920) May 31, 2019
.gitignore Ignore node_modules and add package-lock file for root dir (OpenZeppe… Aug 27, 2018
.mergify.yml Update mergify config Apr 3, 2019
.prettierrc.base.js Add ESLint and Prettier configs; Apply linting; (OpenZeppelin#920) May 31, 2019
CONTRIBUTING.md Create CONTRIBUTING.md (OpenZeppelin#553) Jan 7, 2019
HACKING.md Cleanup the READMEs (OpenZeppelin#276) Oct 18, 2018
LICENSE Replace all the usages of zOS with ZeppelinOS (OpenZeppelin#315) Oct 23, 2018
README.md
TERMINOLOGY.md Cleanup the READMEs (OpenZeppelin#276) Oct 18, 2018
lerna.json v2.4.0 Jun 24, 2019
package-lock.json Add ESLint and Prettier configs; Apply linting; (OpenZeppelin#920) May 31, 2019
package.json Add ESLint and Prettier configs; Apply linting; (OpenZeppelin#920) May 31, 2019
tsconfig.json Rename Project, Network, Sesion and Lock files (OpenZeppelin#1040) Jun 27, 2019

README.md

ZeppelinOS (zos)

standard-readme compliant CircleCI lerna

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 repository includes the ZeppelinOS Command-Line Interface, JavaScript Library, and the sources for the Documentation Website.

Install

First, install Node.js and npm. Then, install ZeppelinOS running:

npm install --global zos

Usage

We recommend to use ZeppelinOS through the zos command-line interface.

To start, create a directory for the project and access it:

mkdir my-project
cd my-project

Use npm to create a package.json file:

npm init

And initialize the ZeppelinOS project:

zos init my-project

Now it is possible to add contracts to the project with the zos add command, push these contracts to a blockchain network with zos push, use zos create to create instances for these contracts that later can be upgraded, and many more things.

Run zos --help for more details about thes and all the other functions of ZeppelinOS.

The ZeppelinOS documentation 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@zeppelinos.org. We give rewards for reported issues, according to impact and severity.

Maintainers

Development setup

Run npm install in the root of the project, followed by npx lerna bootstrap to have lerna install all dependencies in all packages and symlink them as needed.

Contribute

To contribute, join our forum or community channel on Telegram, 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 and Twitter account.

License

MIT © Zeppelin

You can’t perform that action at this time.