Skip to content

Latest commit

 

History

History
117 lines (77 loc) · 3.12 KB

README.md

File metadata and controls

117 lines (77 loc) · 3.12 KB
Raw

Universal Basic Income.

UBI Coin

A standard for Universal Basic Income tokens.

Built in collaboration with Kleros and the Proof of Humanity project.

Build Status Coverage Status

Features

  • ERC20 token that can mint new supply for verified humans over time at a given rate.
  • Tokens get streamed directly to a users wallet.
  • Interfaces with ProofOfHumanity to get curated list of verified humans.
  • ProofOfHumanity registry can be updated with governance mechanism.
  • Implements ERC20Upgradeable contracts with OpenZeppelin proxy libraries.

Built with Hardhat.

Latest release is version 0.2.0

Setup

  1. Clone Repository

    $ git clone https://github.com/DemocracyEarth/ubi.git
$ cd ubi

  2. Install Dependencies

    $ npm install

  3. Run Tests

    $ npx hardhat test

    To compute their code coverage run npx hardhat coverage.

Deploy

  1. On hardhat.config.js configure the following constants for the kovan testnet:

    INFURA_API_KEY
KOVAN_PRIVATE_KEY

  2. Deploy on Ethereum kovan testnet:

    $ npx hardhat run scripts/deploy.js --network kovan

  3. Interact with the console:

    $ npx hardhat console --network kovan

    Initalize the token with:

     const UBI = await ethers.getContractFactory("UBI")
 const ubi = await UBI.attach('0x703960D03533B1D34fF4996DC6604f0Bc74ED198') // Replace with your token address

Upgrade

  1. Deploy new contract in a fresh address:

    $ npx hardhat run scripts/prepare.js --network kovan

  2. Upgrade the proxy contract with the freshly deployed address:

    $ npx hardhat run scripts/upgrade.js --network kovan

Verify

  1. On hardhat.config.js configure your Etherscan API key:

    ETHERSCAN_API_KEY

  2. Verify the contract by running:

    $ npx hardhat verify --network kovan <ADDRESS>

Contribute

These contracts are free, open source and censorship resistant. Support us via Open Collective.

License

This software is under an MIT License. This is a free software built by Democracy Earth Foundation between 2020 and 2021. Democracy Earth Foundation is a 501 (c) 3 not for profit corporation from San Francisco, California with no political affiliations.