Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1Hive/redemptions-app
Aragon app that enables redeeming organizations tokens for organization assets.
https://github.com/1Hive/redemptions-app
Last synced: about 2 months ago
JSON representation
Aragon app that enables redeeming organizations tokens for organization assets.
- Host: GitHub
- URL: https://github.com/1Hive/redemptions-app
- Owner: 1Hive
- License: gpl-3.0
- Created: 2019-05-02T16:34:18.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-01T06:32:16.000Z (over 2 years ago)
- Last Synced: 2024-02-09T08:39:23.526Z (5 months ago)
- Language: JavaScript
- Size: 60.9 MB
- Stars: 20
- Watchers: 7
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-dao-zh - redemptions-app - 1Hive 代幣賣回退款 App 合約 (合约开发)
- awesome-aragon - Redemptions
README
# Redemptions 
[](https://circleci.com/gh/1Hive/redemptions-app)
[](https://coveralls.io/github/1Hive/redemptions-app?branch=master&service=github)
[](https://crytic.io/1Hive/redemptions-app)
1Hive's Redemptions app allows Aragon organizations to grant their token holders the right to redeem tokens in exchange for a proportional share of the organizations treasury assets.
#### 🐲 Project Stage: Mainnet
The Redemptions app has been published to `aragonpm.eth` on Mainnet and Rinkeby networks. If you experience any issues or are interested in contributing please see review our open [issues](https://github.com/1hive/redemptions/issues).
#### 🚨 Security Review Status: [Contracts audited](https://diligence.consensys.net/audits/2019/12/dandelion-organizations/)
## How to try Redemptions immediately
We have a [Redemptions demo DAO live on Rinkeby!](https://rinkeby.aragon.org/#/tryredemptions/0x18a9713625256548670ad979d51a6b9fad5b6c45)
## How to run Redemptions locally
First make sure that you have node, npm, and the Aragon CLI installed and working. Instructions on how to set that up can be found [here](https://hack.aragon.org/docs/cli-intro.html). You'll also need to have [Metamask](https://metamask.io) or some kind of web wallet enabled to sign transactions in the browser.
Git clone this repo.
```sh
git clone https://github.com/1Hive/redemptions-app.git
```
Navigate into the `redemptions-app` directory.
```sh
cd redemptions-app
```
Install npm dependencies.
```sh
npm i
```
Deploy a dao with Redemptions installed on your local environment.
```sh
npm run start:template
```
If everything is working correctly, your new DAO will be deployed and your browser will open http://localhost:3000/#/YOUR-DAO-ADDRESS. It should look something like this:
You will also see the configuration for your local deployment in the terminal. It should look something like this:
```sh
Ethereum Node: ws://localhost:8545
ENS registry: 0x5f6f7e8cc7346a11ca2def8f827b7a0b612c56a1
APM registry: aragonpm.eth
DAO address: YOUR-DAO-ADDRESS
```
Currently the only thing deployed on your local testnet is an Aragon DAO with the Redemptions app. In a new terminal navigate to the `redemptions-app` directory. Then run this script to deploy some token contracts on your local testnet to interact with.
```sh
npm run deploy-tokens YOUR-DAO-ADDRESS
```
If successful, you will have deployed contracts for ANT, DAI, OMG, and ETH to your local testnet. The terminal will then display the names of the tokens and their addresses on your local testnet. It should look something like this:
```sh
Token Address Balance
----- ------------------------------------------ -------
ANT 0x7F381a654914a4C865123B33fD8178efc0Ee5C2D 40
DAI 0xB5Cc76D092aA440087447EBD3A29E9E0b8A4bf9E 100
OMG 0x3d09CfCdD3136aaE7A4B26875A7BAcA0C3d8A03b 14189
ETH 0x0000000000000000000000000000000000000000 0.1
```
Now if you navigate back to your browser (http://localhost:3000/#/YOUR-DAO-ADDRESS) you'll be able to open the Redemptions app and add one of these tokens to your locally deployed Redemptions app.
## How to deploy Redemptions to an organization
Redemptions has been published to APM on Mainnet and Rinkeby at `redemptions.aragonpm.eth`
To deploy to an organization you can use the [Aragon CLI](https://hack.aragon.org/docs/cli-intro.html).
```sh
aragon dao install redemptions.aragonpm.eth --app-init-args
```
The Redemptions app must have the `TRANSFER_ROLE` permission on `Vault` and the `BURN_ROLE` permission on the `Token Manager`.
## Contributing
We welcome community contributions!
Please check out our [open Issues](https://github.com/1Hive/redemptions-app/issues) to get started.
If you discover something that could potentially impact security, please notify us immediately. The quickest way to reach us is via the #dev channel in our [team Keybase chat](https://keybase.io/team/1hive). Just say hi and that you discovered a potential security vulnerability and we'll DM you to discuss details.