{"_id":"@aragon/apps-redemptions","_rev":"23-28c687881963ce01d2adc60fdb3867db","name":"@aragon/apps-redemptions","dist-tags":{"latest":"2.0.1"},"versions":{"2.0.1":{"name":"@aragon/apps-redemptions","version":"2.0.1","keywords":[],"_id":"@aragon/apps-redemptions@2.0.1","maintainers":[{"name":"arabot-1","email":"devops@aragon.org"},{"name":"hack0","email":"scherer.mat@gmail.com"},{"name":"yuetlooo","email":"contact@yuetloo.com"},{"name":"izqui","email":"jorge@aragon.one"},{"name":"luisivan","email":"me@luisivan.net"},{"name":"aragon-ci","email":"jorge+npmci@aragon.one"},{"name":"nivida","email":"sam@aragon.one"},{"name":"npmdoramon","email":"emaildoramon@gmail.com"},{"name":"vracine","email":"valentinracine@hotmail.com"},{"name":"novaknole","email":"giorgi.lagidze@toptal.com"}],"dist":{"shasum":"e69f419cafcf7987350c57a187d9b2b29b89d108","tarball":"https://registry.npmjs.org/@aragon/apps-redemptions/-/apps-redemptions-2.0.1.tgz","fileCount":13,"integrity":"sha512-0rVQ+u/yASz5AC1VL9zBxHTB1utca0gIdlA7D+Nn9db+v6QEqBemopPw5BCovg9TQT9BJJpRK2//eMx6Y3uS5g==","signatures":[{"sig":"MEUCIF9FgiQl/qfWlZUc7tuPrpttPERANv/mVQbl/ONvm3R4AiEA9ZjbGqFAZX7YjfJpFTzu3xhJcPIk5tFXICWOryvlEH4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":75748,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzFtPCRA9TVsSAnZWagAA8WwP/RMrKFTt9TrPINM8iPdO\nq2nrq/lcOXCh2IPgPTEm1/5zJts7HlFtSu6rxpbGM1+i0EMABxpQt3UA5kM/\n+ysvHuo8k0TCPHVn+KsnAiHsNHoD+S572RcbkEJ3ARZ1CbNDKL7qdbcnx9vZ\niShc9i0ngBHM4Y3NIKAJM+gfmsMbqAmTHh+UMrnpgAY7R4SRnfTlyOp3EgpR\n8uPAnb74rf+tUMmUEgjbrqGDV8j2aGcVPUs1qSDlV2tx/AjBRz5hWwTfmH5y\nMuVwMWktRTClVP4QwivftuX0AACiCFC4Nw10KQck/WE5R+D0/dhfUf0GHZ3d\np3g0MfvbEo7046YdDQFL2izngqj21cGdnoIJj3kphrQhsWg/XWy8m4k3QCkc\n2gnjMzLiOhF7SuICGim8dXfBXh17XNVFQMSQQ2DbkmhWuCgvadfdQxDuv+iw\n+rKzuk6KFTdjX/JH3Mr0iT1A1Ba1mTkHJx+0jxKyAGtnUy4ODouJXE4o4OpE\nHm50dhiHeDgr0vE2YIY0z4gXtJ5Ek21xRzxP0Iqesy88QQLLoa7fO50vESyX\ndL3ML5Qh+jiHfq/qlObTgIXQN8QKN3aTssLsLbVn5n+gQPGw52If4d3d80FM\ndPwjKeEPSepDOh5Jws4pE4Px5HZrDWR/gLFIyuuDij7PvtpCqRpB09th4Mp3\n3A2g\r\n=/uKD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","scripts":{"lint":"eslint . & solium --dir ./contracts","test":"cross-env TRUFFLE_TEST=true npm run ganache-cli:test","build":"cd app && npm install && npm run build","compile":"hardhat compile --force","coverage":"cross-env SOLIDITY_COVERAGE=true npm run ganache-cli:test","lint:fix":"eslint . --fix & solium --dir ./contracts --fix","coveralls":"cat ./coverage/lcov.info | npx coveralls","start:app":"cd app && npm start && cd ..","deploy-tokens":"npx truffle exec ./scripts/deploy-tokens.js","ganache-cli:test":"sh ./node_modules/@aragon/test-helpers/ganache-cli.sh"},"_npmUser":{"name":"yuetlooo","email":"contact@yuetloo.com"},"_npmVersion":"6.14.15","description":"[](https://circleci.com/gh/1Hive/redemptions-app) [](https://coverall","directories":{},"_nodeVersion":"14.17.6","dependencies":{"@aragon/os":"^4.2.1","@aragon/api":"^1.1.0","@aragon/apps-vault":"4.1.0","@aragon/apps-shared-minime":"^1.0.1","@aragon/apps-token-manager":"2.1.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^6.0.1","ethers":"^5.4.7","ethlint":"^1.2.4","hardhat":"^2.6.5","truffle":"^5.0.1","prettier":"^1.18.2","coveralls":"3.0.2","cross-env":"^5.2.0","@aragon/cli":"^6.3.0","ganache-cli":"^6.0.0","babel-eslint":"^10.0.2","console.table":"^0.10.0","eth-ens-namehash":"^2.0.8","solidity-coverage":"^0.6.2","eslint-plugin-node":"^9.1.0","@aragon/apps-voting":"2.1.0","eslint-plugin-react":"^7.14.2","@aragon/test-helpers":"^2.0.0","eslint-plugin-import":"^2.18.0","eslint-plugin-promise":"^4.2.1","openzeppelin-solidity":"2.0.1","@aragon/hardhat-aragon":"^0.3.0","@aragon/hardhat-config":"^0.2.0","eslint-config-prettier":"^6.0.0","eslint-config-standard":"^13.0.1","eslint-plugin-prettier":"^3.0.1","eslint-plugin-standard":"^4.0.0","@nomiclabs/hardhat-ethers":"^2.0.2","eslint-plugin-react-hooks":"^1.6.0","@nomiclabs/hardhat-etherscan":"^2.1.6","eslint-config-standard-react":"^8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/apps-redemptions_2.0.1_1634850679155_0.766151672023637","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-10-21T21:11:19.101Z","modified":"2025-05-09T12:18:51.209Z","2.0.1":"2021-10-21T21:11:19.569Z"},"keywords":[],"description":"[](https://circleci.com/gh/1Hive/redemptions-app) [](https://coverall","maintainers":[{"email":"devops-master@aragon.org","name":"devops-master"},{"email":"jjavieralvarezrodriguez@gmail.com","name":"jjavieralv"},{"email":"devops@aragon.org","name":"arabot-1"}],"readme":"# Redemptions ![](\"https://github.com/1Hive/website/blob/master/website/static/img/bee.png\")
\n\n[](https://circleci.com/gh/1Hive/redemptions-app)\n[](https://coveralls.io/github/1Hive/redemptions-app?branch=master&service=github)\n[](https://crytic.io/1Hive/redemptions-app)\n\n1Hive'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.\n\n#### 🐲 Project Stage: Mainnet\n\nThe 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).\n\n#### 🚨 Security Review Status: [Contracts audited](https://diligence.consensys.net/audits/2019/12/dandelion-organizations/)\n\n## How to try Redemptions immediately\n\nWe have a [Redemptions demo DAO live on Rinkeby!](https://rinkeby.aragon.org/#/tryredemptions/0x18a9713625256548670ad979d51a6b9fad5b6c45)\n\n## How to run Redemptions locally\n\nFirst 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.\n\nGit clone this repo.\n\n```sh\ngit clone https://github.com/1Hive/redemptions-app.git\n```\n\nNavigate into the `redemptions-app` directory.\n\n```sh\ncd redemptions-app\n```\n\nInstall npm dependencies.\n\n```sh\nnpm i\n```\n\nDeploy a dao with Redemptions installed on your local environment.\n\n```sh\nnpm run start:template\n```\n\nIf 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:\n\n\n\nYou will also see the configuration for your local deployment in the terminal. It should look something like this:\n\n```sh\n Ethereum Node: ws://localhost:8545\n ENS registry: 0x5f6f7e8cc7346a11ca2def8f827b7a0b612c56a1\n APM registry: aragonpm.eth\n DAO address: YOUR-DAO-ADDRESS\n```\n\nCurrently 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.\n\n```sh\nnpm run deploy-tokens YOUR-DAO-ADDRESS\n```\n\nIf 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:\n\n```sh\nToken Address Balance\n----- ------------------------------------------ -------\nANT 0x7F381a654914a4C865123B33fD8178efc0Ee5C2D 40\nDAI 0xB5Cc76D092aA440087447EBD3A29E9E0b8A4bf9E 100\nOMG 0x3d09CfCdD3136aaE7A4B26875A7BAcA0C3d8A03b 14189\nETH 0x0000000000000000000000000000000000000000 0.1\n```\n\nNow 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.\n\n## How to deploy Redemptions to an organization\n\nRedemptions has been published to APM on Mainnet and Rinkeby at `redemptions.aragonpm.eth`\n\nTo deploy to an organization you can use the [Aragon CLI](https://hack.aragon.org/docs/cli-intro.html).\n\n```sh\naragon dao install redemptions.aragonpm.eth --app-init-args \n```\n\nThe Redemptions app must have the `TRANSFER_ROLE` permission on `Vault` and the `BURN_ROLE` permission on the `Token Manager`.\n\n## Contributing\n\nWe welcome community contributions!\n\nPlease check out our [open Issues](https://github.com/1Hive/redemptions-app/issues) to get started.\n\nIf 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.\n","readmeFilename":"README.md"}