12. Solidity:庫合約(Library)

12.1 庫合約

庫合約是一種特殊的合約,為了提升solidity代碼的復(fù)用性和減少gas而存在蘑拯。庫合約一般都是一些好用的函數(shù)合集(庫函數(shù)),由大神或者項(xiàng)目方創(chuàng)作。
他和普通合約主要有以下幾點(diǎn)不同:

  1. 不能存在狀態(tài)變量
  2. 不能夠繼承或被繼承
  3. 不能接收以太幣
  4. 不可以被銷毀

12.2 庫合約的使用

  • 一個(gè)簡單的例子:通過庫合約名稱調(diào)用庫函數(shù)
// 庫合約的定義
library Math { // 合約名稱大寫開頭:編碼習(xí)慣
    function max(uint x, uint y) internal pure returns (uint) {
        return x >= y ? x : y;
    }
}

contract Test {
    function testMax(uint _x, uint _y) external pure returns (uint) {
        // 庫函數(shù)的使用
        return Math.max(_x, _y);
    }
}

定義了一個(gè)庫合約Math盛霎,實(shí)現(xiàn)一個(gè)返回兩個(gè)數(shù)中較大值的函數(shù)。一般庫合約中函數(shù)使用internal修飾耽装,如果想要外部訪問可以使用public修飾愤炸,使用external和private修飾是沒有意義的。

測(cè)試合約Test中使用Math.max對(duì)庫合約中的函數(shù)進(jìn)行調(diào)用掉奄。

  • 另一個(gè)簡單的例子:利用using for指令
library ArrayLib {
    function find(uint[] storage arr, uint x) internal view returns (uint) {
        for (uint i = 0; i < arr.length; i++) {
            if (arr[i] == x) {
                return i;
            }
        }
        revert("not found");
    }
}


contract TestArray {
    // 使用庫合約:using for规个,使庫合約應(yīng)用到庫函數(shù)的第一個(gè)參數(shù)uint[],uint[]就擁有了庫合約的所有功能
    using ArrayLib for uint[];
    uint[] public arr = [3,2,1,5,8,0];

    function testFind(uint _x) external view returns (uint i) {
        // return ArrayLib.find(arr, 2);
        return arr.find(_x);
    }
}

庫合約ArrayLib中挥萌,實(shí)現(xiàn)了一個(gè)查找數(shù)組元素索引的函數(shù)绰姻。

測(cè)試合約TestArray中使用using for語法調(diào)用庫合約的功能。指令using A for B;可用于附加庫函數(shù)(從庫 A)到任何類型B引瀑。添加完指令后狂芋,庫A中的函數(shù)會(huì)自動(dòng)添加為B類型變量的成員,可以直接調(diào)用憨栽。

注意:在調(diào)用的時(shí)候帜矾,這個(gè)變量會(huì)被當(dāng)作第一個(gè)參數(shù)傳遞給函數(shù)

12.3 String庫合約

String庫合約是將uint256類型轉(zhuǎn)換為相應(yīng)的string類型的代碼庫,樣例代碼如下:

