EOS的开发工具 EOSFactory

简介

EOSFactory是由Tokenika创建的基于Python的EOS智能合约开发框架。通过一个命令行界面,您可以创建一个私有测试网,然后编译,单元测试和部署EOS智能合约。

github:https://github.com/tokenika/eosfactory

文档地址:http://eosfactory.io/sphinx/build/html/

eos官方文档:https://github.com/EOSIO/eos/wiki/Tutorial-Hello-World-Contract#hello-world-ricardian-contract

智能合约的开发流程

1.写一个智能合约(在EOS的本地C ++中)。

2.编写单元测试(使用Python)。

3.编译你的智能合约。

4.开始一个新的单节点测试网。

5.该测试网络将通过bios合同和一些测试账户进行初始化。

6.部署您的智能合约。

7.运行你的单元测试。

8.撤下测试网。

9.修改您的智能合约和/或单元测试并跳到阶段3。

在EOSFactory中,上述过程的每一步都由Python类和方法完全自动化 - 作为开发人员,您只提供创意部分,即智能合同和单元测试的内容。单元测试旨在用Python编写,当然智能合约是用C ++编写的。Visual Studio Code完全支持这两种语言。

安装EOSFactory

下载源码:

git clone https://github.com/tokenika/eosfactory --recursive

编译:

cd eosfactory

./build.sh -e /home/mono/Desktop/copy/eos    

备注:/home/mono/Desktop/copy/eos  为EOS的安装目录,用绝对目录哦 不然相对目录会有问题的。

source ~/.bashrc

EOS的开发工具 EOSFactory_第1张图片

测试安装

cd eosfactory

python3 ./tests/test1.py

python3 ./tests/test2.py

python3 ./tests/test3.py

Test OK

如果测试都通过则安装完成

升级EOSFactory

cd eosfactory

git pull

./build.sh 

EOSFactory中与EOS合同交互

先决条件

已成功安装EOSFactory。

运行Python

python3 运行终端

启动本地Testnet

import node 

node.reset() //重置开始新的测试

node.info() //查询测试网络的状态

管理本地Testnet

停止当前的测试网络:

node.stop()

要继续运行相同的测试网络:

node.run()

要停止当前的测试网络并开始一个新的测试网络:

node.reset()

初始化工作区

要初始化工作区:

import sess 

sess.init()

初始化过程执行以下操作:

1.部署Bios合同

2.创建对默认eosio帐户的引用

3.创建几个测试帐户:alice,bob ,carol

4.创建一个钱包并向其中导入所有上述帐户的密钥

如果您需要更多测试账户,您可以轻松创建它们:

from eosf import* 

charlie=Account("charlie",sess.eosio)

注意:第一个参数表示新帐户的名称,而第二个参数表示主帐户,在这种情况下表示默认eosio帐户。

如果您需要锁定或解锁钱包,请使用该wallet对象来执行此操作:

sess.wallet.lock()  //锁定钱包

sess.wallet.unlock() //解锁钱包

创建对EOS令牌合约的引用

要创建对已编译合同的引用,只需提供它所在文件夹的路径:

from eosf import* 

contract=Contract("/path/to/your/smart-contract/folder")

注意:您需要为智能合约所在的文件夹提供有效的路径,例如:

contract=Contract("/mnt/d/Workspaces/EOS/eos/build/contracts/eosio.token")

也可以是默认合约路径 eos/build/contracts或eosfactory/contracts

contract=Contract("eosio.token")

注意:当一个新的合约对象被启动时,幕后发生了几件事情:使用一对新的密钥创建一个新账户,并将合同分配给这个新账户。

部署EOS令牌合约

查看合约有没有已经被部署。你可以通过运行它的get_code方法来检查它:

contract.get_code()

要部署合同,请使用其deploy方法:

contract.deploy()

验证部署的合约:

contract.get_code()

创建EOS的token

调用 eosio.token 的合约创建新的账户token

contract.push_action("create",'{"issuer":"eosio", "maximum_supply":"1000000000.0000 EOS", "can_freeze":0, "can_recall":0, "can_whitelist":0}')

