Web3续(二)

npm install --save-dev hardhat

# 创建hardhat项目
npx hardhat
# 安装插件
npm install --save-dev @chainlink/contracts @chainlink/env-enc dotenv @nomicfoundation/hardhat-toolbox @openzeppelin/contracts

# 初始化编译 会和 remix 一样在根目录生成一个 artifacts 文件夹
npx hardhat compile

├── contracts   //编写合约的文件
│   └── Greeter.sol
├── scripts   // 用于将当前的合约部署到线上或者测试环境
│   └── deploy.js
├── test    // 测试合约的文件
│   └── Greeter.test.js
├── task   // 分布合约部署  可以自定义指令，在执行 npx hardhat  命令看到
│   └── index.js
├── hardhat.config.js   //配置文件
└── package.json

// contract/FundMe.sol
//SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;

import {AggregatorV3Interface} from "@chainlink/contracts/src/v0.8/shared/interfaces/AggregatorV3Interface.sol";

contract FundMe {
  mapping(address => uint256) public fundersToAmount;

  uint256 constant MINIMUM_VALUE = 100 * 10 ** 18; //USD
  
  AggregatorV3Interface public dataFeed;

  uint256 constant TARGET = 1000 * 10 ** 18;

  address public owner;

  uint256 deploymentTimestamp;
  uint256 lockTime;

  address erc20Addr;
  // 标记一个可以查看到成功的变量
  bool public getFundSuccess = false;
  
  event FundWithdrawByOwner(uint256);
  event RefundByFunder(address, uint256);

  constructor(uint256 _lockTime, address dataFeedAddr) {
      // sepolia 测试
      dataFeed = AggregatorV3Interface(dataFeedAddr);
      owner = msg.sender;
      deploymentTimestamp = block.timestamp;
      lockTime = _lockTime;
  }
  // 获取当前账户合约余额
  function fund() external payable {
      require(convertEthToUsd(msg.value) >= MINIMUM_VALUE, "Send more ETH");
      require(block.timestamp < deploymentTimestamp + lockTime, "window is closed");
      fundersToAmount[msg.sender] = msg.value;
  }
  // 获取汇率
  function getChainlinkDataFeedLatestAnswer() public view returns (int) {
      (
          /* uint80 roundID */,
          int answer,
          /*uint startedAt*/,
          /*uint timeStamp*/,
          /*uint80 answeredInRound*/
      ) = dataFeed.latestRoundData();
      return answer;
  }
  // ETH 转换为 USD
  function convertEthToUsd(uint256 ethAmount) internal view returns(uint256){
      uint256 ethPrice = uint256(getChainlinkDataFeedLatestAnswer());
      return ethAmount * ethPrice / (10 ** 8);
  }
  // 获取指定账户合约余额
  function transferOwnership(address newOwner) public onlyOwner{
      owner = newOwner;
  }
  // 获取合约余额
  function getFund() external windowClosed onlyOwner{
      require(convertEthToUsd(address(this).balance) >= TARGET, "Target is not reached");
      bool success;
      uint256 balance = address(this).balance;
      (success, ) = payable(msg.sender).call{value: balance}("");
      require(success, "transfer tx failed");
      fundersToAmount[msg.sender] = 0;
      getFundSuccess = true; // flag
      // emit 控制台输出 balance
      emit FundWithdrawByOwner(balance);
  }
  // 退款
  function refund() external windowClosed {
      require(convertEthToUsd(address(this).balance) < TARGET, "Target is reached");
      require(fundersToAmount[msg.sender] != 0, "there is no fund for you");
      bool success;
      uint256 balance = fundersToAmount[msg.sender];
      (success, ) = payable(msg.sender).call{value: balance}("");
      require(success, "transfer tx failed");
      fundersToAmount[msg.sender] = 0;
      emit RefundByFunder(msg.sender, balance);
  }
  // 转账
  function setFunderToAmount(address funder, uint256 amountToUpdate) external {
      require(msg.sender == erc20Addr, "you do not have permission to call this funtion");
      fundersToAmount[funder] = amountToUpdate;
  }
  // 设置erc20地址
  function setErc20Addr(address _erc20Addr) public onlyOwner {
      erc20Addr = _erc20Addr;
  }

  modifier windowClosed() {
      require(block.timestamp >= deploymentTimestamp + lockTime, "window is not closed");
      _;
  }

  modifier onlyOwner() {
      require(msg.sender == owner, "this function can only be called by owner");
      _;
  }
}

