devbox
繁依Fanyi0
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

小试牛刀-区块链代币锁仓合约实战_区块链锁仓

作者：繁依Fanyi0 | 2024-05-31 07:56:02

赞

踩

区块链锁仓

目录

1.编写目的

2.概念及开发环境

3.代码详解

3.1 继承接口

3.2 变量定义及构造函数

3.3 功能实现

3.3.1  锁定

3.3.2  解锁

3.3.3  获取锁仓列表

3.3.4 其它方法

4.部署及功能测试

4.1 合约部署地址

4.2 测试请求记录截图

4.3 测试视频​​​​​​​

5.合约代码

1.编写目的

     编写这篇文章的目的是记录一下自己在开发代币合约中的过程,加深自己对合约功能的理解,在后续的学习过程中可以进行资料查阅,以及帮助有这方面开发要求或想学习的朋友进行更方便的入门。

2.概念及开发环境

     区块链的本质是一个分布式记账系统,为保障其安全性使用了加密算法,同时具有数据公开透明、数据去中心化(及数据存在于任意节点上),从而数据安全可靠,防篡改、可追溯。数字代币是区块链的一个具体应用(区块链!=数字代币)。合约及为部署在某个链上的实现某些功能的应用程序,比较著名的是以太坊链。这里将使用以太坊链常用在线开发工具Remix - Ethereum IDE作为开发环境。

3.代码详解

        这里使用的是IBEP20接口作为开发功能性接口,这类似于各种开发语言中的继承,继承后即可使用改接口中上层中已经实现的功能,这种接口有很多如:ERC20、IBEP20等,主要区别为不同链需要实现不同的接口,这里的接口主要实现的功能为代币的相关操作。具体解释如下:

3.1 继承接口

  1. interface IBEP20 {
  2.     function totalSupply() external view returns (uint256);
  3.  
  4.     function balanceOf(address account) external view returns (uint256);
  5.  
  6.     function transfer(address recipient, uint256 amount) external returns (bool);
  7.  
  8.     function allowance(address owner, address spender) external view returns (uint256);
  9.  
  10.     function approve(address spender, uint256 amount) external returns (bool);
  11.  
  12.     function transferFrom(
  13.         address sender,
  14.         address recipient,
  15.         uint256 amount
  16.     ) external returns (bool);
  17.  
  18.     event Transfer(address indexed from, address indexed to, uint256 value);
  19.  
  20.     event Approval(address indexed owner, address indexed spender, uint256 value);
  21. }
  • totalSupply():获取代币总量
  • balanceOf(address account):获取某个地址代币余额
  • transfer(address recipient,uint256 amount):向某个地址转账,这里只有接收者,因此是从合约地址余额向别人转账,amount为数量。
  • allowance(address owner, address spender):查询owner授权spender允许操作的数量。
  • approve(address spender, uint256 amount):授权spender可以转移的代币数量,这里默认的授权者是发送者,注:这里不是指当前合约。
  • transferFrom(address sender,address recipient,uint256 amount):从sender向recipient转账,注:这里recipient需先得到sender的授权。
  • event Transfer(address indexed from, address indexed to, uint256 value):自定义的转账事件,该事件是公开的可以被外部监听,即转账时外部会得到回调通知。
  • event Approval(address indexed owner, address indexed spender, uint256 value):自定义的授权事件,与转账事件相同,也是通知外部发生了授权操作。

3.2 变量定义及构造函数

  1.     IBEP20 private tokenContract;
  2.  
  3.     struct LockInfo {
  4.         uint256 amount;
  5.         uint createTimestamp;
  6.         uint256 unlockTimestamp;
  7.         address owner;
  8.         uint256 lockNo;
  9.     }
  10.     mapping(address=>LockInfo) private lockerBalance;
  11.  
  12.     event TokenLocked(address indexed account, uint256 amount, uint256 lockDuration);
  13.  
  14.     event TokenUnLocked(address indexed account, uint256 amount);
  15.  
  16.     uint256 private lockerPool=0;
  17.  
  18.     address[] private lockerAddresses;
  19.  
  20.     LockInfo[]  private lockerHistoryList;
  21.  
  22.     uint8 constant _decimals = 9;

tokenContract:为关联的代币合约。(因为当前合约只做代币的锁仓功能,相当于依附另一个代币合约只实现功能)

LockInfo:结构体参数,用于存储用户锁定的代币数量(amount)、解锁时间(unlockTimestamp)、owner(拥有者)、创建时间(createTimestamp)、lockNo(锁定编号)