注:该push_action方法有两个参数:动作 和 JSON格式的参数。还可以添加第三个参数,即需要其权限的帐户,但在这种情况下并不需要,因为权限默认为持有合同的帐户

发行token

现在我们已经创建了合约token,发行者可以发布新的token来alice

contract.push_action("issue",'{"to":"alice", "quantity":"100.0000 EOS", "memo":"memo"}',sess.eosio)

交易token

现在alice有了token,我们会将其中的一些转移到carol

contract.push_action("transfer",'{"from":"alice", "to":"carol", "quantity":"25.0000 EOS", "memo":"memo"}',sess.alice)

注意:作为第三个参数,我们将对该alice帐户的引用传递给她,以表明她是授权此操作的人

检查token的发行情况

从合约的ABI中,可以查询踪token的账户余额。

让我们来检查前一个交易涉及的两个账户的状态:

contract.get_table("accounts",sess.alice)

contract.get_table("accounts",sess.carol)

注意:该get_table方法有两个参数:合同ABI指定的合约函数的名称和账户的引用。

退出开发工具

exit()

Visual Studio Code中使用EOSFactory编译EOS合约

运行Python CLI终端

Visual Studio Code中,切换到bash终端并输入python3以运行Python CLI。提示符为>>>表示它已准备好用于Python命令。

创建合同模板

首先,启动testnet并初始化工作区:

import node

node.reset()

import sess 

sess.init()

要从预定义模板创建新合同,请使用以下Template类:

from eosf import* 

contract=Template("hello")

注意: 不要在合同名称中使用空格。允许的内容是字母,数字,下划线_,点.和破折号-。

检查合同文件所在的目录:

contract.path()

编写C ++代码

例如编写hello.cpp

#include

#include

using namespace eosio;

class hello : public eosio::contract {

  public:

      using contract::contract;

      /// @abi action

      void hi( account_name user ) {

        print( "Hello, ", name{user} );

      }

};

EOSIO_ABI( hello, (hi) )

编译合约

您可以分别生成ABI和 assembly代码:

contract.abi()

contract.wast()

或者你可以同时产生两种情况:

contract.build()

注:建议手动调用wast()

部署合约

contract.deploy()

测试合约

contract.push_action("hi",'{"user":"alice"}',sess.alice)

contract.push_action("hi",'{"user":"carol"}',sess.alice)

所有上述调用都应该起作用,因为合同允许任何人授权。

修改代码,重新编译和重新部署

现在让我们修改该hi方法,以使其对我们正在处理的用户进行身份验证:

void hi(account_name user){  

   require_auth(user);  

  print(“Hello,”,name {user}); 

}

重新编译合同:

contract.build()

以下步骤是可选的,因为您可以在现有的测试网上重新部署合同。但是,如果要重置testnet,请使用以下命令:

node.reset()

sess.init()

并重新部署合同:

contract.deploy()

现在,如果我们试图使用户和权限不匹配,那么合约会抛出一个错误:

contract.push_action("hi",'{"user":"carol"}',sess.alice)