// contracts/MockV3Aggregator.sol

//SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "@chainlink/contracts/src/v0.8/tests/MockV3Aggregator.sol";
// contracts/src/v0.8/shared/mocks/MockV3Aggregator.sol

// scripts/deploy.js 

const { ethers } = require("hardhat") 

async function main() {
  const fundMeFactory = await ethers.getContractFactory("FundMe")
  console.log("contract deploying")
  // deploy contract from factory
  const fundMe = await fundMeFactory.deploy(300)
  await fundMe.waitForDeployment()
  console.log(`contract has been deployed successfully, contract address is ${fundMe.target}`);

  // verify fundme   etherscan的sepolia测试环境id为11155111
  if(hre.network.config.chainId == 11155111 && process.env.ETHERSCAN_API_KEY) {
      console.log("Waiting for 5 confirmations")
      await fundMe.deploymentTransaction().wait(5) 
      await verifyFundMe(fundMe.target, [300])
  } else {
      console.log("verification skipped..")
  }

  // init 2 accounts
  const [firstAccount, secondAccount] = await ethers.getSigners()
  
  // fund contract with first account
  const fundTx = await fundMe.fund({value: ethers.parseEther("0.5")})
  await fundTx.wait()

  console.log(`2 accounts are ${firstAccount.address} and ${secondAccount.address}`)
  
  // check balance of contract
  const balanceOfContract = await ethers.provider.getBalance(fundMe.target)
  console.log(`Balance of the contract is ${balanceOfContract}`)

  // fund contract with second account
  const fundTxWithSecondAccount = await fundMe.connect(secondAccount).fund({value: ethers.parseEther("0.5")})
  await fundTxWithSecondAccount.wait()

  // check balance of contract
  const balanceOfContractAfterSecondFund = await ethers.provider.getBalance(fundMe.target)
  console.log(`Balance of the contract is ${balanceOfContractAfterSecondFund}`)

  // check mapping 
  const firstAccountbalanceInFundMe = await fundMe.fundersToAmount(firstAccount.address)
  const secondAccountbalanceInFundMe = await fundMe.fundersToAmount(secondAccount.address)
}

async function verifyFundMe(fundMeAddr, args) {
    await hre.run("verify:verify", {
        address: fundMeAddr,
        constructorArguments: args,
      });
}

main().then().catch((error) => {
    console.error(error)
    process.exit(0)
})

# 部署到本地网络
npx hardhat run scripts/deploy.js 
# 部署到指定网络
npx hardhat run scripts/deploy.js --network sepolia

# 交互部署合约   hardhat task部署`FundMe`合约
npx hardhat deploy-fundme --network sepolia
# 通过hardhat task与`FundMe`合约交互
npx hardhat fund-fundme --network sepolia

require("@nomicfoundation/hardhat-toolbox");
require("@chainlink/env-enc").config()
require("./tasks")
require("hardhat-deploy")
require("@nomicfoundation/hardhat-ethers");
require("hardhat-deploy");
require("hardhat-deploy-ethers");

const SEPOLIA_URL = process.env.SEPOLIA_URL
const PRIVATE_KEY = process.env.PRIVATE_KEY
const PRIVATE_KEY_1 = process.env.PRIVATE_KEY_1
const EHTERSCAN_API_KEY = process.env.ETHERSCAN_API_KEY

module.exports = {
  solidity: "0.8.20",
  defaultNetwork: "hardhat",
  mocha: {
    // hardhat的默认timeout是40秒，这里设置成5分钟
    timeout: 300000
  },
  networks: {
    sepolia: {
      url: SEPOLIA_URL,
      accounts: [PRIVATE_KEY, PRIVATE_KEY_1],
      chainId: 11155111
    }
  },
  etherscan: {
    apiKey: {
      sepolia: EHTERSCAN_API_KEY
    }
  },
  namedAccounts: {
    firstAccount: {
      default: 0
    },
    secondAccount: {
      default: 1
    },
  },
  gasReporter: {
    enabled: true  // 是否支持gasReporter的查看
  }
};

