Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.69 KB

README.md

File metadata and controls

64 lines (40 loc) · 2.69 KB
Raw

Redemptions

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: Rinkeby

The Redemptions app has been published to open.aragonpm.eth on the Rinkeby test network. If you experience any issues or are interested in contributing please see review our open issues.

🚨 Security review status: pre-audit

The code in this repo has not been audited.

How to run locally

Run a testing dao with the redemptions app already deployed on your local envrionment:

npx aragon run --template Template --template-init @ARAGON_ENS

This command will output the configuration for deployment:

    Ethereum Node: ws://localhost:8545
    ENS registry: 0x5f6f7e8cc7346a11ca2def8f827b7a0b612c56a1
    APM registry: aragonpm.eth
    DAO address: <dao-address>

We will use the dao-address to run a truffle script to deploy some test tokens to interact with.

npx truffle exec scripts/deploy-tokens.js <dao-address>

How to deploy to an organization

Redemptions has been published to APM on rinkeby at redemptions.open.aragonpm.eth

To deploy to an organization you can use the Aragon CLI.

aragon dao install <dao-address> redemptions.open.aragonpm.eth --app-init-args <vault-address> <token-manager-address>

The Redemptions app must have the TRANSFER_ROLE permission on Vault and the BURN_ROLE permission on the Token Manager.

Using redemptions

The redemptions app allows organizations to add and remove tokens from a list of eligible tokens. When a user choses to redeem tokens they will receive a proportional share of all eligible tokens in the Vault.

Redeeming tokens:

To redeem tokens, click on the redeem then use the slider to select how many tokens you would like to redeem. When satified with the amount, click redeem to confirm. You will be prompted to sign a message, then you will be able to confirm the transaction.

Adding eligible vault token:

To add an eligble token click "Add Token", then enter the address of the token contract you would like to add.

Removing eligible vault token:

To remove an eligble token, hover over the token you want to remove and click "Remove Token", then enter the address of the token contract you would like to remove.