簡介
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
測試安裝
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?
在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")