fix readme

Author: longdacao

basic/42-merkle-distributor-airdrop/README.md

@@ -113,40 +113,61 @@ npx hardhat test
 cp .env.exmpale .env
 
 ## 在 .env 文件中配置 PRIVATE_KEY, INFURA_ID, PROJECT_ID, TARGET_ACCOUNT
-## 其中 TARGET_ACCOUNT 为可以领取红包的账户地址 
+## 比如有一个账户 A , 那么 PRIVATE_KEY 为账户 A 对应的 PRIVATE_KEY， TARGET_ACCOUNT 为账户 A 对应的账户地址 
 ```
 
+- 配置 redpacketAddressList 
+因为红包领取时会进行 Merkle 校验, 所以需要在 Merkle List 中配置对应的账户地址.  
+修改 scripts/redpacket/redpacketAddressList.json 文件，在其中加入上一步操作中 "TARGET_ACCOUNT" 的值.  
+
 - 安装依赖  
 ```shell
 yarn
 ```
 
 - 部署 ERC20 合约  
+执行如下命令，然后获取输出的 "Token address" 值
 ```shell
-npx hardhat run scripts/redpacket/1-deploySimpleToken --network kovan
+npx hardhat run scripts/redpacket/1-deploySimpleToken.js --network kovan
+
+## 输入信息如下: 
+Deploying contracts with the account: 0x3238f24e7C752398872B768Ace7dd63c54CfEFEc
+Account balance: 796474026501725149
+Token address: 0xdc6999dC3f818B4f74550569CCC7C82091cA419F
+1000000000
 ```
 
 - 部署 RedPacket 合约  
+执行如下命令，然后获取输出的 "RedPacket address" 值
 ```shell
-npx hardhat run scripts/redpacket/2-deployHappyRedPacket --network kovan 
+npx hardhat run scripts/redpacket/2-deployHappyRedPacket.js --network kovan 
+
+## 输出信息如下:
+Deploying contracts with the account: 0x3238f24e7C752398872B768Ace7dd63c54CfEFEc
+Account balance: 783625061469463255
+RedPacket address: 0x6F35e57a7421F5b04DDb47b67453A5a5Be32e58B
 ```
 
-- 创建 红包  
-修改  scripts/redpacket/3-createRedPacket 文件中的 "HappyRedPacketAddress" 和 "SimpleTokenAddress" 地址为上面输出的地址, 然后执行下面的命令
+- 创建红包  
+修改  scripts/redpacket/3-createRedPacket.js 文件中的 "HappyRedPacketAddress" 和 "SimpleTokenAddress" 地址为上面输出的地址, 然后执行下面的命令, 获取输出的 "RedpacketId"
 ```shell
-npx hardhat run scripts/redpacket/3-createRedPacket --network kovan 
+npx hardhat run scripts/redpacket/3-createRedPacket.js --network kovan 
+
+## 输出值  
+Approve Successfully
+merkleTree Root: 0x5cc6f1ff34a2c6f871d40cdc4559468f96a7ec06d7bf6ab0f9b5aeccc9b33154
+CreationSuccess Event, total: 10000   RedpacketId: 0x45eb11e56a1b699f5e99bd16785c84b73a8257c712e0d1f31306ab1e3423b2e0  
+Create Red Packet successfully
 ```
 
-- 进行签名   
+- 领取红包 
+修改 "4-claimRedpacket.js" 文件中的 "HappyRedPacketAddress" 和 "redpacketID" 值为上面的输出值, 然后执行下面的命令进行红包的 claim 
 ```shell
