ABI全称Application Binary Interface, 是调用智能合约函数以及合约之间函数调用的消息编码格式定义,也可以理解为智能合约函数调用的接口说明. 类似Webservice里的SOAP协议一样；也就是定义操作函数签名，参数编码，返回结果编码等。
使用ABI协议时必须要求在编译时知道类型,即强类型相关.
智能合约的ABI接口定义
当一个智能合约编译出来后, 他的abi接口定义就确定了. 比如下面的智能合约:
contract myContract {
event Log_lotus(bytes32 _id, bytes32[] users);
uint k=0;
function lotus(uint a, bytes32 b, bytes32[] c) public {
k=a;
Log_lotus(b,c);
}
}
生成的字节码:
606060405260008055341561001357600080fd5b610176806100226000396000f300606060405260043610610041576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063e17b829214610046575b600080fd5b341561005157600080fd5b6100b4600480803590602001909190803560001916906020019091908035906020019082018035906020019080806020026020016040519081016040528093929190818152602001838360200280828437820191505050505050919050506100b6565b005b826000819055507fa756dbb78a87f957869324b276aea920464fad0955c2e8dc59f80bef9ceb8343828260405180836000191660001916815260200180602001828103825283818151815260200191508051906020019060200280838360005b83811015610131578082015181840152602081019050610116565b50505050905001935050505060405180910390a15050505600a165627a7a723058202b9bfbc1e3fc4afd0d10fce971ba4109707f356f5c5c3f8ac7601f76b819b7330029
生成的abi定义:
[
{
"constant": false, //方法修饰符,false表示函数内可以修改状态变量
"inputs": [ //方法参数，它是一个对应数组，数组里的每个对象都是一个参数说明
{
"name": "a", //第一个参数的名字
"type": "uint256" //第一个参数的类型
},
{
"name": "b", //第二个参数的名字
"type": "bytes32" //第二个参数的类型
},
{
"name": "c", //第三个参数的名字
"type": "bytes32[]" ////第三个参数的类型
}
],
"name": "lotus", //方法名
"outputs": [], //方法返回值，格式和inputs类型相同
"payable": false,
"stateMutability": "nonpayable",
"type": "function" //方法类型,function, constructor, fallback,event
},
{
"anonymous": false,
"inputs": [
{
"indexed": false,
"name": "_id",
"type": "bytes32"
},
{
"indexed": false,
"name": "users",
"type": "bytes32[]"
}
],
"name": "Log_lotus",
"type": "event"
}
]
可以看出, 生成abi包含了2个定义: 函数 lotus , 事件 Log_lotus , 各个字段含义见上. 根据该abi定义,就可以生成调用该智能合约函数的abi格式的数据了.
格式简单的可以表示为: 函数选择器+参数编码
函数选择器
一个函数调用的前四个字节数据指定了要调用的函数签名。计算方式是使用函数签名的 keccak256 的哈希，取4个字节。
bytes4(keccak256("foo(uint32,bool)"))
函数名如果有多个参数使用,隔开，要去掉表达式中的所有空格。在geth客户端,通过命令可以得到hash:
web3.sha3("foo(uint32,bool)")
"0xcc822237a37f9290b70dab4d640156d816bf8abdb959b5971d803a639dadef98"
//截取前4个字节 即0xcc822237
参数编码
由于前面的函数签名使用了四个字节，参数的数据将从第五个字节开始。
根据参数类型,编码规则有所区别:
-
uint<M>:M为integer类型代表M bits,0 < M <= 256,M % 8 == 0，如uint32，uint8,uint256。 int<M>:同上。同为从8到256位的无符号整数。uint和int:整型，分别是uint256和int256的别名。注意: 函数参数类型是uint，转sha3码时要变成uint256。address:地址，20个字节，160bits。bool:布尔类型，1个字节，true：1，false:0。bytes<M>:固定大小的字节数组，0<M<=32,byte都是bytes1的别名。bytes:动态分配大小字节数组。不是一个值类型!string:动态大小UTF8编码的字符串,不是一个值类型!
除了bytes,和string, 其他类型的数据不足32字节长度的需要加0补足32字节. 动态长度的编码在例子中介绍.
举例
函数: function baz(uint32 x, bool y) :
调用: baz(69, true)
生成的数据如下:
- 0xcdcd77c0: 使用函数选择器确定的函数ID。通过
bytes4(keccak256("baz(uint32,bool)"))生成。 - 0x0000000000000000000000000000000000000000000000000000000000000045。第一个参数，uint32位的值
69，并补位到32字节。 - 0x0000000000000000000000000000000000000000000000000000000000000001。第二值
boolean类型值true。补位到32字节。
返回结果是一个bool值，在这里，返回的是false:
- 0x0000000000000000000000000000000000000000000000000000000000000000
函数: f(uint,uint32[],bytes10,bytes)
调用: (0x123, [0x456, 0x789], "1234567890", "Hello, world!")
函数选择器: bytes4(sha3("f(uint256,uint32[],bytes10,bytes)"))
对于 固定大小的类型 值 uint256 和 bytes10 ，直接编码值。
对于 动态内容类型 值 uint32[] 和 bytes ，我们先 编码偏移值 ，偏移值是整个值编码的开始到真正存这个数据的偏移值（这里不计算头四个用于表示函数签名的字节）。
所以参数编码数据依次为：
- 0x0000000000000000000000000000000000000000000000000000000000000123，32字节的
0x123。 - 0x0000000000000000000000000000000000000000000000000000000000000080 （第二个参数的由于是动态内容类型，所以这里存储偏移值，4*32 字节，刚好是头部部分的大小）
- 0x3132333435363738393000000000000000000000000000000000000000000000 （“1234567890” 在右侧补0到32字节大小）
- 0x00000000000000000000000000000000000000000000000000000000000000e0 （第四个参数的偏移 = 第一个动态参数的偏移值 + 第一个动态参数的大小 = ** **
4*32 + 3*32** ** 动态长度的计算见后）
尾部部分的第一个动态参数， [0x456, 0x789] 编码拆解如下：
- 0x0000000000000000000000000000000000000000000000000000000000000002 （整个数组的长度，2）。
- 0x0000000000000000000000000000000000000000000000000000000000000456 （第一个元素）
- 0x0000000000000000000000000000000000000000000000000000000000000789（第二个元素）
最后我们来看看第二个动态参数的的编码， Hello, world! 。
- 0x000000000000000000000000000000000000000000000000000000000000000d (元素的字节长度，13)
- 0x48656c6c6f2c20776f726c642100000000000000000000000000000000000000 (“Hello, world!” 补位到32字节，里面是按ascii编码的，可以查查对应的编码。)
所以最终结果是:
0x8be65246
0000000000000000000000000000000000000000000000000000000000000123
0000000000000000000000000000000000000000000000000000000000000080
3132333435363738393000000000000000000000000000000000000000000000
00000000000000000000000000000000000000000000000000000000000000e0
0000000000000000000000000000000000000000000000000000000000000002
0000000000000000000000000000000000000000000000000000000000000456
0000000000000000000000000000000000000000000000000000000000000789
000000000000000000000000000000000000000000000000000000000000000d
48656c6c6f2c20776f726c642100000000000000000000000000000000000000