DAO-Example

It is simple example for DOA

Usercase

This is simple example of Governance based on both ERO20 and ERC721 you can used any of them and used this simple example

Hardhat Upgrades
Getting Started
Usage
- Testing
  - Test Coverage
Deployment to a testnet or mainnet
Linting
Formatting
Thank you!

Getting Started

Deployed Contract Address

FigurePrintOracle = 0x30dc3146E8D2b07D26f0B7681DB200cdfFA56D28 OrcaleUrlProvider = 0xAb570B4B76f86b8678C33bCCc26f3cE6D51f3479

Requirements

Nodejs
- You'll know you've installed nodejs right if you can run:
  - node --version and get an ouput like: vx.x.x
Yarn instead of npm
- You'll know you've installed yarn right if you can run:
  - yarn --version and get an output like: x.x.x
  - You might need to install it with npm
Docker if want to do Fazz testing echidna
- You'll know you've installed docker right if you can run:
  - docker --version and get an output version.
- or you can install with Pythone if you want

Quickstart

git clone https://github.com/touqeerShah/DAO-EXAMPLE.git
cd DAO-EXAMPLE
yarn

Usage

Start Node:

hh node

Open new terminal Deploy and run following command: following command will run the script which is used to create proposal for value change

hh run scripts/prpose.ts --network localhost

It time to vote: following command will submit vote accrpt the proposal

hh run scripts/vote.ts --network localhost

Once vote is executed it is time to put propoal in Queue: following command will submit Queue to wait to process time will finished

hh run scripts/queue.ts --network localhost

Once propoal in Queue: following command will impletment the changes and call the function to updated the values

hh run scripts/queue.ts --network localhost

Deployment to a testnet or mainnet

Setup environment variabltes

You'll want to set your GOERLI_RPC_URL and PRIVATE_KEY as environment variables. You can add them to a .env file, similar to what you see in .env.example.

PRIVATE_KEY: The private key of your account (like from metamask). NOTE: FOR DEVELOPMENT, PLEASE USE A KEY THAT DOESN'T HAVE ANY REAL FUNDS ASSOCIATED WITH IT.
- You can learn how to export it here.
GOERLI_RPC_URL: This is url of the goerli testnet node you're working with. You can get setup with one for free from Alchemy or Infura

#### .evn
PRIVATE_KEY=
USER2_PRIVATE_KEY= <USER 2 Privete Key>
PROVIDER_REN_URL=https://goerli.infura.io/v3/<Infure Key>

ETHERSCANAPIKEY=<Ethetscan Key>
COINMARKETCAP_API_KEY= < Coin marketcap key>

Get testnet ETH

Head over to Alchemy and get some tesnet ETH. You should see the ETH show up in your metamask.

Deploy

yarn hardhat deploy --network goerli

Staging Testing

After deploy to a testnet or local net, you can run staging test.

yarn run test:staging

Estimate gas

You can estimate how much gas things cost by running:

yarn hardhat test

And you'll see and output file called gas-report.txt

Estimate gas cost in USD

To get a USD estimation of gas cost, you'll need a COINMARKETCAP_API_KEY environment variable. You can get one for free from CoinMarketCap.

Then, uncomment the line coinmarketcap: COINMARKETCAP_API_KEY, in hardhat.config.js to get the USD estimation. Just note, everytime you run your tests it will use an API call, so it might make sense to have using coinmarketcap disabled until you need it. You can disable it by just commenting the line back out.

Verify on etherscan

If you deploy to a testnet or mainnet, you can verify it if you get an API Key from Etherscan and set it as an environemnt variable named ETHERSCAN_API_KEY. You can pop it into your .env file as seen in the .env.example.

In it's current state, if you have your api key set, it will auto verify goerli contracts!

However, you can manual verify with:

yarn hardhat verify --constructor-args arguments.js DEPLOYED_CONTRACT_ADDRESS

Or when you Run you Deploy it will automatical verify the conteact when it was on testnet

Linting

To check linting / code formatting:

yarn lint

or, to fix:

yarn lint:fix

Contract Address Testnet

on-chain goerli
{
    "TimeLock": "0xa513E6E4b8f2a923D98304ec87F64353C4D5C853",
    "GovernorContract": "0x2279B7A0a67DB372996a5FaB50D91eAA73d2eBe6",
    "OrcaleUrlProvider": "0x5a49381bC5F3Ab204343b20e5A817A7D08b74F04",
    "FigurePrintOracle": "0xCbc746816c772a7C12e9556e8fe301DcB060Fc94",
    "UserIdentityNFT": "0x90550f13E8e7b7456eD88a175e09bE6585b88b94",
    "DocumentSignature": "0xAafFd42C07fE86B0c9fE064605659014AC4c1Af2",
    "LinkToken": "0x326C977E6efc84E512bB9C30f76E30c160eD06FB",
    "MockOracle": "0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9"
}

sepolia

{
    "TimeLock": "0xa513E6E4b8f2a923D98304ec87F64353C4D5C853",
    "GovernorContract": "0x2279B7A0a67DB372996a5FaB50D91eAA73d2eBe6",
    "OrcaleUrlProvider": "0x355097f3d6875036924af3a740c004289669d18d",
    "FigurePrintOracle": "0xf9431413885d5e1f15c853c1d567996130a20074",
    "UserIdentityNFT": "0xfc791405495d910a37b718333966675f7a028fe7",
    "DocumentSignature": "0x40963D2F509c7dc8342F1d3DE789E1D3168818Fc",
    "LinkToken": "0x779877A7B0D9E8603169DdbD7836e478b4624789",
    "MockOracle": "0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9",
    "PTNFT": "0x90aBdd9f7519eB46B3aCaf8FFB40d2364e67d4b2"
    
}

touqeerShah/hardhat-boiler