Merge pull request #584 from yingjingyang/main

add redpacket contract

Author: liberhe

README.md

@@ -154,8 +154,8 @@ DAPP架构请参考文章--[从架构维度看Web2.0与Web3.0应用之别](https
 47. [TWAMM: Time-Weighted Average Market Maker](https://www.paradigm.xyz/2021/07/twamm/) ⬜
 48. [state channel](https://ethereum.org/en/developers/docs/scaling/state-channels/)  ⬜
 49. [sniper](https://github.com/Supercycled/cake_sniper.git) ⬜
-50. [solidity security](basic/50-solidity-security/readme.md)  ✅
-51. [alchemix](https://github.com/alchemix-finance/alchemix-protocol) ✅
+50. [solidity security](basic/50-solidity-security/readme.md)  ✅  
+51. [NYM](https://myz1237.substack.com/p/nymwhitepaper?r=uaq4w&utm_campaign=post&utm_medium=web&utm_source=) ⬜
 52. [Governace](https://github.com/withtally/safeguard)  ⬜
 53. [Freelancer's Smart Contract](https://github.com/jacksonng77/freelancer) ✅
 54. [Cryptovoxels](https://zhuanlan.zhihu.com/p/379249411) ⬜
@@ -174,7 +174,6 @@ DAPP架构请参考文章--[从架构维度看Web2.0与Web3.0应用之别](https
 68. [Config discord with Collab.land](https://collabland.freshdesk.com/support/solutions/articles/70000036689-discord-bot-walkthrough)  
 69. [Decentralized OTC](https://github.com/DOTCPro)  
 70. [Tenderly](https://dashboard.tenderly.co/explorer)  
-71. [NYM](https://myz1237.substack.com/p/nymwhitepaper?r=uaq4w&utm_campaign=post&utm_medium=web&utm_source=) ⬜
 
 
 ## 项目任务
@@ -214,7 +213,8 @@ DAPP架构请参考文章--[从架构维度看Web2.0与Web3.0应用之别](https
 18. [Set](https://www.tokensets.com/)
 19. [Dhedge](https://docs.dhedge.org/dhedge-protocol/managing-on-v2)
 20. [Liquity](defi/Liquity/readme.md)
-21. [RAI](https://www.youtube.com/watch?v=ADK91Zw4sJA&list=PL-GxJch-YeZerVVV8dY8qU2VkJfbnSfdN&index=3)
+21. [RAI](https://www.youtube.com/watch?v=ADK91Zw4sJA&list=PL-GxJch-YeZerVVV8dY8qU2VkJfbnSfdN&index=3)  
+22. [Alchemix](https://github.com/alchemix-finance/alchemix-protocol) ✅
 
 
 ## NFT 进阶

basic/42-merkle-distributor-airdrop/.env.example

@@ -0,0 +1,4 @@
+PRIVATE_KEY=yyyy
+INFURA_ID=zzzz
+PROJECT_ID=xxxxx
+TARGET_ACCOUNT=mmm

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

@@ -13,7 +13,11 @@
 ### ERC20 merkel airdrop
 
 参考 1inch，dydx，uniswap 都实现 merkle 空投。 具体原理请参考：
-https://itzone.com.vn/en/article/merkle-airdrop-the-airdrop-solution-for-token-issues/
+https://itzone.com.vn/en/article/merkle-airdrop-the-airdrop-solution-for-token-issues/  
+
+### 抢红包    
+本样例演示了抢红包合约的功能, 在节假日的时候可以部署相应的合约进行红包发放.
+对应合约路径为 contracts/redpacket
 
 ## 合约功能说明
 
@@ -90,7 +94,7 @@ await expect(this.registry.redeem(this.token.account, this.token.tokenId, this.t
 ```
 
 ## 测试流程
-
+### Merkle airdrop  
 - 安装依赖
 
 ```bash
@@ -103,6 +107,67 @@ yarn
 npx hardhat test
 ```
 
+### 抢红包  
+- 配置环境环境变量  
+```shell
+cp .env.exmpale .env
+
+## 在 .env 文件中配置 PRIVATE_KEY, INFURA_ID, PROJECT_ID, 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.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.js --network kovan 
+
+## 输出信息如下:
+Deploying contracts with the account: 0x3238f24e7C752398872B768Ace7dd63c54CfEFEc
+Account balance: 783625061469463255
+RedPacket address: 0x6F35e57a7421F5b04DDb47b67453A5a5Be32e58B
+```
+
+- 创建红包  
+修改  scripts/redpacket/3-createRedPacket.js 文件中的 "HappyRedPacketAddress" 和 "SimpleTokenAddress" 地址为上面输出的地址, 然后执行下面的命令, 获取输出的 "RedpacketId"
+```shell
+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-claimRedpacket.js --network kovan
+
+## 得到的输出 "Sign Message:" 即为领取红包时需要输入的签名信息，防止恶意领取
+```
+
 ## 参考链接
 
 - https://github.com/Anish-Agnihotri/merkle-airdrop-starter