https://github.com/openzeppelin/token-vouching
Vouching contracts and scripts for the OpenZeppelin SDK token
https://github.com/openzeppelin/token-vouching
Last synced: 10 months ago
JSON representation
Vouching contracts and scripts for the OpenZeppelin SDK token
- Host: GitHub
- URL: https://github.com/openzeppelin/token-vouching
- Owner: OpenZeppelin
- Created: 2019-01-10T20:48:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:23:40.000Z (over 3 years ago)
- Last Synced: 2023-04-09T18:38:15.715Z (about 3 years ago)
- Language: JavaScript
- Homepage:
- Size: 2.29 MB
- Stars: 7
- Watchers: 3
- Forks: 12
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# OpenZeppelin SDK token vouching
**This project was formerly known as _ZeppelinOS vouching (zos-vouching)_. This documentation and the related npm package still use the old naming.**
[](https://github.com/RichardLitt/standard-readme)
[](https://travis-ci.com/zeppelinos/zos-vouching)
> Vouching logic for the EVM packages of 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 ZEP Token and the contracts to use it to vouch
for EVM Packages.
## Background
ZeppelinOS provides a mechanism in which an EVM package can be registered and
vouched for using ZEP tokens. The tokens vouched for an EVM package can be
challenged by other ZEP holders whenever a deficiency in the EVM package is
presented for evaluation. In such a situation, the package's vouched tokens
could be slashed in favor of the challenger.
The end goal is that this simple mechanism will allow ZEP that is vouched for
an EVM package to represent:
* A measure of the quality of the code of the EVM package.
* A measure of the support that the EVM package has from the community.
* A financial buffer for the development of new features in the EVM package.
* A financial buffer for the auditing of the code of the EVM package.
## Install
First, install [Node.js](http://nodejs.org/) and [npm](https://npmjs.com/).
Then, install the vouching contracts running:
```sh
npm install zos-vouching
```
## Usage
Currently, the ZeppelinOS vouching mechanism can be used only by calling the
[Vouching.sol](contracts/Vouching.sol) contract directly. The address of this
deployed contract can be found in the `zos..json` files, that have
just been installed to the `node_modules/zos-vouching/` directory.
For example, open `truffle console --network ` and run:
```sh
truffle()> vouching = Vouching.at()
```
Then create a dependency calling:
```sh
truffle()> vouching.create(name, owner, dependencyAddress, initialStake)
```
Where `name` is a string that will represent the dependency, `owner` is the
address of the account that will own the dependency, `dependencyAddress` is
the address of the EVM package and `initialStake` is the amount to be vouched.
After the dependency is created, the owner can vouch or unvouch tokens to the
EVM package:
```sh
truffle()> vouching.vouch(name, amount)
```
or:
```sh
truffle()> vouching.unvouch(name, amount)
```
## 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
* [@facuspagnuolo](https://github.com/facuspagnuolo/)
* [@fiiiu](https://github.com/fiiiu)
## 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