【Solidity智能合约系列】08--Solidity API

前言

这一节主要会介绍一些Solidity API，也就是一些特殊的变量及函数。

特殊的变量和函数（Special Variables and Functions）

Solidity的API中内置了一些特殊的变量及函数，他们存在于全局命名空间(namespace)里,主要用于提供区块链(blockchain)相关的信息,或者是一些通用的函数。大概分为如下几类：

1、有关区块和交易的属性
2、有关错误处理
3、有关数学及加密功能
4、地址相关
5、合约相关

区块和交易属性（Block And Transaction Properties）

• block.blockhash(uint blockNumber) returns (bytes32)：返回给定区块号的哈希值，只支持最近256个区块，且不包含当前区块。

• block.coinbase (address):当前区块的矿工地址

• block.difficulty (uint): 当前区块的难度值

• block.gaslimit (uint): 当前区块的gaslimit

• block.number (uint): 当前区块的块号

• block.timestamp (uint): 当前块的Unix时间戳（从1970/1/1 00:00:00 UTC开始所经过的秒数）

• gasleft() returns (uint256):剩余的gas

• msg.data (bytes):完整的调用数据calldata

• msg.gas (uint):剩余的gas，在0.4.21版本中已经弃用，并有gasleft()代替

• msg.sender (address)：当前调用发起人的地址

• msg.sig (bytes4):调用数据(calldata)的前四个字节（例如为：函数标识符）

• msg.value (uint):发送这个消息所附带的以太币的数量，单位是wei

• now (uint):当前块的时间戳(block.timestamp的别名)

• tx.gasprice (uint):交易的gas价格

• tx.origin (address):交易发送者的地址（full call chain）

注意以下几点：

1、msg的所有成员值，包括 msg.sender 和 msg.value都可以因为每一次 external 函数（或library库函数）的调用被改变。

2、不应该依据 block.timestamp(时间戳), now 和 block.blockhash(区块哈希)来产生一个随机数，除非你确实需要这样做。
block.timestamp(时间戳)和 block.blockhash(区块哈希)在一定程度上会受矿工的影响。比如在赌博合约里，不诚实的矿工可能会尝试去选择一个对自己有利的hash。

3、对于同一个链上连续的区块来说，当前区块的时间戳（timestamp）必然是大于上一个区块的时间戳。

4、由于可扩展性的原因，你只能查到最近的256个区块的hash值，所有其它的将返回0.

ABI编码函数(ABI Encoding Functions)

• abi.encode(...) returns (bytes):

• abi.encodePacked(...) returns (bytes):

• abi.encodeWithSelector(bytes4 selector, ...) returns (bytes):

• abi.encodeWithSignature(string signature, ...) returns (bytes)：

注意：
这些编码函数可以在不实际调用函数的情况下，为函数调用创建数据。此外，keccak256(abi.encodePacked(a, b))是计算keccak256(a, b)更明确的方式，keccak256(a, b)在以后的版本中会被废弃。

关于编码的信息，大家可以参考ABI
和tightly packed encoding的文档

错误处理（Error Handling）

assert(bool condition)
用于判断内部错误，如果条件不满足时，会使事物无效（抛出异常）
require(bool condition)
用于判断输入或外部组件错误，如果条件不满足时，会回滚
require(bool condition, string message)
用于判断输入或外部组件错误，如果条件不满足时，会回滚。同时会显示错误信息
revert():
终止执行并恢复改变的状态
revert(string reason)
终止执行并恢复改变的状态，并且会提供一个解释的信息

数学及加密函数(Mathematical and Cryptographic Functions)

addmod(uint x, uint y, uint k) returns (uint):
计算(x + y) % k，加法支持任意的精度且不会在2**256(2的256次方)处溢出，从0.5.0版本开始插入 assert(k != 0)。

mulmod(uint x, uint y, uint k) returns (uint):
计算 (x * y) % k， 乘法支持任意的精度且不会在2*256处溢出， 从0.5.0版本开始插入 assert(k != 0)

keccak256(…) returns (bytes32):
计算 (tightly packed) arguments的Ethereum-SHA-3 (Keccak-256) hash值

sha256(…) returns (bytes32):
使用SHA-256计算tightly packed) arguments
的hash值

sha3(…) returns (bytes32):
keccak256的别名

ripemd160(…) returns (bytes20):
使用RIPEMD-160计算(tightly packed) arguments
的HASH值

ecrecover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) returns (address):
通过椭圆曲线签名来恢复与公钥关的地址，或者在错误时返回0(参考示例
)。
可用于签名数据的校验，如果返回结果是签名者的公匙地址，那么说明数据是正确的。

ecrecover函数需要四个参数，需要被签名数据的哈希结果值，r，s，v分别来自签名结果串。
r = signature[0:64]
s = signature[64:128]
v = signature[128:130]
其中v取出来的值或者是00或01。要使用时，我们先要将其转为整型，再加上27，所以我们将得到27或28。在调用函数时v将填入27或28。

在上面，“tightly packed”意思是说参数不会补位，是直接连接在一起的，下面几个是相等的。

keccak256("ab", "c")
keccak256("abc")

keccak256(0x616263)  // hex16进制数
keccak256(6382179)
keccak256(97, 98, 99)   //ascii码，97代表a

如果需要填充，可以使用显式类型转换：keccak256(“\x00\x12”) 与keccak256(uint16(0x12))相同。

注意，常量将使用存储它们所需的最少字节数来打包，例如keccak256(0) == keccak256(uint8(0))和keccak256(0x12345678) == keccak256(uint32(0x12345678))

在私有链(private blockchain)上运行sha256,ripemd160或ecrecover可能会出现Out-Of-Gas错误。因为私链实现了一种预编译合约，合约要在收到第一个消息后才会真正存在（即使它们的合约代码是硬编码的）。向一个不存在的合约发送消息时非常昂贵的，并且会导致Out-Of-Gas的问题。一种解决办法是在你真正使用这些合约之前，给每个合约地址发送1 wei。在官方和测试链上没有这个问题。

地址相关（Address Related）

<address>.balance (uint256):
指定以太坊地址的余额，单位是wei

<address>.transfer(uint256 amount):
发送给定数量的ether到某个地址，以wei为单位。失败时抛出异常，还会转发2300 gas，这是不可调节的。

<address>.send(uint256 amount) returns (bool):
发送给定数量的ether到某个地址，以wei为单位, 失败时返回false，还会转发2300 gas，这是不可调节的。

<address>.call(...) returns (bool):
发起底层的call调用，失败时返回false，会花费掉所有可用的gas，可以调节

<address>.callcode(...) returns (bool):
发起底层的callcode调用，失败时返回false，会花费掉所有可用的gas，可以调节。不鼓励使用，未来可能会移除。

<address>.delegatecall(...) returns (bool):
发起底层的delegatecall调用，失败时返回false，会花费掉所有可用的gas，可以调节

更多的信息，参考Address.

警告：
使用send()会有一些危险：如果调用栈的深度超过1024或接收方耗光了gas，交易都会失败。所以，为了确保Ether交易安全，必须检查send的返回值，如果交易失败，会回退以太币。使用transfer或许是更好的选择。

合约相关（Contract Related）

this (current contract’s type):
表示当前合约，可以显式的转换为Address

selfdestruct(address recipient):
销毁当前合约，并把所有资金发送到指定的地址。

suicide(address recipient):
selfdestruct的别名（废弃）

此外，当前合约里的所有函数均可支持调用，包括当前函数本身。

参考：
https://solidity.readthedocs.io/en/develop/units-and-global-variables.html#units-and-globally-available-variables