//  helper-hardhat-config.js
const DECIMAL = 8
const INITIAL_ANSWER = 300000000000
const devlopmentChains = ["hardhat", "local"]
const LOCK_TIME = 180
const CONFIRMATIONS = 5
const networkConfig = {
    11155111: {
        ethUsdDataFeed: "0x694AA1769357215DE4FAC081bf1f309aDC325306"
    },
    97: {
        ethUsdDataFeed: "0x143db3CEEfbdfe5631aDD3E50f7614B6ba708BA7"
    }
}

module.exports = {
    DECIMAL,
    INITIAL_ANSWER,
    devlopmentChains,
    networkConfig,
    LOCK_TIME,
    CONFIRMATIONS
}

const { ethers, deployments, getNamedAccounts, network } = require("hardhat")
const { assert, expect } = require("chai")
const helpers = require("@nomicfoundation/hardhat-network-helpers")
const {devlopmentChains} = require("../../helper-hardhat-config")

!devlopmentChains.includes(network.name)
? describe.skip
: describe("test fundme contract", async function() {
    let fundMe
    let fundMeSecondAccount
    let firstAccount
    let secondAccount
    let mockV3Aggregator
    beforeEach(async function() {
        await deployments.fixture(["all"])
        firstAccount = (await getNamedAccounts()).firstAccount
        secondAccount = (await getNamedAccounts()).secondAccount
        const fundMeDeployment = await deployments.get("FundMe")
        mockV3Aggregator = await deployments.get("MockV3Aggregator")
        fundMe = await ethers.getContractAt("FundMe", fundMeDeployment.address)
        fundMeSecondAccount = await ethers.getContract("FundMe", secondAccount)
    })
    
    it("test if the owner is msg.sender", async function() {
        await fundMe.waitForDeployment()
        assert.equal((await fundMe.owner()), firstAccount)
    })

    it("test if the datafeed is assigned correctly", async function() {
        await fundMe.waitForDeployment()
        assert.equal((await fundMe.dataFeed()), mockV3Aggregator.address)
    })

    // fund, getFund, refund
    // unit test for fund
    // window open, value greater then minimum value, funder balance
    it("window closed, value grater than minimum, fund failed", 
        async function() {
            // make sure the window is closed
            await helpers.time.increase(200)
            await helpers.mine()
            //value is greater minimum value
            await expect(fundMe.fund({value: ethers.parseEther("0.1")}))
                .to.be.revertedWith("window is closed")
        }
    )

    it("window open, value is less than minimum, fund failed", 
        async function() {
            await expect(fundMe.fund({value: ethers.parseEther("0.01")}))
                .to.be.revertedWith("Send more ETH")
        }
    )

    it("Window open, value is greater minimum, fund success", 
        async function() {
            // greater than minimum
            await fundMe.fund({value: ethers.parseEther("0.1")})
            const balance = await fundMe.fundersToAmount(firstAccount)
            await expect(balance).to.equal(ethers.parseEther("0.1"))
        }
    )    

    // unit test for getFund
    // onlyOwner, windowClose, target reached
    it("not onwer, window closed, target reached, getFund failed", 
        async function() {
            // make sure the target is reached 
            await fundMe.fund({value: ethers.parseEther("1")})

            // make sure the window is closed
            await helpers.time.increase(200)
            await helpers.mine()

            await expect(fundMeSecondAccount.getFund())
                .to.be.revertedWith("this function can only be called by owner")
        }
    )

    it("window open, target reached, getFund failed", 
        async function() {
            await fundMe.fund({value: ethers.parseEther("1")})
            await expect(fundMe.getFund())
                .to.be.revertedWith("window is not closed")
        }
    )

    it("window closed, target not reached, getFund failed",
        async function() {
            await fundMe.fund({value: ethers.parseEther("0.1")})
            // make sure the window is closed
            await helpers.time.increase(200)
            await helpers.mine()            
            await expect(fundMe.getFund())
                .to.be.revertedWith("Target is not reached")
        }
    )

    it("window closed, target reached, getFund success", 
        async function() {
            await fundMe.fund({value: ethers.parseEther("1")})
            // make sure the window is closed
            await helpers.time.increase(200)
            await helpers.mine()   
            await expect(fundMe.getFund())
                .to.emit(fundMe, "FundWithdrawByOwner")
                .withArgs(ethers.parseEther("1"))
        }
    )

    // refund
    // windowClosed, target not reached, funder has balance
    it("window open, target not reached, funder has balance", 
        async function() {
            await fundMe.fund({value: ethers.parseEther("0.1")})
            await expect(fundMe.refund())
                .to.be.revertedWith("window is not closed");
        }
    )

    it("window closed, target reach, funder has balance", 
        async function() {
            await fundMe.fund({value: ethers.parseEther("1")})
            // make sure the window is closed
            await helpers.time.increase(200)
            await helpers.mine()  
            await expect(fundMe.refund())
                .to.be.revertedWith("Target is reached");
        }
    )

    it("window closed, target not reach, funder does not has balance", 
        async function() {
            await fundMe.fund({value: ethers.parseEther("0.1")})
            // make sure the window is closed
            await helpers.time.increase(200)
            await helpers.mine()  
            await expect(fundMeSecondAccount.refund())
                .to.be.revertedWith("there is no fund for you");
        }
    )

    it("window closed, target not reached, funder has balance", 
        async function() {
            await fundMe.fund({value: ethers.parseEther("0.1")})
            // make sure the window is closed
            await helpers.time.increase(200)
            await helpers.mine()  
            await expect(fundMe.refund())
                .to.emit(fundMe, "RefundByFunder")
                .withArgs(firstAccount, ethers.parseEther("0.1"))
        }
    )

})


