这章从一个简单的hello,world的例子来介绍如何去编写一个python智能合约。
每一个智能合约由两部分组成,代码和ABI。代码可以是python代码,也可以是C/C++代码,当然也可以是其它任意支持的代码。代码最终会被编译成bytecode被运行,如果是C/C++代码,则要事先通过编译生成wast文件。而python代码则是在pyeos内部编译的,不需要事先编译,当然后面可能会支持事先编译好的python代码。ABI是Application Binary Interface的简写,用于定义智能合约的结构,这样用户才能通过发送ts的方式和智能合约打交道。
下面是helloworld智能合约的代码,可以从hello这个目录获取
hello.py
import eoslib
def init():
print('hello,world')
def sayHello():
print('read message:', eoslib.read_message())
def apply(name, type):
if type == eoslib.N('sayhello'):
sayHello()
简单介绍下,这个python代码里有两个预定义的函数,init和apply。
- init函数只会在智能合约发布的时候调用,在这个函数里可以作些智能合约的初始化工作,如设置总token的数量。这里只是简单的打印hello,world,以表示代码被调用了。
- apply是调用智能合约代码的入口,两个参数都是64位的无符号整数,分别用于代表调用智能合约的账号的名称和调用的类型名称。
64位的无符号整数是从一个不大于13个字符的字符串转换过来的,并且字符限定在下面列出的字符范围之内。
.12345abcdefghijklmnopqrstuvwxyz
也就是只能是小写的26个字母,外加“12345”和“.”一共32个字符。
eoslib.N函数可以把这样的字符串转化成无符号的64位整数
下面来看下智能合约的ABI文件。
hello.abi
{
"actions": [{
"action": "sayhello",
"type": "bytes"
}
]
}
这个ABI文件非常简单,真正的ABI文件要比这个复杂得多。参考hello.py的代码就可以很好理解这个abi文件了。
"action": "sayhello"表示要触发的动作名称为sayhello,这在python代码里可以对应一个函数,在hello.py里有对这个动作进行判断并调用sayHello函数。
def apply(name, type):
if type == eoslib.N('sayhello'):
...
这个动作的参数为bytes类型,参数在智能合约里通过eoslib.read_message来读取,
接下来看下如何将这个智能合约发布到eos的区块链上并调用智能合约。这里默认已经按照python智能合约编程 -- 在python中调用Eos API的步骤创建了钱包并且已经解锁,私钥已经导入了钱包。
先创建名称为hello的智能合约账号:
key1 = 'EOS61MgZLN7Frbc2J7giU7JdYjy2TqnfWFjZuLXvpHJoKzWAj7Nst'
key2 = 'EOS5JuNfuZPATy8oPz9KMZV2asKf9m8fb2bSzftvhW55FKQFakzFL'
r = eosapi.create_account('inita', 'hello', key1, key2)
再调用eosapi.set_contract函数将代码发布到区块链上,set_contract
要指定代码文件和abi文件。注意文件路径是相对于build/programs目录而言的。
r = eosapi.set_contract('hello','../../programs/pyeos/contracts/hello/hello.py','../../programs/pyeos/contracts/hello/hello.abi', 1)
最后来看下如何调用智能合约。
r = eosapi.push_message('hello','sayhello','hello,world',['hello'],{},rawargs=True)
push_message的六个参数分别是:
- 账号名称
- 要调用的action
- action的参数
- scope,表面意思即为范围,用于指定代码允许操作的数据范围。在后面的文章里会有详细讲解其作用。
- 要使用的权限, 里没有指定,最经常使用的是active权限。
- 指定参数的类型,默认是一个dict类型,用于代表一个在abi文件中指定的类型。底层代码里根据这个dict类型通过abi文件中指定的结构将dict里的值转换成二进制数据,这里rawargs=True表示原始数据,不进行转换。
执行这行代码后会看到有下面的打印输出
read message: b'hello,world'
到此,本章结束。下章开始介绍智能合约中要用到的几个重要函数。