refactor: ethers v6 testing by sepolica

Author: Alex992Y

basic/15-nft-blindbox-chainlink-vrf/README-CN.md

@@ -8,23 +8,25 @@ VRF 为链上安全可验证随机数, 用于安全的生成随机数, 具体可
 在 .env 中放入的私钥，格式为 "PRIVATE_KEY=xxxx", 然后代码自动从中读取
 
 - 获取 test Link  
-每次去 ChainLink 请求 VRF 随机数时, 都需要消耗 Link 币, 所以在测试前需要申请 Link 测试币. 以 Goerli 测试网为例, 前往 [Request testnet LINK](https://faucets.chain.link/goerli?_ga=2.35440098.2104755910.1637393798-1377742816.1635817935) , 然后 "Netwrok" 选择 "Ethereum Goerli", "Testnet account address" 输入 .env 文件中 PRIVATE_KEY 对应的账户地址 
-![](./images/chainlink.png)
-<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/15-nft-blindbox-chainlink-vrf/chainlink.png?raw=true" /></center>
+每次去 ChainLink 请求 VRF 随机数时, 都需要消耗 Link 币, 所以在测试前需要申请 Link 测试币. 以 Sepolia 测试网为例, 前往 [Request testnet LINK](https://faucets.chain.link/sepolia) , 然后 "Netwrok" 选择 "Ethereum Sepolia", "Connect wallet" 链接小狐狸,点击"Send Request" 获取25 Test Link
+<center><img src="./imgs/Ethereum-Sepolia.png?raw=true" /></center>
+<center><img src="./imgs/GetLink.png?raw=true" /></center>
 
 - 安装依赖
 ```
 npm install 
+
+Node版本：v20.11.0
 ```
 
 - 创建 ChainLink SubscriptionID  
 登陆 [ChainLink VRF 测试网](https://vrf.chain.link/?_ga=2.225785050.1950508783.1645630272-1230768383.1643005305) , 点击 "Create Subscription" 创建 SubscriptionID , 之后可以在 "My Subscriptions" 中看到创建的 SubscriptionID
-<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/14-chainlink-price-feed/ChainLinkVRF.png?raw=true" /></center> 
+<center><img src="./imgs/CreateSubscription.png?raw=true" /></center>  
 
 
 - 保存 SubscriptionID  
 将上一步创建的 SubscriptionID 保存到 .env 文件中 
-<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/14-chainlink-price-feed/SubscriptionID.png?raw=true" /></center>
+
 
 ```sh
 ## .env
@@ -40,20 +42,39 @@ PRIVATE_KEY=xxxxxxxxxxxxxxxx
 INFURA_ID=yyyyyyyy
 ```
 
+- 编译合约
+```
+npx hardhat compile
+
+```
+
+
 - 部署测试合约
 ```
 npx hardhat run scripts/deploy.js --network sepolia
 ```
+ 对于不同测试网络(非sepolia)，请参考[Chain Link: supported-networks](https://docs.chain.link/vrf/v2/subscription/supported-networks)，在./contracts/RandomNumberVRF.sol 中修改vrfCoordinator，link，keyHash的值
+
+- 添加Consumer
+```
+点击进入已经创建好的Subscription，点击“Add Consumer"将上一步骤 deploy 返回合约地址填入, 填入完毕后需要稍等 10s, 此时再刷新页面，可以看到出现配置的consumer地址
+
+```
+<center><img src="./imgs/SubscriptionDetail.png?raw=true" /></center> 
+<center><img src="./imgs/AddConsumer.png?raw=true" /></center> 
 
 - 获取随机数  
 ```
 npx hardhat run scripts/random-number-vrf.js --network sepolia
 ```
 
-- 生成随机  Character  
+requestRandomWords请求发送后，ChainLink回调fulfillRandomWords生成随机数需要一定时间，防止Main 程序运行结束，因此需要设置循环检测是否生成了 RequestFulfilled 事件。
+
+- 随机数获重新获取   
 ```
 npx hardhat run scripts/transaction.js --network sepolia
 ``` 
+RandomWords 随机数生成之后，通过合约传入。./scripts/deployment.json 中保存的 requestID,再次获取之前获取的随机数。可以自定义随机数使用场景，本例只作为调用参考。
 
 ## 参考链接
 github 样例代码:  https://github.com/PatrickAlphaC/dungeons-and-dragons-nft  

basic/15-nft-blindbox-chainlink-vrf/README.md

@@ -8,23 +8,25 @@ This sample code demonstrates how to use ChainLink for NFT blind box design.
 The private key put in **.env** in the format "PRIVATE_KEY= XXXX ", from which the code automatically reads.
 
 - Get Link test coins 
-Every time you go to ChainLink to request VRF random number, you need to consume Link coins. Therefore, you need to apply for Link test coins before the test. For the Goerli test network, go to [Request testnet LINK](https://faucets.chain.link/goerli?_ga=2.35440098.2104755910.1637393798-1377742816.1635817935) , Then "Netwrok" selects "Ethereum Goerli" and "Testnet Account Address "enters the account address corresponding to PRIVATE_KEY in the **.env** file
-![](./images/chainlink.png)
-<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/15-nft-blindbox-chainlink-vrf/chainlink.png?raw=true" /></center>
+Every time you go to ChainLink to request VRF random number, you need to consume Link coins. Therefore, you need to apply for Link test coins before the test. For the Goerli test network, go to [Request testnet LINK](https://faucets.chain.link/goerli?_ga=2.35440098.2104755910.1637393798-1377742816.1635817935) , Then "Netwrok" selects "Ethereum Sepolia" , click "Connect wallet" connect with MeatMask", click "Send Request" for geting 25 Test Link
+<center><img src="./imgs/Ethereum-Sepolia.png?raw=true" /></center>
+<center><img src="./imgs/GetLink.png?raw=true" /></center>
 
 - Install Dependencies
 ```
 npm install 
+
+Node Version：v20.11.0
 ```
 
 - Create ChainLink SubscriptionID  
 Login [ChainLink VRF Test network](https://vrf.chain.link/?_ga=2.225785050.1950508783.1645630272-1230768383.1643005305) , Click on "Create Subscription" to Create a SubscriptionID and you can see the created SubscriptionID under "My Subscriptions"
-<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/14-chainlink-price-feed/ChainLinkVRF.png?raw=true" /></center> 
+<center><img src="./imgs/CreateSubscription.png?raw=true" /></center>  
 
 
 - Save SubscriptionID  
 Save the SubscriptionID created in the previous step to **.env** 
-<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/14-chainlink-price-feed/SubscriptionID.png?raw=true" /></center>
+<center><img src="./imgs/CreateSubscription.png?raw=true" /></center>  
 
 ```sh
 ## .env
@@ -40,20 +42,38 @@ PRIVATE_KEY=xxxxxxxxxxxxxxxx
 INFURA_ID=yyyyyyyy
 ```
 
+- Compile contract
+```
+npx hardhat compile
+```
+
+
 - Deployment test contract
 ```
 npx hardhat run scripts/deploy.js --network sepolia
 ```
+For different test networks (non-sepolia), please refer to [Chain Link: supported-networks](https://docs.chain.link/vrf/v2/subscription/supported-networks), in ./contracts/RandomNumberVRF.sol Modify the values ​​of vrfCoordinator, link, keyHash
+
+- Add Consumer 
+```
+Click to enter the already created Subscription, click "Add Consumer" to fill in the contract address returned by deploy in the previous step. After filling in, you need to wait for 10 seconds. At this time, refresh the page and you can see the configured consumer address.
+
+```
+<center><img src="./imgs/SubscriptionDetail.png?raw=true" /></center> 
+<center><img src="./imgs/AddConsumer.png?raw=true" /></center> 
 
 - Get random number 
 ```
 npx hardhat run scripts/random-number-vrf.js --network sepolia
 ```
+After the requestRandomWords request is sent, it takes a certain amount of time for the ChainLink callback fulfillRandomWords to generate random numbers, which prevents the Main program from ending. Therefore, it is necessary to set up a loop to detect whether the RequestFulfilled event is generated.
 
-- Generate random Character  
+- Get randomword again  
 ```
 npx hardhat run scripts/transaction.js --network sepolia
 ``` 
+RandomWords After the random number is generated, it is passed in through the contract. The requestID saved in ./scripts/deployment.json is used to obtain the random number obtained before. You can customize random number usage scenarios. This example is only used as a calling reference.
+
 
 ## Refer to the link
 Github sample code:  https://github.com/PatrickAlphaC/dungeons-and-dragons-nft  

basic/15-nft-blindbox-chainlink-vrf/contracts/RandomNumberVRF.sol

@@ -2,32 +2,46 @@
 // An example of a consumer contract that relies on a subscription for funding.
 pragma solidity >=0.8.0;
 
-import '@chainlink/contracts/src/v0.8/interfaces/LinkTokenInterface.sol';
+
 import '@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol';
 import '@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol';
+import '@chainlink/contracts/src/v0.8/ConfirmedOwner.sol';
+
+contract RandomNumberVRF is VRFConsumerBaseV2, ConfirmedOwner { 
+   event RequestSent(uint256 requestId, uint32 numWords);
+    event RequestFulfilled(uint256 requestId, uint256[] randomWords);
+
+struct RequestStatus {
+        bool fulfilled; // whether the request has been successfully fulfilled
+        bool exists; // whether a requestId exists
+        uint256[] randomWords;
+    }
+    mapping(uint256 => RequestStatus)
+        public s_requests; /* requestId --> requestStatus */
 
-contract RandomNumberVRF is VRFConsumerBaseV2 {
-    event FulfillRandomness(uint256,uint256[]);
-    event RequestId(address,uint256);
 
     VRFCoordinatorV2Interface COORDINATOR;
-    LinkTokenInterface LINKTOKEN;
+
 
     // Your subscription ID.
     uint64 s_subscriptionId;
 
-    // Goerli coordinator. For other networks,
+       // past requests Id.
+    uint256[] public requestIds;
+    uint256 public lastRequestId;
+
+    // sepolia coordinator. For other networks,
     // see https://docs.chain.link/docs/vrf-contracts/#configurations
-    address vrfCoordinator = 0x2Ca8E0C643bDe4C2E08ab1fA0da3401AdAD7734D;
+    address vrfCoordinator = 0x8103B0A8A00be2DDC778e6e7eaa21791Cd364625;
 
-    // Goerli LINK token contract. For other networks,
+    // sepolia LINK token contract. For other networks,
     // see https://docs.chain.link/docs/vrf-contracts/#configurations
-    address link = 0x326C977E6efc84E512bB9C30f76E30c160eD06FB;
+    address link = 0x779877A7B0D9E8603169DdbD7836e478b4624789;
 
     // The gas lane to use, which specifies the maximum gas price to bump to.
     // For a list of available gas lanes on each network,
     // see https://docs.chain.link/docs/vrf-contracts/#configurations
-    bytes32 keyHash = 0x79d3d8832d904592c0bf9818b621522c988bb8b0c05cdc3b15aea1b6e8db0c15;
+    bytes32 keyHash = 0x474e34a077df58807dbe9c96d3c009b23b3c6d0cce433e59bbf5b34f823bc56c;
 
     // Depends on the number of requested values that you want sent to the
     // fulfillRandomWords() function. Storing each word costs about 20,000 gas,
@@ -44,34 +58,52 @@ contract RandomNumberVRF is VRFConsumerBaseV2 {
     // Cannot exceed VRFCoordinatorV2.MAX_NUM_WORDS.
     uint32 numWords = 2;
 
-    uint256[] public s_randomWords;
-    uint256 public s_requestId;
-    address s_owner;
-
-    constructor(uint64 subscriptionId) VRFConsumerBaseV2(vrfCoordinator) {
+    constructor(uint64 subscriptionId) VRFConsumerBaseV2(vrfCoordinator) 
+       ConfirmedOwner(msg.sender)
+        {
         COORDINATOR = VRFCoordinatorV2Interface(vrfCoordinator);
-        LINKTOKEN = LinkTokenInterface(link);
-        s_owner = msg.sender;
+       
         s_subscriptionId = subscriptionId;
     }
 
     // Assumes the subscription is funded sufficiently.
-    function requestRandomWords() external onlyOwner {
+    function requestRandomWords() external 
+         onlyOwner 
+    returns (uint256 requestId)
+         {
         // Will revert if subscription is not set and funded.
-        s_requestId = COORDINATOR.requestRandomWords(keyHash, s_subscriptionId, requestConfirmations, callbackGasLimit, numWords);
-        emit RequestId(msg.sender,s_requestId);
+        requestId = COORDINATOR.requestRandomWords(
+            keyHash, 
+            s_subscriptionId, 
+            requestConfirmations, 
+            callbackGasLimit,
+            numWords);
+         s_requests[requestId] = RequestStatus({
+            randomWords: new uint256[](0),
+            exists: true,
+            fulfilled: false
+         });
+        requestIds.push(requestId);
+        lastRequestId = requestId;
+       emit RequestSent(requestId, numWords);
+       return requestId;
     }
 
     function fulfillRandomWords(
-        uint256, /* requestId */
-        uint256[] memory randomWords
+        uint256 _requestId,  /* requestId */
+        uint256[] memory _randomWords
     ) internal override {
-        s_randomWords = randomWords;
-        emit FulfillRandomness(s_requestId,s_randomWords);
-    }
+        require(s_requests[_requestId].exists, "request not found");
+        s_requests[_requestId].fulfilled = true;
+        s_requests[_requestId].randomWords = _randomWords;
+        emit RequestFulfilled(_requestId, _randomWords);
+         }
 
-    modifier onlyOwner() {
-        require(msg.sender == s_owner);
-        _;
+   function getRequestStatus(
+        uint256 _requestId
+    ) external view returns (bool fulfilled, uint256[] memory randomWords) {
+        require(s_requests[_requestId].exists, "request not found");
+        RequestStatus memory request = s_requests[_requestId];
+        return (request.fulfilled, request.randomWords);
     }
 }

basic/15-nft-blindbox-chainlink-vrf/hardhat.config.js

@@ -1,7 +1,16 @@
 require("@nomicfoundation/hardhat-toolbox");
 require('dotenv').config();
+require("@nomicfoundation/hardhat-verify");
 
 /** @type import('hardhat/config').HardhatUserConfig */
+
+task("accounts", "Prints the list of accounts", async () => {
+  const accounts = await ethers.getSigners();
+  
+  for (const account of accounts) {
+    console.log(account.address);
+  }
+});
 function mnemonic() {
 
   return process.env.PRIVATE_KEY
@@ -36,6 +45,7 @@ module.exports = {
     sepolia: {
       url: 'https://sepolia.infura.io/v3/' + process.env.INFURA_ID, //<---- CONFIG YOUR INFURA ID IN .ENV! (or it won't work)
       accounts: [mnemonic()],
+      chainId: 11155111,
     },
     mainnet: {
       url: "https://mainnet.infura.io/v3/" + process.env.INFURA_ID, //<---- YOUR INFURA ID! (or it won't work)
@@ -45,6 +55,6 @@ module.exports = {
     },
   },
   etherscan: {
-    apiKey: "1324"
+    apiKey: process.env.APIKEY
   }
 };

basic/15-nft-blindbox-chainlink-vrf/imgs/AddConsumer.png

@@ -10,10 +10,12 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@chainlink/contracts": "^0.4.0",
+    "@chainlink/contracts": "^0.4.2",
+    "@nomiclabs/hardhat-etherscan": "^3.1.8",
     "@openzeppelin/contracts": "^4.5.0",
     "dotenv": "^16.4.5",
-    "hardhat": "^2.22.2"
+    "hardhat": "^2.22.2",
+    "hardhat-contract-sizer": "^2.10.0"
   },
   "devDependencies": {
     "@nomicfoundation/hardhat-toolbox": "^5.0.0"

basic/15-nft-blindbox-chainlink-vrf/imgs/AddFunds.png

@@ -5,17 +5,19 @@ const { saveDeployment } = require('./utils');
 
 async function main() {
     // We get the contract to deploy
-    const Dnd = await ethers.getContractFactory("DungeonsAndDragonsCharacter");
+    const RnvContractFactory = await ethers.getContractFactory("RandomNumberVRF");
 
-    const dnd = await Dnd.deploy(process.env.SubscriptionId, "http://81.69.8.95/WaterMarginJson/");
+    const rnv = await RnvContractFactory.deploy(process.env.SubscriptionId);
+    
+    console.log("deploying....");
 
-    await dnd.waitForDeployment()
+    await rnv.waitForDeployment()
 
-    console.log("dnd deployed to:", dnd.target);
+    console.log("rnv deployed to:", rnv.target);
 
     // save contract address to file
     saveDeployment({
-      dndAddress: dnd.target,
+      rnvAddress: rnv.target,
     });
 
 }