-npx hardhat run scripts/redpacket/4-signMessage
+npx hardhat run scripts/redpacket/4-claimRedpacket.js --network kovan
 
 ## 得到的输出 "Sign Message:" 即为领取红包时需要输入的签名信息，防止恶意领取
 ```
 
-- 领取红包  
-在 Etherscan 上验证合约后，即可通过 Etherscan 调用 claim 方法进行领取  
-
 ## 参考链接
 
 - https://github.com/Anish-Agnihotri/merkle-airdrop-starter

basic/42-merkle-distributor-airdrop/contracts/redpacket/HappyRedPacket.sol

@@ -14,14 +14,15 @@ import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import "@openzeppelin/contracts/utils/math/SafeMath.sol";
 import "@openzeppelin/contracts/proxy/utils/Initializable.sol";
 import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
+import "@openzeppelin/contracts/utils/cryptography/MerkleProof.sol";
 
 contract HappyRedPacket is Initializable {
     using SafeMath for uint256;
 
     struct RedPacket {
         Packed packed;
         mapping(address => uint256) claimed_list;
-        address public_key;
+        bytes32 merkleroot;
         address creator;
     }
 
@@ -68,7 +69,7 @@ contract HappyRedPacket is Initializable {
 
     // Inits a red packet instance
     // _token_type: 0 - ETH  1 - ERC20
-    function create_red_packet (address _public_key, uint _number, bool _ifrandom, uint _duration, 
+    function create_red_packet (bytes32 _merkleroot, uint _number, bool _ifrandom, uint _duration, 
                                 bytes32 _seed, string memory _message, string memory _name,
                                 uint _token_type, address _token_addr, uint _total_tokens) 
     public payable {
@@ -97,7 +98,7 @@ contract HappyRedPacket is Initializable {
             RedPacket storage redp = redpacket_by_id[_id];
             redp.packed.packed1 = wrap1(received_amount, _duration);
             redp.packed.packed2 = wrap2(_token_addr, _number, _token_type, _random_type);
-            redp.public_key = _public_key;
+            redp.merkleroot = _merkleroot;
             redp.creator = msg.sender;
         }
         {
@@ -110,7 +111,7 @@ contract HappyRedPacket is Initializable {
     }
 
     // It takes the signed msg.sender message as verification passcode
-    function claim(bytes32 id, bytes memory signedMsg, address payable recipient) 
+    function claim(bytes32 id, bytes32[] memory proof, address payable recipient) 
     public returns (uint claimed) {
 
         RedPacket storage rp = redpacket_by_id[id];
@@ -121,8 +122,8 @@ contract HappyRedPacket is Initializable {
         uint claimed_number = unbox(packed.packed2, 224, 15);
         require (claimed_number < total_number, "Out of stock");
 
-        address public_key = rp.public_key;
-        require(_verify(signedMsg, public_key), "Verification failed");
+        bytes32 merkleroot = rp.merkleroot;
+        require(MerkleProof.verify(proof, merkleroot, _leaf(msg.sender)), 'Verification failed');
 
         uint256 claimed_tokens;
         uint256 token_type = unbox(packed.packed2, 254, 1);
@@ -159,14 +160,6 @@ contract HappyRedPacket is Initializable {
         return claimed_tokens;
     }
 
-    // as a workaround for "CompilerError: Stack too deep, try removing local variables"
-    function _verify(bytes memory signedMsg, address public_key) private view returns (bool verified) {
-        bytes memory prefix = "\x19Ethereum Signed Message:\n20";
-        bytes32 prefixedHash = keccak256(abi.encodePacked(prefix, msg.sender));
-        address calculated_public_key = ECDSA.recover(prefixedHash, signedMsg);
-        return (calculated_public_key == public_key);
-    }
-
     // Returns 1. remaining value 2. total number of red packets 3. claimed number of red packets
     function check_availability(bytes32 id) external view returns ( address token_address, uint balance, uint total, 
                                                                     uint claimed, bool expired, uint256 claimed_amount) {
@@ -182,6 +175,10 @@ contract HappyRedPacket is Initializable {
         );
     }
 
+    function _leaf(address account) internal pure returns (bytes32){
+        return keccak256(abi.encodePacked(account));
+    }
+
     function refund(bytes32 id) public {
         RedPacket storage rp = redpacket_by_id[id];
         Packed memory packed = rp.packed;

basic/42-merkle-distributor-airdrop/scripts/redpacket/3-createRedPacket.js

@@ -5,13 +5,19 @@
 // Runtime Environment's members available in the global scope.
 const { ethers } = require('hardhat');
 require('dotenv').config();
+const { MerkleTree } = require('merkletreejs');
+const keccak256 = require('keccak256');
+const addresList = require('./redpacketAddressList.json');
+
+function hashToken(account) {
+  return Buffer.from(ethers.utils.solidityKeccak256(['address'], [account]).slice(2), 'hex')
+}
 
 async function main() {
   const [deployer] = await ethers.getSigners();
-  const wallet = new ethers.Wallet(process.env.PRIVATE_KEY);
 
-  const HappyRedPacketAddress = "0x1337ee7C6969692c6153e5e0cEDC637560AC7E5f";
-  const SimpleTokenAddress = "0x26aa59598210AE7613d5Bf3aCB01416fdaf6EBe7";
+  const HappyRedPacketAddress = "0xE9c061465E9eaF01D1c8F9Dfc2487Db31a053bb0";
+  const SimpleTokenAddress = "0xdc6999dC3f818B4f74550569CCC7C82091cA419F";
 
   const redPacket = await ethers.getContractAt("HappyRedPacket", HappyRedPacketAddress, deployer);
   const simpleToken = await ethers.getContractAt("SimpleToken", SimpleTokenAddress, deployer);
@@ -20,11 +26,14 @@ async function main() {
   await tx.wait()
 
   console.log("Approve Successfully");
-  console.log("Public key is: ", wallet.address);
+  
+  merkleTree = new MerkleTree(addresList.map(address => hashToken(address)), keccak256, { sortPairs: true });
+  merkleTreeRoot = merkleTree.getHexRoot();
+  console.log("merkleTree Root:",merkleTreeRoot);
 
   // create_red_packet
   let creationParams = {
-    public_key: wallet.address,
+    merkleroot: merkleTreeRoot,
     number: 3,
     ifrandom: true,
     duration: 2**30,
@@ -38,7 +47,7 @@ async function main() {
 
   redPacket.once('CreationSuccess', ( total,  id,  name,  message,  creator,  creation_time,  token_address,  number,  ifrandom,  duration) => {
     console.log(
-      `CreationSuccess Event, total: ${total}   id: ${id}  `
+      `CreationSuccess Event, total: ${total}   RedpacketId: ${id}  `
     );
   });
 

basic/42-merkle-distributor-airdrop/scripts/redpacket/4-claimRedpacket.js

@@ -0,0 +1,40 @@
+// We require the Hardhat Runtime Environment explicitly here. This is optional
+// but useful for running the script in a standalone fashion through `node <script>`.
+//
+// When running the script with `hardhat run <script>` you'll find the Hardhat
+// Runtime Environment's members available in the global scope.
+const { ethers } = require('hardhat');
+require('dotenv').config();
+const { MerkleTree } = require('merkletreejs');
+const keccak256 = require('keccak256');
+const addresList = require('./redpacketAddressList.json');
+
+function hashToken(account) {
+  return Buffer.from(ethers.utils.solidityKeccak256(['address'], [account]).slice(2), 'hex')
+}
+
+async function main() {
+  const [deployer] = await ethers.getSigners();
+
+  const HappyRedPacketAddress = "0xE9c061465E9eaF01D1c8F9Dfc2487Db31a053bb0";
+  const redPacket = await ethers.getContractAt("HappyRedPacket", HappyRedPacketAddress, deployer);
+  const redpacketID = "0x45eb11e56a1b699f5e99bd16785c84b73a8257c712e0d1f31306ab1e3423b2e0"
+  
+  merkleTree = new MerkleTree(addresList.map(address => hashToken(address)), keccak256, { sortPairs: true });
+  let proof = merkleTree.getHexProof(hashToken(deployer.address));
+  console.log("merkleTree proof: ",proof);
+
+  let createRedPacketRecipt  = await redPacket.claim(redpacketID,proof,deployer.address);
+  await createRedPacketRecipt.wait();
+
+  console.log("Claim Red Packet successfully");
+}
+
+// We recommend this pattern to be able to use async/await everywhere
+// and properly handle errors.
+main()
+  .then(() => process.exit(0))
+  .catch((error) => {
+    console.error(error);
+    process.exit(1);
+  });

basic/42-merkle-distributor-airdrop/scripts/redpacket/4-signMessage.js

@@ -0,0 +1,23 @@
+[
+  "0xa111C225A0aFd5aD64221B1bc1D5d817e5D3Ca15",
+  "0x8de806462823aD25056eE8104101F9367E208C14",
+  "0x801EfbcFfc2Cf572D4C30De9CEE2a0AFeBfa1Ce1",
+  "0x7DdC72Eb160F6A325A5927299b2715Abd0bEA55B",
+  "0x5aB21736841D90fc48D6aA003A7791E62f52692f",
+  "0x940Da56126BE133Ddaa53Fe0FE52B4F42d3f761F",
+  "0x7De3e7f2821ef6310B353c00628D02B57ad661D8",
+  "0x6B831bf30f30701D5595DedDA9873F9F93495FBb",
+  "0x3EE9626735Bc3585D2B4b3B6F604769aB3450593",
+  "0xb0874963aCcA3FD8C3740fC13A9948b89D34B19A",
+  "0x4Ea6D5DF8291E973289C726b2a36836BF232C0D1",
+  "0xa702766f94C9C515722251a8A9FE7Ea9141eE73B",
+  "0x346229540D5849203f84A727636AE4Eb6eA265fD",
+  "0x8Ee432c17f59e5989069B77164a68fbAAcF46A2B",
+  "0xeAE26C61ab4fF2B8e0d38CE3C44b3D115cfB0FDE",
+  "0x30e2326ee1bf319EFA6117E6E6C8Df334243E76d",
+  "0xBcfF64A3f8EE87d8D82B8c9b6D35b150761b430D",
+  "0x0EbDa2F020DA73192F6Ab99c31224b8b1Aa32df8",
+  "0x0904b2214f21bdEc6f567469b57cc9444D4f4DdB",
+  "0x7d33793CFdb315882cfF375096A4c0EF7d3fC0f0",
+  "0x3238f24e7C752398872B768Ace7dd63c54CfEFEc"
+]