// test/fundme.staging.test.js
const { ethers, deployments, getNamedAccounts } = require("hardhat")
const { assert, expect } = require("chai")
const helpers = require("@nomicfoundation/hardhat-network-helpers")
const {devlopmentChains} = require("../../helper-hardhat-config")

devlopmentChains.includes(network.name)
? describe.skip
: describe("test fundme contract", async function() {
    let fundMe
    let firstAccount
    beforeEach(async function() {
        await deployments.fixture(["all"])
        firstAccount = (await getNamedAccounts()).firstAccount
        const fundMeDeployment = await deployments.get("FundMe")
        fundMe = await ethers.getContractAt("FundMe", fundMeDeployment.address)
    })

    // test fund and getFund successfully
    it("fund and getFund successfully", 
        async function() {
            // make sure target reached
            await fundMe.fund({value: ethers.parseEther("0.5")}) // 3000 * 0.5 = 1500
            // make sure window closed
            await new Promise(resolve => setTimeout(resolve, 181 * 1000))
            // make sure we can get receipt 
            const getFundTx = await fundMe.getFund()
            const getFundReceipt = await getFundTx.wait()
            expect(getFundReceipt)
                .to.be.emit(fundMe, "FundWithdrawByOwner")
                .withArgs(ethers.parseEther("0.5"))
        }
    )
    // test fund and refund successfully
    it("fund and refund successfully",
        async function() {
            // make sure target not reached
            await fundMe.fund({value: ethers.parseEther("0.1")}) // 3000 * 0.1 = 300
            // make sure window closed
            await new Promise(resolve => setTimeout(resolve, 181 * 1000))
            // make sure we can get receipt 
            const refundTx = await fundMe.refund()
            const refundReceipt = await refundTx.wait()
            expect(refundReceipt)
                .to.be.emit(fundMe, "RefundByFunder")
                .withArgs(firstAccount, ethers.parseEther("0.1"))
        }
    )
    

})

// tasks/index.js
exports.deployConract = require("./deploy-fundme")
exports.interactContract = require("./interact-fundme")


// tasks/deploy-fundme.js
const { task } = require("hardhat/config")

