Skip to content

The HEART token is an ERC20 governance token for directing the flow of social impact resources from HeartRithm crypto quant fund

License

Notifications You must be signed in to change notification settings

heartrithm/heart_token

Repository files navigation

HEART token 💓

CircleCI pre-commit Code style: black License: MIT

HEART Governance token

The HEART ERC20 governance token was created for directing the flow of social impact resources from HeartRithm's regenerative engine for social impact. Token holders will be able to submit philanthropic projects to be considered for voting, and then vote on the allocation of social impact funding. Learn more at www.heartrithm.com/heart-token.

About HeartRithm

HeartRithm turns code into money in the cryptocurrency ecosystem. We use a combination of algorithmic trading, automated code robots, and other internal platforms for optimizing yield and generating alpha.

HeartRithm aims to be a "regenerative engine for social impact" by scaling up to 50% of our revenues to be driven to social impact causes.

Technical notes

  • We use OpenZeppelin's standard libraries for ERC20 functionality, version 4.2
  • We also use OpenZeppelins implementation of ERC20Votes was use for the governance functionality
  • We chose to use the "COMP" compatible version, ERC20VotesComp, to be be compatible with industry tooling

Contract details

Development

Installation

Python

  1. Set up the python virtual env of your choice. Tested with Python 3.9
  2. pip install -r requirements-dev.txt
  3. Set up git pre-commit hooks with pre-commit install

Node/Ganache

  1. Install node / npm (via nvm recommended)
  2. Install ganache for a local blockchain (npm install -g ganache-cli)

Formatting/linting

Install prettier with npm install -g prettier prettier-plugin-solidity

prettier --write $Contract.sol

Install solhint with npm install -g solhint

solhint $Contract.sol

Brownie

We use brownie for python based smart contract development, testing, and deployment

Run tests with brownie test