lockerBalance:Map键值对,这里存储owner和LockInfo,目的是在后续操作中可约快速使用地址查询到LockInfo信息(节省算力)

TokenLocked、TokenUnlocked:为自定义事件,用于在用户使用锁定和解锁功能后,提醒用户实现了相关操作。

lockerPool:这里定义为存储锁仓的代币数量。

lockerAddress[]:该列表用于所有存储代币的用户地址.

lockerHistoryList[]:改地址用于存储用户的锁仓历史列表。

(注:这里不使用lockerBalance进行遍历返回也是为了节省算力,更多的算力意味着用户需使用更多的手续费,这将影响用户使用)

_decimals:为小数点位数,这里保留9位小数。

constructor:构造参数,这里会在部署时传入代币地址,从而实现当前合约的初始化。

3.3 功能实现

3.3.1  锁定

  1.     function lockerToken(
  2.         uint256 _amount,
  3.         uint256 _lockDuration
  4.     ) public {
  5.         require(_lockDuration>0,"the lockDuration must be more than 0");
  6.         require(!checkAddressLocked(msg.sender),"this address has locked,pls unlock");
  7.         uint256 lockAmount=_amount*10**_decimals;
  8.         require(tokenContract.balanceOf(msg.sender)>=lockAmount,"Token less amount");
  9.         require(tokenContract.allowance(msg.sender,address(this))>=lockAmount, "Token allowance not");
  10.         require(tokenContract.transferFrom(msg.sender,address(this),lockAmount), "Token transfer failed");
  11.         uint256 unlockTimestamp = block.timestamp + _lockDuration;
  12.         lockerBalance[msg.sender] = LockInfo({
  13.             amount: lockAmount,
  14.             createTimestamp: block.timestamp,
  15.             unlockTimestamp: unlockTimestamp,
  16.             owner:msg.sender,
  17.             lockNo:lockerAddresses.length
  18.         });
  19.         lockerPool+=lockAmount;
  20.         lockerAddresses.push(msg.sender);
  21.         emit TokenLocked(msg.sender, _amount, _lockDuration);   
  22.     }

        传入两个参数分别是锁定数量(_amount)和(_lockDuration)锁定时间。首先对锁定时间进行了检查,使锁定时间必须是>0的数,checkAddressLocked()检查用户是否被锁定,锁定的用户需先解锁才能再次锁定。对锁定数量进行精确度转换,使精确度符合链上精确度。对用户余额的检查,对用户授权的检查(锁定及用户需要当前合约转账,所以需要检查),然后使用transferFrom()请求者会向当前合约进行转移代币.unlockTimestamp为计算出来的过期时间(即当前时间+锁定时间),然后构建LockInfo结构体并放到lockerAddress中,锁仓池代币数量增加,将用户放入锁仓地址列表中。并发布代币锁定事件通知前端页面。

3.3.2  解锁

  1.     function  unLockerToken() public {
  2.         LockInfo memory lockInfo = lockerBalance[msg.sender];
  3.         require(lockInfo.unlockTimestamp <= block.timestamp, "Tokens still locked");
  4.         require(tokenContract.approve(address(this),lockInfo.amount),"unlock approve failed");
  5.         require(tokenContract.transfer(msg.sender, lockInfo.amount), "Token transfer failed");
  6.         require(tokenContract.approve(address(this),0),"unlock approve 0 failed");
  7.         lockerHistoryList.push(lockInfo);
  8.         lockerPool-=lockInfo.amount;
  9.         lockerAddresses[lockInfo.lockNo]=lockerAddresses[lockerAddresses.length-1];
  10.         lockerAddresses.pop();
  11.         delete lockerBalance[msg.sender];
  12.         emit TokenUnLocked(msg.sender, lockInfo.amount);
  13.     }

        解锁会获取当前请求用户的锁定信息即lockInfo,然后判断当前时间是否大于解锁时间,通过后会授权当前合约可约执行转账的数量,然后使用transfer()进行转账,并解除当前合约授权(即使当前合约授权数量为0).将lockInfo添加到历史列表中,使锁仓池数量减去解锁数量,同时将锁仓的当前用户信息进行移除。delete删除锁仓用户的信息.同时发布用户解锁事件通知前端页面。

3.3.3  获取锁仓列表

  1.     function getLockerList() public view returns(LockInfo[] memory) {
  2.         uint256 length = lockerAddresses.length;
  3.         LockInfo[] memory lockInfos = new LockInfo[](length);
  4.         for (uint256 i = 0; i < length; i++) {
  5.             address addr = lockerAddresses[i];
  6.             lockInfos[i] = lockerBalance[addr];
  7.         }
  8.  
  9.         return lockInfos;
  10.     }

        这里首先获取锁定信息的长度,创建返回数据的数组并通过循环的方式获取锁仓信息并进行返回。