task("deploy-fundme", "deploy and verify fundme conract").setAction(async(taskArgs, hre) => {
    // create factory 
    const fundMeFactory = await ethers.getContractFactory("FundMe")
    console.log("contract deploying")
    // deploy contract from factory
    const fundMe = await fundMeFactory.deploy(300)
    await fundMe.waitForDeployment()
    console.log(`contract has been deployed successfully, contract address is ${fundMe.target}`);

    // verify fundme
    if(hre.network.config.chainId == 11155111 && process.env.ETHERSCAN_API_KEY) {
        console.log("Waiting for 5 confirmations")
        await fundMe.deploymentTransaction().wait(5) 
        await verifyFundMe(fundMe.target, [300])
    } else {
        console.log("verification skipped..")
    }
} )

async function verifyFundMe(fundMeAddr, args) {
    await hre.run("verify:verify", {
        address: fundMeAddr,
        constructorArguments: args,
      });
}

module.exports = {}


// tasks/interact-fundme.js
const { task } = require("hardhat/config")

task("interact-fundme", "interact with fundme contract")
    .addParam("addr", "fundme contract address")
    .setAction(async(taskArgs, hre) => {
        const fundMeFactory = await ethers.getContractFactory("FundMe")
        const fundMe = fundMeFactory.attach(taskArgs.addr)

        // init 2 accounts
        const [firstAccount, secondAccount] = await ethers.getSigners()
    
        // fund contract with first account
        const fundTx = await fundMe.fund({value: ethers.parseEther("0.5")})
        await fundTx.wait()
    
        // check balance of contract
        const balanceOfContract = await ethers.provider.getBalance(fundMe.target)
        console.log(`Balance of the contract is ${balanceOfContract}`)
    
        // fund contract with second account
        const fundTxWithSecondAccount = await fundMe.connect(secondAccount).fund({value: ethers.parseEther("0.5")})
        await fundTxWithSecondAccount.wait()
    
        // check balance of contract
        const balanceOfContractAfterSecondFund = await ethers.provider.getBalance(fundMe.target)
        console.log(`Balance of the contract is ${balanceOfContractAfterSecondFund}`)
    
        // check mapping 
        const firstAccountbalanceInFundMe = await fundMe.fundersToAmount(firstAccount.address)
        const secondAccountbalanceInFundMe = await fundMe.fundersToAmount(secondAccount.address)
        console.log(`Balance of first account ${firstAccount.address} is ${firstAccountbalanceInFundMe}`)
        console.log(`Balance of second account ${secondAccount.address} is ${secondAccountbalanceInFundMe}`)
})

module.exports = {}

const { network } = require("hardhat")
const {devlopmentChains, networkConfig, LOCK_TIME, CONFIRMATIONS} = require("../helper-hardhat-config")
//  getNamedAccounts:获取hardhat-config.js中定义的账户 deployments：获取部署的合约
module.exports= async({getNamedAccounts, deployments}) => {
    const {firstAccount} = await getNamedAccounts()
    const {deploy} = deployments
    
    let dataFeedAddr
    let confirmations
    if(devlopmentChains.includes(network.name)) {
        const mockV3Aggregator = await deployments.get("MockV3Aggregator")    
        dataFeedAddr = mockV3Aggregator.address
        confirmations = 0
    } else {
        dataFeedAddr = networkConfig[network.config.chainId].ethUsdDataFeed
        confirmations = CONFIRMATIONS
    }

    const fundMe = await deploy("FundMe", {
        from: firstAccount,
        args: [LOCK_TIME, dataFeedAddr],
        log: true,
        waitConfirmations: confirmations
    })

    if(hre.network.config.chainId == 11155111 && process.env.ETHERSCAN_API_KEY) {
        await hre.run("verify:verify", {
            address: fundMe.address,
            constructorArguments: [LOCK_TIME, dataFeedAddr],
          });        
    } else {
        console.log("Network is not sepolia, verification skipped...")
    }
}

module.exports.tags = ["all", "fundme"]

# 编写测试代码
npx hardhat test test/Greeter.test.js

# 运行测试代码
npx hardhat test

# 可以执行hardhat task 生成mock合约
npx hardhat deploy  --tags test