Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1Hive/token-request-app
Aragon app that allows someone to request native tokens from a DAO in exchange for another token
https://github.com/1Hive/token-request-app
Last synced: about 2 months ago
JSON representation
Aragon app that allows someone to request native tokens from a DAO in exchange for another token
- Host: GitHub
- URL: https://github.com/1Hive/token-request-app
- Owner: 1Hive
- License: gpl-3.0
- Created: 2019-05-11T17:20:13.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-01T06:34:15.000Z (over 2 years ago)
- Last Synced: 2024-02-09T08:39:23.292Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 31.7 MB
- Stars: 27
- Watchers: 8
- Forks: 21
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-dao-zh - token-request-app - 1Hive 代幣購買 App 合約 (合约开发)
README
# Token Request 
[](https://circleci.com/gh/1Hive/token-request-app)
[](https://coveralls.io/github/1Hive/token-request-app?branch=master&service=github)
1Hive's Token Request app allows users to create a vote which requests an Organization's tokens in exchange for payment. For example a user may request minting 100 organization tokens in exchange for 100 DAI. The request would require a vote to approve, if the vote is rejected the user would receive their payment back and if it is approved the payment would be deposited in the organization's vault.
#### 🚨 Security review status: [Contracts audited](https://diligence.consensys.net/audits/2019/12/dandelion-organizations/)
## How does it work
The Token Request App should be granted the `Create Votes` permission on an instance of the Aragon `Voting` app. When a user makes a request they should transfer the payment to the Token Request app which will hold them in escrow while the vote is created and executed. If the vote duration passes and the payment is still in the Token Request app, the user should be able to claim **their** tokens. If the vote passes then executing the vote should transfer the users tokens from the Token Request app to the organizations vault, and mint tokens from the token manager for the user.
### Initialization
The token request app is initialized by passing the address of a `token manager` instance, the address of a `_vault` instance, and an array of addresses `_acceptedDepositTokens`. The `_acceptedDepositTokens` array **MUST** be less than the `MAX_ACCEPTED_DEPOSIT_TOKENS` variable which is set to 100 and must be in ascending order (otherwise the installation will fail).
### Roles
The Token Request application should implement the following roles:
- Finalise token requests
- Change Vault Address
- Change Token Manager Address
- Add/remove offered tokens to/from the accepted offered token list
### Interface
We do not need to provide an interface for changing parameters as this can be done by power users using the aragonCLI.
The interface allows users to request tokens, where they would specify the amount and the associated payment.
It also allows for withdrawing their requests at any time.
For a detailed view of the flow of the app check out our [user-guide](./docs/user-guide.md)
## How to run Token Request app locally
First make sure that you have node, npm, and the aragonCLI 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/token-request-app.git
```
Navigate into the `token-request-app` directory.
```sh
cd token-request-app
```
Install npm dependencies.
```sh
npm i
```
Deploy a dao with Lock app installed on your local environment.
```sh
npm run start:template
```
## How to deploy to an organization
Token Request app has been published to APM on Mainnet and Rinkeby at `token-request.aragonpm.eth`
To deploy to an Aragon DAO you can use the [Aragon CLI](https://hack.aragon.org/docs/cli-intro.html).
```
aragon dao install token-request.aragonpm.eth --app-init-args
```
## Contributing
We welcome community contributions!
Please check out our [open 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.