Michael.W基于Foundry精读Openzeppelin

2024年08月13日更新 117 人订阅
专栏简介 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第15期——SignedMath.sol

  • Michael.W
  • 发布于 2023-07-30 01:36
  • 阅读 2793

SignedMath库提供了solidity中尚未内置的标准有符号数的数学运算方法。

0. 版本

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

0.1 SignedMath.sol

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

SignedMath库提供了solidity中尚未内置的标准有符号数的数学运算方法。

1. 目标合约

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

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

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

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

contract MockSignedMath {
    using SignedMath for int;

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

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

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

    function abs(int n) external pure returns (uint) {
        return n.abs();
    }
}

全部foundry测试合约:

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

2. 代码精读

2.1 max(int256 a, int256 b) && min(int256 a, int256 b)

  • max(int256 a, int256 b):求两个有符号数中的最大值;
  • min(int256 a, int256 b):求两个有符号数中的最小值。
    function max(int256 a, int256 b) internal pure returns (int256) {
        // 通过三元运算符来求二者中的最大值
        return a > b ? a : b;
    }

    function min(int256 a, int256 b) internal pure returns (int256) {
        // 通过三元运算符来求二者中的最小值
        return a < b ? a : b;
    }

foundry代码验证

contract SignedMathTest is Test {
    MockSignedMath msm = new MockSignedMath();

    function test_Max() external {
        assertEq(msm.max(1, 2), 2);
        assertEq(msm.max(- 1, - 2), - 1);
        assertEq(msm.max(- 1, 1), 1);
        assertEq(msm.max(- 1, 0), 0);
        assertEq(msm.max(1, 0), 1);
    }

    function test_Min() external {
        assertEq(msm.min(1, 2), 1);
        assertEq(msm.min(- 1, - 2), - 2);
        assertEq(msm.min(- 1, 1), - 1);
        assertEq(msm.min(- 1, 0), - 1);
        assertEq(msm.min(1, 0), 0);
    }
}

2.2 average(int256 a, int256 b)

求两个有符号整数的平均值,结果向零取整。

注:对比传统解法(a+b)/2,本方法不会在a和b足够大或足够小时产生溢出。

    function average(int256 a, int256 b) internal pure returns (int256) {
        // 具体位运算的数学依据参见书籍《Hacker's Delight》:https://baike.baidu.com/item/Hacker%27s%20Delight/6927658?fr=ge_ala
        // x为a&b与(a^b)/2的和。为两个uint256求均值的方法。详情见:https://learnblockchain.cn/article/6191中的2.4——average(uint256, uint256)
        int256 x = (a & b) + ((a ^ b) >> 1);
        // uint256(x) >> 255:将前面计算得出的x转成uint256后右移255位得到符号位。即如果x为负数则为1,如果未非负数则为0。
        // 将上述符号位转换成int256,并与a^b的结果做与运算。返回x与上述运算结果的和(即两个有符号数的均值)
        return x + (int256(uint256(x) >> 255) & (a ^ b));
    }

foundry代码验证

contract SignedMathTest is Test {
    MockSignedMath msm = new MockSignedMath();

    function test_Average() external {
        assertEq(msm.average(2, 4), 3);
        assertEq(msm.average(2, 3), 2);
        assertEq(msm.average(type(int).max, type(int).max - 2), type(int).max - 1);
        assertEq(msm.average(type(int).min, type(int).min + 2), type(int).min + 1);
    }
}

2.3 abs(int256 n)

求一个int256的绝对值

    function abs(int256 n) internal pure returns (uint256) {
        // 关闭solidity 0.8的整数运算溢出检查。为了当n为type(int).min时不发生溢出错误
        unchecked {
            // 如果n不是负数,返回uint256(n)。否则返回uint256(-n)
            return uint256(n >= 0 ? n : -n);
        }
    }

foundry代码验证

contract SignedMathTest is Test {
    MockSignedMath msm = new MockSignedMath();

    function test_Abs() external {
        assertEq(msm.abs(0), 0);
        assertEq(msm.abs(- 1), 1);
        assertEq(msm.abs(1), 1);
        // int256的最大正数的二进制为0+255个1
        assertEq(msm.abs(type(int).max), (1 << 255) - 1);
        // int256的最小负数的二进制为其最大正数+1,即1+255个0
        assertEq(msm.abs(type(int).min), 1 << 255);
    }
}

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

1.jpeg

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

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

0 条评论

请先 登录 后评论