3.3.4 其它方法

  1.     function checkLockTimeExpired(address addr) public view returns (bool){
  2.         if (checkAddressLocked(addr)){
  3.             if(lockerBalance[addr].unlockTimestamp<=block.timestamp){
  4.                 return true;
  5.             }
  6.         }
  7.         return false;
  8.     }
  9.     function getLockerHistoryList() public view  returns(LockInfo[] memory){
  10.         return  lockerHistoryList;
  11.     }
  12.  
  13.     function getUserLocker() public view returns(LockInfo memory){
  14.         return lockerBalance[msg.sender];
  15.     }
  16.  
  17.     function getLockerSize() public view returns(uint256){
  18.         return lockerAddresses.length;
  19.     }
  20.  
  21.     function getLockPool() public  view returns(uint256){
  22.         return lockerPool;
  23.     }
  24.  
  25.     function getTimestamp() public view returns(uint256){
  26.         return block.timestamp; 
  27.     }

除了主要功能的锁定、解锁、锁仓列表方法外,这边还编写了如获取锁仓代币数量、检查锁仓时间是否过期、获取锁仓人数、历史列表等方法,因其实现比较简单,这边就不进行记录了。

4.部署及功能测试


4.1 合约部署地址

BabyBonkLocker | Address 0x285387e8286e351047464750127142ed322a0a7f | BscScan


4.2 测试请求记录截图

4.3 测试视频​​​​​​​

这边后面会开放界面代码,请关注更新!!!!

录屏_选择区域_20240225093939

