Michael.W基于Foundry精读Openzeppelin

2024年08月13日更新 120 人订阅
专栏简介 Michael.W基于Foundry精读Openzeppelin第8期——Context.sol Michael.W基于Foundry精读Openzeppelin第1期——Address.sol Michael.W基于Foundry精读Openzeppelin第2期——StorageSlot.sol Michael.W基于Foundry精读Openzeppelin第3期——Arrays.sol Michael.W基于Foundry精读Openzeppelin第4期——Base64.sol Michael.W基于Foundry精读Openzeppelin第5期——Counters.sol Michael.W基于Foundry精读Openzeppelin第6期——Strings.sol Michael.W基于Foundry精读Openzeppelin第7期——Timers.sol Michael.W基于Foundry精读Openzeppelin第9期——Multicall.sol Michael.W基于Foundry精读Openzeppelin第10期——Create2.sol Michael.W基于Foundry精读Openzeppelin第11期——Math.sol Michael.W基于Foundry精读Openzeppelin第12期——SafeCast.sol Michael.W基于Foundry精读Openzeppelin第13期——Checkpoints.sol Michael.W基于Foundry精读Openzeppelin第14期——SafeMath.sol Michael.W基于Foundry精读Openzeppelin第15期——SignedMath.sol Michael.W基于Foundry精读Openzeppelin第16期——SignedSafeMath.sol Michael.W基于Foundry精读Openzeppelin第17期——BitMaps.sol Michael.W基于Foundry精读Openzeppelin第18期——DoubleEndedQueue.sol Michael.W基于Foundry精读Openzeppelin第19期——EnumerableSet.sol Michael.W基于Foundry精读Openzeppelin第20期——EnumerableMap.sol Michael.W基于Foundry精读Openzeppelin第21期——ERC165.sol (番外篇)Michael.W基于Foundry精读Openzeppelin第22期——内联汇编staticcall Michael.W基于Foundry精读Openzeppelin第23期——ERC165Checker.sol Michael.W基于Foundry精读Openzeppelin第24期——ERC165Storage.sol Michael.W基于Foundry精读Openzeppelin第25期——IERC1820Registry.sol Michael.W基于Foundry精读Openzeppelin第26期——ERC1820Implementer.sol Michael.W基于Foundry精读Openzeppelin第27期——Escrow.sol Michael.W基于Foundry精读Openzeppelin第28期——ConditionalEscrow.sol Michael.W基于Foundry精读Openzeppelin第29期——RefundEscrow.sol Michael.W基于Foundry精读Openzeppelin第30期——ECDSA.sol Michael.W基于Foundry精读Openzeppelin第31期——IERC1271.sol Michael.W基于Foundry精读Openzeppelin第32期——SignatureChecker.sol Michael.W基于Foundry精读Openzeppelin第33期——EIP712.sol Michael.W基于Foundry精读Openzeppelin第34期——MerkleProof.sol Michael.W基于Foundry精读Openzeppelin第35期——Ownable.sol Michael.W基于Foundry精读Openzeppelin第36期——Ownable2Step.sol Michael.W基于Foundry精读Openzeppelin第37期——AccessControl.sol Michael.W基于Foundry精读Openzeppelin第38期——AccessControlEnumerable.sol Michael.W基于Foundry精读Openzeppelin第39期——ERC20.sol Michael.W基于Foundry精读Openzeppelin第40期——ERC20Burnable.sol Michael.W基于Foundry精读Openzeppelin第41期——ERC20Capped.sol Michael.W基于Foundry精读Openzeppelin第42期——draft-ERC20Permit.sol Michael.W基于Foundry精读Openzeppelin第43期——Pausable.sol Michael.W基于Foundry精读Openzeppelin第44期——ERC20Pausable.sol Michael.W基于Foundry精读Openzeppelin第45期——ERC20FlashMint.sol Michael.W基于Foundry精读Openzeppelin第46期——ERC20Snapshot.sol Michael.W基于Foundry精读Openzeppelin第47期——SafeERC20.sol Michael.W基于Foundry精读Openzeppelin第48期——TokenTimelock.sol Michael.W基于Foundry精读Openzeppelin第49期——ERC20Wrapper.sol Michael.W基于Foundry精读Openzeppelin第50期——ERC20Votes.sol Michael.W基于Foundry精读Openzeppelin第51期——ERC20VotesComp.sol Michael.W基于Foundry精读Openzeppelin第52期——ERC4626.sol Michael.W基于Foundry精读Openzeppelin第53期——ERC20PresetFixedSupply.sol Michael.W基于Foundry精读Openzeppelin第54期——ERC20PresetMinterPauser.sol Michael.W基于Foundry精读Openzeppelin第55期——PaymentSplitter.sol Michael.W基于Foundry精读Openzeppelin第56期——VestingWallet.sol Michael.W基于Foundry精读Openzeppelin第57期——ReentrancyGuard.sol Michael.W基于Foundry精读Openzeppelin第58期——PullPayment.sol Michael.W基于Foundry精读Openzeppelin第59期——Proxy.sol Michael.W基于Foundry精读Openzeppelin第60期——Clones.sol Michael.W基于Foundry精读Openzeppelin第61期——ERC1967Upgrade.sol Michael.W基于Foundry精读Openzeppelin第62期——ERC1967Proxy.sol Michael.W基于Foundry精读Openzeppelin第63期——Initializable.sol Michael.W基于Foundry精读Openzeppelin第64期——UUPSUpgradeable.sol Michael.W基于Foundry精读Openzeppelin第65期——TransparentUpgradeableProxy.sol Michael.W基于Foundry精读Openzeppelin第66期——ProxyAdmin.sol Michael.W基于Foundry精读Openzeppelin第67期——BeaconProxy.sol Michael.W基于Foundry精读Openzeppelin第68期——UpgradeableBeacon.sol