library Strings {
    bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";

    /**
     * @dev Converts a `uint256` to its ASCII `string` decimal representation.
     */
    function toString(uint256 value) public pure returns (string memory) {
        // Inspired by OraclizeAPI's implementation - MIT licence
        // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol

        if (value == 0) {
            return "0";
        }
        uint256 temp = value;
        uint256 digits;
        while (temp != 0) {
            digits++;
            temp /= 10;
        }
        bytes memory buffer = new bytes(digits);
        while (value != 0) {
            digits -= 1;
            buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
            value /= 10;
        }
        return string(buffer);
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
     */
    function toHexString(uint256 value) public pure returns (string memory) {
        if (value == 0) {
            return "0x00";
        }
        uint256 temp = value;
        uint256 length = 0;
        while (temp != 0) {
            length++;
            temp >>= 8;
        }
        return toHexString(value, length);
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
     */
    function toHexString(uint256 value, uint256 length) public pure returns (string memory) {
        bytes memory buffer = new bytes(2 * length + 2);
        buffer[0] = "0";
        buffer[1] = "x";
        for (uint256 i = 2 * length + 1; i > 1; --i) {
            buffer[i] = _HEX_SYMBOLS[value & 0xf];
            value >>= 4;
        }
        require(value == 0, "Strings: hex length insufficient");
        return string(buffer);
    }
}

String庫合約主要包含三個(gè)函數(shù):

  1. toString(uint256 value):將uint256轉(zhuǎn)為string屑柔。
  2. toHexString(uint256 value):將uint256轉(zhuǎn)為16進(jìn)制屡萤,再轉(zhuǎn)為string。
  3. toHexString(uint256 value, uint256 length):將uint256轉(zhuǎn)為固定長度的16進(jìn)制string類型掸宛。
    使用示例:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import "https://github.com/OpenZeppelin/openzeppelin-contracts/blob/4a9cc8b4918ef3736229a5cc5a310bdc17bf759f/contracts/utils/Strings.sol";

contract Test {
    using Strings for uint256;

    function TestToString(uint256 _x) external pure returns (string memory) {
        return _x.toString();
    }

    function TestToHexString(uint256 _x) external pure returns (string memory) {
        return _x.toHexString();
    }

    function TestToHexString2(uint256 _x, uint256 _y) external pure returns (string memory) {
        return _x.toHexString(_y);
    }
}

運(yùn)行結(jié)果:


strings庫合約的使用

常見的庫合約舉例:

  1. String:將uint256轉(zhuǎn)換為String
  2. Address:判斷某個(gè)地址是否為合約地址
  3. Create2:更安全的使用Create2 EVM opcode
  4. Arrays:跟數(shù)組相關(guān)的庫函數(shù)
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末死陆,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌措译,老刑警劉巖别凤,帶你破解...
    沈念sama閱讀 216,544評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異领虹,居然都是意外死亡规哪,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,430評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門塌衰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來诉稍,“玉大人,你說我怎么就攤上這事最疆”蓿” “怎么了?”我有些...
    開封第一講書人閱讀 162,764評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵肚菠,是天一觀的道長舔箭。 經(jīng)常有香客問我,道長蚊逢,這世上最難降的妖魔是什么层扶? 我笑而不...
    開封第一講書人閱讀 58,193評(píng)論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮烙荷,結(jié)果婚禮上镜会,老公的妹妹穿的比我還像新娘。我一直安慰自己终抽,他們只是感情好戳表,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,216評(píng)論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著昼伴,像睡著了一般匾旭。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上圃郊,一...
    開封第一講書人閱讀 51,182評(píng)論 1 299
  • 那天价涝,我揣著相機(jī)與錄音,去河邊找鬼持舆。 笑死色瘩,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的逸寓。 我是一名探鬼主播居兆,決...
    沈念sama閱讀 40,063評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼竹伸!你這毒婦竟也來了泥栖?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,917評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎聊倔,沒想到半個(gè)月后晦毙,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體生巡,經(jīng)...
    沈念sama閱讀 45,329評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡耙蔑,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,543評(píng)論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了孤荣。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片甸陌。...
    茶點(diǎn)故事閱讀 39,722評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖盐股,靈堂內(nèi)的尸體忽然破棺而出钱豁,到底是詐尸還是另有隱情,我是刑警寧澤疯汁,帶...
    沈念sama閱讀 35,425評(píng)論 5 343
  • 正文 年R本政府宣布牲尺,位于F島的核電站,受9級(jí)特大地震影響幌蚊,放射性物質(zhì)發(fā)生泄漏谤碳。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,019評(píng)論 3 326
  • 文/蒙蒙 一溢豆、第九天 我趴在偏房一處隱蔽的房頂上張望蜒简。 院中可真熱鬧,春花似錦漩仙、人聲如沸搓茬。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,671評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽卷仑。三九已至,卻和暖如春麸折,著一層夾襖步出監(jiān)牢的瞬間锡凝,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,825評(píng)論 1 269
  • 我被黑心中介騙來泰國打工磕谅, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留私爷,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,729評(píng)論 2 368
  • 正文 我出身青樓膊夹,卻偏偏與公主長得像衬浑,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子放刨,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,614評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容