Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naszam/maker-badges
Non-transferable Badges for Maker Ecosystem Activity @makerdao @ETHGlobal
https://github.com/naszam/maker-badges
erc-721 ethereum maker-badges makerdao solidity zeppelin
Last synced: 8 days ago
JSON representation
Non-transferable Badges for Maker Ecosystem Activity @makerdao @ETHGlobal
- Host: GitHub
- URL: https://github.com/naszam/maker-badges
- Owner: naszam
- License: agpl-3.0
- Created: 2020-04-24T20:21:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-10T18:18:50.000Z (about 2 years ago)
- Last Synced: 2024-04-13T16:05:32.429Z (7 months ago)
- Topics: erc-721, ethereum, maker-badges, makerdao, solidity, zeppelin
- Language: TypeScript
- Homepage: https://mkrbadges.on.fleek.co
- Size: 7.33 MB
- Stars: 17
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://wiki.ubuntu.com/Releases)
[](https://github.com/nvm-sh/nvm#installation-and-update)
[](https://docs.openzeppelin.com/)
[](https://github.com/ethereum/solidity/releases/tag/v0.8.9)
[](#development-deployments)
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://github.com/naszam/maker-badges/actions/workflows/lint.yml)
[](https://github.com/naszam/maker-badges/actions/workflows/slither.yml)
[](https://github.com/naszam/maker-badges/actions/workflows/tests.yml)
[](https://github.com/naszam/maker-badges/actions/workflows/echidna.yml)
[](https://hackathon.money/)
# Maker Badges
> Non-transferable Badges for Maker Ecosystem Activity
An incentive protocol to enhance activity on MakerDAO Ecosystem
## Mentors
- Mariano Conti, [@nanexcool](https://github.com/nanexcool)
- Josh Crites, [@critesjosh](https://github.com/critesjosh)
- Yannis Stamelakos, [@i-stam](https://github.com/i-stam)
- Dror Tirosh (OpenGSN), [@drortirosh](https://github.com/drortirosh)
[Demo](https://youtu.be/oZhXjtDnKBM)
[HackMoney](https://hack.ethglobal.co/showcase/metabadges-recJS9yRU2zu4rksZ)
## Sections
- [Building Blocks](#building-blocks)
- [Setup](#setup)
- [Deploy](#deploy)
- [Interface](#interface)
- [Backend](#backend)
- [About](#about)
# Building Blocks
### [Dai GraphQL](https://developer.makerdao.com/dai/1/graphql/)
> Dai GraphQL to check for activities on MakerDAO ecosystem
To enable MakerBadges to check off-chain for activities on MakerDAO ecosystem we're using the following MakerDAO DSS
Contracts:
- **Pot**: to check if a user has accrued 1 or more Dai from DSR.
- **Dai**: to check if a user has sent 10 or 20 Dai.
- **Chief**: to check if a user has voted in Executive Spells or Governance Polls.
- **Flip**: to check if a user has bidden or won Collateral Auctions.
- **Cat**: to check if a user have bitten an unsafe vault.
### [BadgeRoles](./contracts/BadgeRoles.sol)
> BadgeRoles Access Management for Default Admin, Admin, Templater and Pauser Role
BadgeRoles inherits the OpenZeppelin AccessControl.sol, allowing the owner of the contract to be set as Default Admin,
Admin, Pauser and also as Templater, to add an Admin via **addAdmin** and remove an Admin via **removeAdmin** functions
as well as to add a Templater via **addTemplater** and remove a Templater via **removeTemplater** functions.
### [MakerBadges](./contracts/MakerBadges.sol)
> MakerBadges to manage Templates and activate Non-transferable Badges for redeemers
To enable MakerBadges to verify redeemers checked off-chain for activities on MakerDAO ecosystem, when they try to
redeem their Badge, we query the Dai GraphQL, and we generate a Merkle Tree of off-chain checked redeemers for each
Badge Template.
In particular, we'll use:
- **verify** to verify redeemers checked off-chain, using a proof (generated from the Merkle Tree for each redeemer).
MakerBadges let the admin to set (via **setRootHashes**) an array of root hashes, called **roots**, ordered by template
Id to allow redemeers checked off-chain for activities via TheGraph on the frontend, and stored into a Merkle Tree, to
redeem Badges.
A Merkle Tree is generated for every Badge Template and the root hash is then updated by the admin of MakerBadges on a
weekly/monthly basis to allow batches of redeemers to redeem Badges.
MakerBadges inherits BadgeRoles, allowing a Templater to create a new template via **createTemplate** specifying name,
description and image. A Templater can also update the template info via **updateTemplate**.
Getter functions are implemented to get template metadata via **templates** and the current number of templates via
**getTemplateCount**.
It also inherits ERC721, where the **\_transfer** has been overridden to implement the non-transferable feature,
allowing redeemers checked off-chain to redeem a Badge for a specific activity on MakerDAO ecosystem via
**activateBadge** that will verify if the caller is a redeemer and then will allow the caller to mint a new
Non-transferable Maker Badge with tokenURI stored on IPFS (eg. "ipfs-hash.json").
**templateQuantities** getter function is implemented to get the number of badges activated for each template.
To avoid that a redeemer could activate the same Badge twice, the **tokenId** is generated via **\_getTokenId"** that
concatenates the **redeemer** address and the **templateId** to get a unique hard-coded identifier. The **\_mint**
function will check then if the tokenId already exists (= already minted) and if not mint a new Badge.
**getBadgeRedeemer** and **getBadgeTemplate** getter functions are implemented to get the redeemer address and
**templateId** hard-coded inside the specified **tokenId**.
Finally **setBaseURI** is added to allow the default admin to set a new baseURI.
During deployment the contract sets the following ERC721 metadata:
- name: "MakerBadges"
- symbol: "MAKER"
- baseURI: "https://badges.makerdao.com/token/"
# Setup
Clone this GitHub repository.
## Steps to compile and test
- Local dependencies:
- HardHat
- TypeChain
- OpenZeppelin Contracts
- Ethers
- Waffle
- Solhint
- Solcover
- Prettier
```sh
$ yarn install
```
- Global dependencies:
- Slither (optional):
```sh
$ git clone https://github.com/crytic/slither.git && cd slither
$ sudo python3 setup.py install
```
- MythX CLI (optional):
```sh
$ git clone git://github.com/dmuhs/mythx-cli && cd mythx-cli
$ sudo python setup.py install
```
- Echidna (optional):
[binaries](https://github.com/crytic/echidna/releases)
## Running the project with local test network
- Compile the smart contracts using HardHat with the following command:
```sh
$ yarn build
```
- Deploy the smart contracts locally with the following commands:
```sh
$ yarn dev
```
in a separate terminal:
```sh
$ yarn deploy:local
```
- Test the smart contracts using Waffle & Ethers with Fixtures:
```sh
$ yarn test
```
- Analyze the smart contracts using Slither with the following command (optional):
```sh
$ slither .
```
- Analyze the smart contracts using MythX CLI with the following command (optional):
```sh
$ mythx analyze
```
- Analyze the smart contracts using Echidna with the following command (optional):
```sh
$ echidna-test . --contract BadgeRolesEchidnaTest --config echidna.config.yml
```
# Deploy
## Deploy on Sokol Testnet
- Get an Ethereum Account on Metamask.
- On the landing page, click “Get Chrome Extension.”
- Add mnemonic to MNEMONIC .env file.
- Add deployer address to DEPLOYER_ADDRESS .env file.
- Add Sokol as custom RPC via [Chainlist](https://chainlist.org/).
- Get some test ether from a [Sokol's faucet](https://faucet.poa.network/).
- Uncomment the following lines in hardhat.config.ts:
```
//if (!process.env.MNEMONIC) throw new Error('Please set your MNEMONIC in a .env file');
//const mnemonic = process.env.MNEMONIC as string;
//if (!process.env.DEPLOYER_ADDRESS) throw new Error("Please set your DEPLOYER_ADDRESS in a .env file")
```
- Replace the following with `mnemonic: mnemonic`:
```
mnemonic: "test test test test test test test test test test test junk"
```
- Deploy MakerBadges on Sokol via the following command:
```sh
$ yarn deploy:sokol
```
- Flatten MakerBadges to verify on [Blockscout](https://blockscout.com/poa/sokol/):
```
yarn flatten
```
## Development Deployments
### Sokol
**MinimalForwarder**
[0xB27bC0B1eCa340a4579642E8ab3D76F6A5815303](https://blockscout.com/poa/sokol/address/0xB27bC0B1eCa340a4579642E8ab3D76F6A5815303/contracts)
**MakerBadges:**
[0xD0d0d3A2E1c574D8eFb7c902C6Adf788F684d3B5](https://blockscout.com/poa/sokol/address/0xD0d0d3A2E1c574D8eFb7c902C6Adf788F684d3B5/contracts)
# Interface
- [Frontend](https://github.com/scottrepreneur/maker-badges/tree/master/packages/frontend)
# Backend
- [Merkle Service](https://github.com/scottrepreneur/maker-badges/tree/master/packages/api)
# About
## Inspiration & References
- [open-proofs](https://github.com/rrecuero/open-proofs)
- [ERC1238](https://github.com/ethereum/EIPs/issues/1238)
- [ERC721](https://eips.ethereum.org/EIPS/eip-721)
- [POAP](https://www.poap.xyz/)
- [MakerDAO](https://makerdao.com/en/)
- [Chai](https://chai.money/about.html)
- [aztec-airdrop](https://github.com/nanexcool/aztec-airdrop)
## CDIPs
- CDIP [18](https://github.com/makerdao/community/issues/537)
- CDIP [29](https://github.com/makerdao/community/issues/721)
- CDIP [38](https://github.com/makerdao/community/issues/1180)
## Authors
Project created by [Nazzareno Massari](https://nazzarenomassari.com) and Scott Herren.
MakerDAOx and UI by [Josi](https://twitter.com/0xO0O0)
A special thanks for support to [Gonzalo Balabasquer](https://github.com/gbalabasquer).
Security Check by [Scott Bigelow](https://github.com/epheph)
MakerDAO Badge Illustrations by [Richard Rosa](https://www.artstation.com/artwork/oAJeVq)