Michael.W基于Foundry精读Openzeppelin第27期——Escrow.sol

  • Michael.W
  • 发布于 2023-08-15 21:26
  • 阅读 2396

Escrow合约是Openzeppelin中所有escrow拓展库的基础合约,用于为指定地址锁存eth和提取eth的托管场景。该合约中存入和取出eth的方法都被virtual修饰,开发者可以通过继承重写的方式来做相关修改。

0. 版本

[openzeppelin]:v4.8.3,[forge-std]:v1.5.6

0.1 Escrow.sol

Github: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.3/contracts/utils/escrow/Escrow.sol

Escrow合约是Openzeppelin中所有escrow拓展库的基础合约,用于为指定地址锁存eth和提取eth的托管场景。该合约中存入和取出eth的方法都被virtual修饰,开发者可以通过继承重写的方式来做相关修改。

1. 目标合约

Escrow本身就是一个contract(非abstract contract),可独立部署和调用。

全部foundry测试合约:

Github: https://github.com/RevelationOfTuring/foundry-openzeppelin-contracts/blob/master/test/utils/escrow/Escrow.t.sol

2. 代码精读

2.1 depositsOf(address payee) && deposit(address payee)

  • depositsOf(address payee):查询输入的payee当前名下的deposit累计值;
  • deposit(address payee):合约owner将eth转入合约作为输入的payee的本次deposit值。合约owner可以多次给相同的payee进行deposit操作,合约内部会进行累积存储。
    // 使用Address库,用于合约向地址转eth
    using Address for address payable;

    event Deposited(address indexed payee, uint256 weiAmount);
    event Withdrawn(address indexed payee, uint256 weiAmount);
    // 用于存储每个payee名下累计deposit值的mapping
    mapping(address => uint256) private _deposits;

    function depositsOf(address payee) public view returns (uint256) {
        // _deposits中key为payee对应的value即是待查询payee名下累计的deposit值
        return _deposits[payee];
    }

    function deposit(address payee) public payable virtual onlyOwner {
        // 本次转入合约的eth值
        uint256 amount = msg.value;
        // 在_deposits中做累加
        _deposits[payee] += amount;
        // 抛出event
        emit Deposited(payee, amount);
    }

2.2 withdraw(address payable payee)

合约owner将合约内payee名下的全部deposit累计值提给payee。

注:该方法内部从合约向payee地址发送eth的过程没有做防重入的限制,可以根据需求添加防重入锁ReentrancyGuard

    function withdraw(address payable payee) public virtual onlyOwner {
        // 获取该payee的deposit累计值
        uint256 payment = _deposits[payee];
    // 合约内部记录的该payee的deposit累计值清零
        _deposits[payee] = 0;
    // 从合约向payee发送对应数额的eth
        payee.sendValue(payment);
    // 抛出event
        emit Withdrawn(payee, payment);
    }

2.3 foundry代码验证

contract EscrowTest is Test {
    Escrow e = new Escrow();
    address payable payee = payable(address(1024));
    address other = address(2048);

    // copy events from Escrow.sol to do event assertion
    event Deposited(address indexed payee, uint256 weiAmount);
    event Withdrawn(address indexed payee, uint256 weiAmount);

    function setUp() external {
        // change balance of the owner
        vm.deal(address(this), 10 ether);
        // change balance of other
        vm.deal(other, 10 ether);
    }

    function test_DepositAndDepositsOf() external {
        // check owner
        address owner = address(this);
        assertEq(owner, e.owner());

        // check depositOf() before deposit
        assertEq(0, e.depositsOf(payee));

        // check event
        vm.expectEmit(address(e));
        emit Deposited(payee, 1 ether);
        // deposit
        e.deposit{value : 1 ether}(payee);
        // check balances
        assertEq(address(e).balance, 1 ether);
        assertEq(owner.balance, 10 ether - 1 ether);
        // check depositOf() after deposit
        assertEq(1 ether, e.depositsOf(payee));

        // deposit again
        e.deposit{value : 2 ether}(payee);
        // check balances
        assertEq(address(e).balance, 1 ether + 2 ether);
        assertEq(owner.balance, 10 ether - 1 ether - 2 ether);
        assertEq(1 ether + 2 ether, e.depositsOf(payee));

        // revert if not owner
        vm.prank(other);
        vm.expectRevert("Ownable: caller is not the owner");
        e.deposit{value : 1 ether}(payee);
    }

    function test_Withdraw() external {
        e.deposit{value : 1 ether}(payee);
        // check before withdraw
        assertEq(1 ether, address(e).balance);
        assertEq(0, payee.balance);

        // check event
        vm.expectEmit(address(e));
        emit Withdrawn(payee, 1 ether);
        // withdraw
        e.withdraw(payee);

        // check before withdraw
        assertEq(0, address(e).balance);
        assertEq(1 ether, payee.balance);

        // revert if not owner
        vm.prank(other);
        vm.expectRevert("Ownable: caller is not the owner");
        e.withdraw(payee);
    }
}

ps: 本人热爱图灵,热爱中本聪,热爱V神。 以下是我个人的公众号,如果有技术问题可以关注我的公众号来跟我交流。 同时我也会在这个公众号上每周更新我的原创文章,喜欢的小伙伴或者老伙计可以支持一下! 如果需要转发,麻烦注明作者。十分感谢!

1.jpeg

公众号名称:后现代泼痞浪漫主义奠基人

点赞 0
收藏 0
分享
本文参与登链社区写作激励计划 ,好文好收益,欢迎正在阅读的你也加入。

0 条评论

请先 登录 后评论