solidity智能合约[45]-library库

2024-12-19 技术教程

library引入

常常，我们会进行加减乘除的操作，如下的函数就是对两个函数参数进行了四则运算。

1
2
3
4
5
6

function operate(uint a, uint b) pure returns(uint,uint,uint,uint){
uint add = a+b;
uint sub = a-b;
uint mul = a*b;
uint div = a/b;
}
library库

上面的函数其实是有问题的，因为它不能够避免出错，例如如果为b传递为0，就会报错。并且没有防止溢出***的问题。有很多时候，对于一些基础性的操作，我们可以把他们封装起来，这就是library库的作用。

library的定义

如下例所示，就是上面4则运算使用的library库，对于溢出等进行了问题规避。
library库中，不能包含状态变量、

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

library SafeMath{

function mul(uint a,uint b) pure returns(uint){

uint c = a*b;
assert(c/a==b);
return c;
}

function div(uint a,uint b) pure returns(uint){
uint c = a/b;
assert(a== b*c +a%b);
return c;
}

function sub(uint a,uint b) pure returns(uint){

assert(a>=b);
return a-b;
}

function add(uint a,uint b) pure returns(uint){

uint c = a+b;
assert(c>=a);
return c;
}
}
library库的使用

直接使用库函数中的函数。

1
2
3
4
5
6
7
8

function operate(uint a,uint b) pure returns(uint,uint,uint,uint){

uint jia = SafeMath.add(a,b);
uint jian = SafeMath.sub(a,b);
uint cheng =SafeMath.mul(a,b);
uint chu = SafeMath.div(a,b);
return(jia,jian,cheng,chu);
}

方式2:使用 using SafeMath for uint之后，可以调用库函数。例如a.add(b) 意味着执行了safemath库中的 add(a,b)

1
2
3
4
5
6
7
8

using SafeMath for uint;
function operate2(uint a,uint b) pure returns(uint,uint,uint,uint){
uint jia = a.add(b);
uint jian = a.sub(b);
uint cheng =a.mul(b);
uint chu = a.div(b);
return(jia,jian,cheng,chu);
}
library库深入机制

使用library，底层是使用了delegatecall来远程的调用另外一个合约的代码。只有在某些极少数的情况下，并不是使用了远程调用，而是编译器直接将library库的代码嵌套进了合约中。
例如：下面的例子中，library库中的代码全是pure类型，并且使用了SafeMath.add的方式来调用合约，因此，在编译的时候，会直接将library库的add方法加载到合约中。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

pragma solidity 0.4.23;
library SafeMath{

function add(uint a,uint b) pure returns(uint){

uint c = a+b;
assert(c>=a);
return c;
}
}

contract math{
function operate(uint a,uint b) returns(uint){
uint jia = SafeMath.add(a,b);
return(jia);
}

}

当library库中，有this关键字，函数参数中有storage属性，或者使用了using SafeMath for uint来调用library库的时候，会使用到远程的library库。
下面的例子，编译器都会需要外部的一个library库的地址，从而能够远程调用到library合约。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

pragma solidity 0.4.23;
library SafeMath{

function add(uint a,uint b) pure returns(uint){

uint c = a+b;
assert(c>=a);
return c;
}
}

contract math{
using SafeMath for uint;
function operate(uint a,uint b) returns(uint){
uint jia = a.add(b);
return(jia);
}
}

编译math合约的时候，其二进制代码如下：

"608060405234801561001057600080fd5b5061017c806100206000396000f300608060405260043610610041576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063db17ebcd14610046575b600080fd5b34801561005257600080fd5b5061007b6004803603810190808035906020019092919080359060200190929190505050610091565b6040518082815260200191505060405180910390f35b6000808373__browser/test6.sol:SafeMath____________63771602f79091856040518363ffffffff167c0100000000000000000000000000000000000000000000000000000000028152600401808381526020018281526020019250505060206040518083038186803b15801561010957600080fd5b505af415801561011d573d6000803e3d6000fd5b505050506040513d602081101561013357600080fd5b8101908080519060200190929190505050905080915050929150505600a165627a7a7230582006c538588770740653d6eba03016e0ef64c5da4f370291bdb71ea916cfbf166a0029"

注意到，在此二进制代码中，有一段预留的标识符，其是__browser/test6.sol:SafeMath____________.这一段预留的标识符就是远程library库的地址。

完整代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

pragma solidity 0.4.23;

library SafeMath{

function mul(uint a,uint b) pure returns(uint){

uint c = a*b;
assert(c/a==b);
return c;
}

function div(uint a,uint b) pure returns(uint){
uint c = a/b;
assert(a== b*c +a%b);
return c;
}

function sub(uint a,uint b) pure returns(uint){

assert(a>=b);
return a-b;
}

function add(uint a,uint b) pure returns(uint){

uint c = a+b;
assert(c>=a);
return c;
}
}

contract math{

using SafeMath for uint;

function operate(uint a,uint b) returns(uint,uint,uint,uint){

uint jia = SafeMath.add(a,b);
uint jian = SafeMath.sub(a,b);
uint cheng =SafeMath.mul(a,b);
uint chu = SafeMath.div(a,b);
return(jia,jian,cheng,chu);
}

function operate2(uint a,uint b) returns(uint,uint,uint,uint){

uint jia = a.add(b);
uint jian = a.sub(b);
uint cheng =a.mul(b);
uint chu = a.div(b);
return(jia,jian,cheng,chu);
}

}
复杂library例子

下例中，CounterContract合约使用了CounterLib库中的结构体构建了自己的结构体变量counter。并调用了CounterLib库中的方法，实现了counter中i加一的操作。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

pragma solidity ^0.4.23;
library CounterLib {
struct Counter { uint i; }

function incremented(Counter storage self) returns (uint) {
return ++self.i;
}
}

contract CounterContract {
using CounterLib for CounterLib.Counter;

CounterLib.Counter counter;// struct Counter { uint i; }

function increment() returns (uint) {
return counter.incremented();
}
}