"error":{"code":3030001,"name":"tx_missing_auth","what":"missing required authority"...

但是,如果我们使用适当的权力,就不应该有错误:

contract.push_action("hi",'{"user":"carol"}',sess.carol)

最后,当你完成合约时,你可能想从工作区中删除它:

contract.delete()

注:上述命令删除整个文件夹。

Visual Studio Code 中 使用 CMake 

您可以使用CMake例程来构建一个合同,前提是它已经从模板创建到EOSFactory中,例如:

from eosf import*

contract=Template("hello")

模版 class 会生成 CMakeLists 文件在合约目录 ,也可以自己配置vscode的开发环境 例如:

cmake  ..

make 

EOS的开发工具 EOSFactory_第2张图片

Visual Studio Code中使用EOSFactory对EOS合约进行单元测试

创建单元测试的python脚本 

测试模版

import node

import sess

from eosf import *

def run():

    node.reset()

    sess.init()

    ############################

    # Your unit-test goes here #

    ############################

   node.stop()

    print("Test OK")

if __name__ == "__main__":

    run()


eosio.token的单元测试

import sess

from eosf import *

def run():

    node.reset()

    sess.init()

    c = Contract("eosio.token")

    c.deploy()

    c.push_action("create", '{"issuer":"eosio", "maximum_supply":"1000000000.0000 EOS", "can_freeze":0, "can_recall":0, "can_whitelist":0}') 

    c.push_action("issue", '{"to":"alice", "quantity":"100.0000 EOS", "memo":"memo"}', sess.eosio)

    c.push_action("transfer", '{"from":"alice", "to":"carol", "quantity":"25.0000 EOS", "memo":"memo"}', sess.alice)

    c.push_action("transfer", '{"from":"carol", "to":"bob", "quantity":"13.0000 EOS", "memo":"memo"}', sess.carol)

    c.push_action("transfer", '{"from":"bob", "to":"alice", "quantity":"2.0000 EOS", "memo":"memo"}', sess.bob)

    t1 = c.get_table("accounts", sess.alice)

    t2 = c.get_table("accounts", sess.bob)

    t3 = c.get_table("accounts", sess.carol)

    assert t1.json["rows"][0]["balance"] == '77.0000 EOS'

    assert t2.json["rows"][0]["balance"] == '11.0000 EOS'

    assert t3.json["rows"][0]["balance"] == '12.0000 EOS'

    node.stop()

    print("Test OK")


运行测试

import test 

test.run()

或者

python3 ./tests/test.py


Tic-Tac-Toe 的单元测试

import node

import sess

from eosf import *

def run():

    node.reset()

    sess.init()

    c = Contract("tic.tac.toe")

    c.deploy()

    c.push_action("create", '{"challenger":"alice", "host":"bob"}', sess.bob)

    t = c.get_table("games", sess.bob)

    assert t.json["rows"][0]["board"][0] == '0'

    assert t.json["rows"][0]["board"][1] == '0'

    assert t.json["rows"][0]["board"][2] == '0'

    assert t.json["rows"][0]["board"][3] == '0'

    assert t.json["rows"][0]["board"][4] == '0'

    assert t.json["rows"][0]["board"][5] == '0'

    assert t.json["rows"][0]["board"][6] == '0'

    assert t.json["rows"][0]["board"][7] == '0'

    assert t.json["rows"][0]["board"][8] == '0'

    c.push_action("move", '{"challenger":"alice", "host":"bob", "by":"bob", "mvt":{"row":0, "column":0} }', sess.bob)

    c.push_action("move", '{"challenger":"alice", "host":"bob", "by":"alice", "mvt":{"row":1, "column":1} }', sess.alice)

    t = c.get_table("games", sess.bob)

    assert t.json["rows"][0]["board"][0] == '1'

    assert t.json["rows"][0]["board"][1] == '0'

    assert t.json["rows"][0]["board"][2] == '0'

    assert t.json["rows"][0]["board"][3] == '0'

    assert t.json["rows"][0]["board"][4] == '2'

    assert t.json["rows"][0]["board"][5] == '0'

    assert t.json["rows"][0]["board"][6] == '0'

    assert t.json["rows"][0]["board"][7] == '0'

    assert t.json["rows"][0]["board"][8] == '0'

    c.push_action("restart", '{"challenger":"alice", "host":"bob", "by":"bob"}', sess.bob)

    t = c.get_table("games", sess.bob) 

    assert t.json["rows"][0]["board"][0] == '0'

    assert t.json["rows"][0]["board"][1] == '0'

    assert t.json["rows"][0]["board"][2] == '0'

    assert t.json["rows"][0]["board"][3] == '0'

    assert t.json["rows"][0]["board"][4] == '0'

    assert t.json["rows"][0]["board"][5] == '0'

    assert t.json["rows"][0]["board"][6] == '0'

    assert t.json["rows"][0]["board"][7] == '0'

    assert t.json["rows"][0]["board"][8] == '0'

    c.push_action("close", '{"challenger":"alice", "host":"bob"}', sess.bob)

    node.stop()

    print("Test OK")

你可能感兴趣的:(EOS的开发工具 EOSFactory)