5.合约代码

  1. /**
  2.  *Submitted for verification at BscScan.com on 2024-02-01
  3. */
  4.  
  5. // SPDX-License-Identifier: MIT
  6. pragma solidity ^0.8.22;
  7.  
  8. interface IBEP20 {
  9.     function totalSupply() external view returns (uint256);
  10.  
  11.     function balanceOf(address account) external view returns (uint256);
  12.  
  13.     function transfer(address recipient, uint256 amount) external returns (bool);
  14.  
  15.     function allowance(address owner, address spender) external view returns (uint256);
  16.  
  17.     function approve(address spender, uint256 amount) external returns (bool);
  18.  
  19.     function transferFrom(
  20.         address sender,
  21.         address recipient,
  22.         uint256 amount
  23.     ) external returns (bool);
  24.  
  25.     event Transfer(address indexed from, address indexed to, uint256 value);
  26.  
  27.     event Approval(address indexed owner, address indexed spender, uint256 value);
  28. }
  29. abstract contract Context {
  30.     function _msgSender() internal view virtual returns (address) {
  31.         return msg.sender;
  32.     }
  33.  
  34.     function _msgData() internal view virtual returns (bytes calldata) {
  35.         this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
  36.         return msg.data;
  37.     }
  38. }
  39.  
  40. abstract contract Ownable is Context {
  41.     address private _owner;
  42.  
  43.     event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
  44.  
  45.     constructor() {
  46.         _setOwner(_msgSender());
  47.     }
  48.  
  49.     function owner() public view virtual returns (address) {
  50.         return _owner;
  51.     }
  52.  
  53.     modifier onlyOwner() {
  54.         require(owner() == _msgSender(), "Ownable: caller is not the owner");
  55.         _;
  56.     }
  57.  
  58.     function renounceOwnership() public virtual onlyOwner {
  59.         _setOwner(address(0));
  60.     }
  61.  
  62.     function transferOwnership(address newOwner) public virtual onlyOwner {
  63.         require(newOwner != address(0), "Ownable: new owner is the zero address");
  64.         _setOwner(newOwner);
  65.     }
  66.  
  67.     function _setOwner(address newOwner) private {
  68.         address oldOwner = _owner;
  69.         _owner = newOwner;
  70.         emit OwnershipTransferred(oldOwner, newOwner);
  71.     }
  72. }
  73. contract BabyBonkLocker is Context, Ownable{
  74.     
  75.     IBEP20 private tokenContract;
  76.  
  77.     struct LockInfo {
  78.         uint256 amount;
  79.         uint createTimestamp;
  80.         uint256 unlockTimestamp;
  81.         address owner;
  82.         uint256 lockNo;
  83.     }
  84.     mapping(address=>LockInfo) private lockerBalance;
  85.  
  86.     event TokenLocked(address indexed account, uint256 amount, uint256 lockDuration);
  87.  
  88.     event TokenUnLocked(address indexed account, uint256 amount);
  89.  
  90.     uint256 private lockerPool=0;
  91.  
  92.     address[] private lockerAddresses;
  93.  
  94.     LockInfo[]  private lockerHistoryList;
  95.  
  96.     uint8 constant _decimals = 9;
  97.  
  98.  
  99.     constructor(
  100.         address payable _token
  101.     ){
  102.         tokenContract=IBEP20(_token);
  103.     }
  104.     function lockerToken(
  105.         uint256 _amount,
  106.         uint256 _lockDuration
  107.     ) public {
  108.         require(_lockDuration>0,"the lockDuration must be more than 0");
  109.         require(!checkAddressLocked(msg.sender),"this address has locked,pls unlock");
  110.         uint256 lockAmount=_amount*10**_decimals;
  111.         require(tokenContract.balanceOf(msg.sender)>=lockAmount,"Token less amount");
  112.         require(tokenContract.allowance(msg.sender,address(this))>=lockAmount, "Token allowance not");
  113.         require(tokenContract.transferFrom(msg.sender,address(this),lockAmount), "Token transfer failed");
  114.         uint256 unlockTimestamp = block.timestamp + _lockDuration;
  115.         lockerBalance[msg.sender] = LockInfo({
  116.             amount: lockAmount,
  117.             createTimestamp: block.timestamp,
  118.             unlockTimestamp: unlockTimestamp,
  119.             owner:msg.sender,
  120.             lockNo:lockerAddresses.length
  121.         });
  122.         lockerPool+=lockAmount;
  123.         lockerAddresses.push(msg.sender);
  124.         emit TokenLocked(msg.sender, _amount, _lockDuration);   
  125.     }
  126.  
  127.     function  unLockerToken() public {
  128.         LockInfo memory lockInfo = lockerBalance[msg.sender];
  129.         require(lockInfo.unlockTimestamp <= block.timestamp, "Tokens still locked");
  130.         require(tokenContract.approve(address(this),lockInfo.amount),"unlock approve failed");
  131.         require(tokenContract.transfer(msg.sender, lockInfo.amount), "Token transfer failed");
  132.         require(tokenContract.approve(address(this),0),"unlock approve 0 failed");
  133.         lockerHistoryList.push(lockInfo);
  134.         lockerPool-=lockInfo.amount;
  135.         lockerAddresses[lockInfo.lockNo]=lockerAddresses[lockerAddresses.length-1];
  136.         lockerAddresses.pop();
  137.         delete lockerBalance[msg.sender];
  138.         emit TokenUnLocked(msg.sender, lockInfo.amount);
  139.     }
  140.     function checkAddressLocked(address addr) public  view returns (bool) {
  141.         return lockerBalance[addr].unlockTimestamp !=0;
  142.     }
  143.  
  144.     function getLockerList() public view returns(LockInfo[] memory) {
  145.         uint256 length = lockerAddresses.length;
  146.         LockInfo[] memory lockInfos = new LockInfo[](length);
  147.         for (uint256 i = 0; i < length; i++) {
  148.             address addr = lockerAddresses[i];
  149.             lockInfos[i] = lockerBalance[addr];
  150.         }
  151.  
  152.         return lockInfos;
  153.     }
  154.     function checkLockTimeExpired(address addr) public view returns (bool){
  155.         if (checkAddressLocked(addr)){
  156.             if(lockerBalance[addr].unlockTimestamp<=block.timestamp){
  157.                 return true;
  158.             }
  159.         }
  160.         return false;
  161.     }
  162.     function getLockerHistoryList() public view  returns(LockInfo[] memory){
  163.         return  lockerHistoryList;
  164.     }
  165.  
  166.     function getUserLocker() public view returns(LockInfo memory){
  167.         return lockerBalance[msg.sender];
  168.     }
  169.  
  170.     function getLockerSize() public view returns(uint256){
  171.         return lockerAddresses.length;
  172.     }
  173.  
  174.     function getLockPool() public  view returns(uint256){
  175.         return lockerPool;
  176.     }
  177.  
  178.     function getTimestamp() public view returns(uint256){
  179.         return block.timestamp; 
  180.     }
  181.  
  182. }

注:单纯的兴趣爱好和学习过程,其中不涉及任何其它的如投资理财方面的建议。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/繁依Fanyi0/article/detail/651213
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号