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第16期——SignedSafeMath.sol

  • Michael.W
  • 发布于 2023-07-31 09:38
  • 阅读 2277

SignedSafeMath库就是直接对solidity内置的int256类型的加减乘除运算的函数封装。

0. 版本

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

0.1 SignedSafeMath.sol

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

SignedSafeMath库就是直接对solidity内置的int256类型的加减乘除运算的函数封装。

注:从solidity 0.8版本开始,SignedSafeMath已经不再被广泛使用。因为从0.8版本开始,solidity编译器已经内置了运算符的溢出检查。

1. 目标合约

封装SignedSafeMath library成为一个可调用合约:

Github: https://github.com/RevelationOfTuring/foundry-openzeppelin-contracts/blob/master/src/utils/math/MockSignedSafeMath.sol

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.0;

import "openzeppelin-contracts/contracts/utils/math/SignedSafeMath.sol";

contract MockSignedSafeMath {
    using SignedSafeMath for int;

    function mul(int a, int b) external pure returns (int) {
        return a.mul(b);
    }

    function div(int a, int b) external pure returns (int){
        return a.div(b);
    }

    function sub(int a, int b) external pure returns (int){
        return a.sub(b);
    }

    function add(int a, int b) external pure returns (int) {
        return a.add(b);
    }
}

全部foundry测试合约:

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

2. 代码精读

2.1 mul(int256 a, int256 b)

返回两个int256的乘积,如果产生溢出会revert。

    function mul(int256 a, int256 b) internal pure returns (int256) {
        // 是直接对a*b的函数封装,返回a与b的乘积
        return a * b;
    }

foundry代码验证

contract SignedSafeMathTest is Test {
    MockSignedSafeMath mssm = new MockSignedSafeMath();

    function test_Mul() external {
        assertEq(mssm.mul(3, 2), 6);
        assertEq(mssm.mul(3, - 2), - 6);
        assertEq(mssm.mul(- 3, 2), - 6);
        assertEq(mssm.mul(- 3, - 2), 6);
        // overflow
        vm.expectRevert();
        mssm.mul(type(int).max, 2);
        vm.expectRevert();
        mssm.mul(type(int).min, 2);
    }
}

2.2 div(int256 a, int256 b)

返回两个int256的商,如果除数为0会revert。

注:计算结果向0取整。

    function div(int256 a, int256 b) internal pure returns (int256) {
        // 是直接对a/b的函数封装,返回a与b的商
        return a / b;
    }

foundry代码验证

contract SignedSafeMathTest is Test {
    MockSignedSafeMath mssm = new MockSignedSafeMath();

    function test_Div() external {
        assertEq(mssm.div(3, 2), 1);
        assertEq(mssm.div(3, - 2), - 1);
        assertEq(mssm.div(- 3, 2), - 1);
        assertEq(mssm.div(- 3, - 2), 1);
        // overflow
        vm.expectRevert();
        mssm.div(1, 0);
    }
}

2.3 sub(int256 a, int256 b)

返回两个int256的差,如果产生溢出会revert

    function sub(int256 a, int256 b) internal pure returns (int256) {
        // 是直接对a-b的函数封装,返回a与b的差
        return a - b;
    }

foundry代码验证

contract SignedSafeMathTest is Test {
    MockSignedSafeMath mssm = new MockSignedSafeMath();

    function test_Sub() external {
        assertEq(mssm.sub(3, 2), 1);
        assertEq(mssm.sub(3, - 2), 5);
        assertEq(mssm.sub(- 3, 2), - 5);
        assertEq(mssm.sub(- 3, - 2), - 1);
        // overflow
        vm.expectRevert();
        mssm.sub(type(int).min, 1);
    }
}

2.4 add(int256 a, int256 b)

返回两个int256的和,如果产生溢出会revert。

    function add(int256 a, int256 b) internal pure returns (int256) {
        // 是直接对a+b的函数封装,返回a与b的和
        return a + b;
    }

foundry代码验证

contract SignedSafeMathTest is Test {
    MockSignedSafeMath mssm = new MockSignedSafeMath();

    function test_Add() external {
        assertEq(mssm.add(1, 2), 3);
        assertEq(mssm.add(- 1, 2), 1);
        assertEq(mssm.add(- 1, - 2), - 3);
        // overflow
        vm.expectRevert();
        mssm.add(type(int).max, 1);
    }
}

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

1.jpeg

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

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

0 条评论

请先 登录 后评论