簡介
上篇文章，使用了 Remix 在線 IDE，個人感覺 Remix 在入門智能合約開發時，是很好的上手工具，因為 Remix 幫我們處理好了編譯、部署的程序，并且還通過 JavaScript VM 準備好了本地區塊鏈方便我們測驗，可謂開箱即用，但畢竟是線上 IDE，功能還是有限，
這里我們使用 Brownie 框架來開發智能合約，Brownie 框架是基于 Python 撰寫的智能合約開發框架，它可以幫我們快速完成編譯、部署、測驗等智能合約開發的全流程，
檔案：https://eth-brownie.readthedocs.io/en/stable/
Web3.py 基礎
因為 Brownie 主要基于 Web3.py 這個庫開發而來，在從 Python 角度了解以太坊
撰寫簡單的智能合約
首先，通過 Solidity 撰寫一個簡單智能合約，沒錯，我們并不能通過 Python 來撰寫智能合約，利用 Python，只是為了讓這個程序更加自動化與工程化，智能合約代碼如下：
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
contract Storage {
struct People {
string name;
uint256 age;
}
People[] public people;
function addPerson(string memory _name, uint256 _age) public {
people.push(People(_name, _age));
}
}上述代碼中，通過 struct 關鍵字定義了一個名為 People 的物件，該物件中有 name 與 age 兩個屬性，然后基于 People 物件，實體化了 people 陣列，然后定義了 addPerson 函式，該方法會接收_name 與_age 引數，然后實體化 People 物件，最后將 People 物件添加到陣列中，
這里有個細節，就是引數_name 是字串，所以需要使用 memory 關鍵字標注一下，Solidity 中，存盤變數的方式有 storage 與 memory 兩種，
storage 變數：永久存盤在區塊鏈中的變數
memory 變數：臨時的，當外部函式對某合約呼叫完成時，記憶體型變數即被移除
Solidity 中的 string 的本質是字符陣列（Char Array），如果你不通過 memory 宣告，就算_name 是函式引數，Solidity 也會通過storage持續存盤它，
編譯智能合約與連接本地區塊鏈網路
創建名為【web3py_storage】的檔案夾，然后在其中創建 Storage.sol 檔案并將智能合約代碼復制到檔案中，
通過 vscode 打開 webpy_simple_storage 檔案夾，創建 base.py，在 base.py 實作對智能合約的編譯以及連接上區塊鏈網路的操作，
閱讀 web3.py 智能合約相關的檔案：https://web3py.readthedocs.io/en/stable/contracts.html
通過檔案可知，web3.py 不支持 solidity 的編譯，檔案中建議我們安裝 py-solc-x 庫來實作 solidity 的編譯，簡單安裝一下，然后通過 install_solc 方法來下載對應版本的 solidity 編譯器，
因為我們的智能合約使用了 Solidity ^0.6.0，所以下載 0.6.0 版本的 solidity 編譯器則可，然后按檔案的方式設定編譯 Solidity 時的配置則可，相關代碼如下：
import os
import json
from web3 import Web3
# 編譯 solidity
# https://github.com/iamdefinitelyahuman/py-solc-x
from solcx import compile_standard, install_solc
with open('./Storage.sol', 'r', encoding='utf-8') as f:
storage_file = f.read()
# 下載0.6.0版本的Solidity編譯器
install_solc('0.6.0')
# 編譯Solidity
compiled_sol = compile_standard(
{
"language": "Solidity",
# Solidity檔案
"sources": {"Storage.sol": {"content": storage_file}},
"settings": {
"outputSelection": {
"*": {
# 編譯后產生的內容
"*": ["abi", "metadata", "evm.bytecode", "evm.bytecode.sourceMap"]
}
}
},
},
# 版本，與撰寫智能合約時Solidity使用的版本對應
solc_version="0.6.0",
)
# 編譯后的結果寫入檔案
with open('compiled_code.json', 'w') as f:
json.dump(compiled_sol, f)compile_standard 方法編譯后的結果寫入 compiled_code.json，將其格式化，如下圖：
從上圖可知，Solidity 編譯后的位元組碼也在 compiled_code.json 中，將 json 檔案中重要的資料讀取出來，代碼如下：
# 智能合約編譯后的位元組碼（上鏈的資料）
bytecode = compiled_sol["contracts"]["Storage.sol"]["Storage"]["evm"][
"bytecode"
]["object"]
# ABI (Application Binary Interface)，用于與智能合約中的方法進行互動的介面
abi = json.loads(
compiled_sol["contracts"]["Storage.sol"]["Storage"]["metadata"]
)["output"]["abi"]bytecode：智能合約編譯后的位元組碼，智能合約上鏈其實就是將這部分資料存盤到區塊鏈中，
abi：我們的程式與智能合約互動的介面，它定義了我們的程式可以怎么與當前這個智能合約互動，
至此，智能合約的編譯流程就結束了，然后我們通過 web3.py 連接到以太坊中，
與 Remix IDE 不同，web3.py 沒有通過 JavaScript VM 實作的本地區塊鏈網路，雖然有 web3 [tester]，但不夠完善，這里我們通過 Genache 來實作本地網路，
Genache：https://www.trufflesuite.com/ganache
下載好后，直接運行，然后點擊【QUICKSTART】，選擇【ETHEREUM】，
Ganache 會在本地快速創建區塊鏈網路：
從上圖中，可以看出，Ganache 會為我們創建 10 個賬號，創建出的網路可以通過 http://127.0.0.1:7545 連接，
要實作連接，還需要一個資訊，那就是 Ganache 創建的區塊鏈網路，其 chain id 是多少？圖中只展示了 NETWORK ID（5777），查閱檔案，可知 chain id 為 1337（https://ethereum.stackexchange.com/questions/91072/setup-ganache-with-metamask-what-and-where-is-a-chain-id），
通常，我們不會將這些常量硬編碼到代碼中，而是通過組態檔或環境變數的形式引入，這里使用環境變數的形式，Python 中使用環境變數比較好的方式是使用 python-dotenv 這個庫，pip 安裝一下，然后再專案根目錄中創建名為.env 的檔案，寫入如下內容：
RINKEBY_RPC_URL=http://127.0.0.1:7545
ACCOUNT_ADDRESS=0x4A151d2855eEFba23Eb9B7943253D29E061cFeFD
PRIVATE_KEY=0xc6ba82d2e7bc2ab41f578a57b8822767b9875e339d2f93d3fe8eef25f5cb39aa然后代碼里使用一下：
from dotenv import load_dotenv
load_dotenv()
w3 = Web3(Web3.HTTPProvider(os.getenv("RINKEBY_RPC_URL")))
chain_id = 1337
my_address = os.getenv("ACCOUNT_ADDRESS")
private_key = os.getenv("PRIVATE_KEY")Web3.py 部署智能合約
部署的流程比較簡單，直接給出代碼：
from base import *
# 構建智能合約物件
storage = w3.eth.contract(abi=abi, bytecode=bytecode)
# 當前區塊鏈中最后一個交易的nonce
nonce = w3.eth.get_transaction_count(my_address)
# 部署智能合約 - 創建交易
transaction = storage.constructor().buildTransaction(
{"chainId": chain_id, "from": my_address, "nonce": nonce}
)
# 簽名當前交易 - 證明是你發起的交易
signed_txn = w3.eth.account.sign_transaction(transaction, private_key=private_key)
print("Deploying Contract!")
# 開始部署 - 發送交易
tx_hash = w3.eth.send_raw_transaction(signed_txn.rawTransaction)
print('Waiting for deploy transaction to finish...')
# 等待智能合約部署結果，部署完后，會獲得合約的地址
tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
print('Deployed Done!')
print(f'contract address: {tx_receipt.contractAddress}')上述代碼中，一開始通過 w3.eth.contract 方法實體化合約物件，需要傳入 abi 與 bytecode（base.py 提供了），
然后對合約進行部署，部署的程序其實也是在創建交易，這就涉及到：
創建交易物件
簽名交易
發送交易
等待交易完成
上述代碼剛好就是這幾個步驟，需要注意的點是 nonce，每個交易都需要 nonce，這個 nonce 是順序的，所有我們需要獲取最后一個交易的 nonce，運行代碼，結果如下圖：
部署后，智能合約的地址：0x8395Fd53331cea813e3838F6bB42B9668BEBf0C2
Web3.py 呼叫部署的智能合約
部署完后，我們獲得了合約部署后的地址，使用該地址，可以構建出合約物件，然后我們就可以呼叫合約里的方法了，回顧一開始我們撰寫的合約，其實只有 addPerson 這一個方法，該方法會將傳入方法的資料存到區塊鏈網路中，這改變了區塊鏈的狀態，所以算是一次交易操作，凡是交易操作就需要簽名，從而證明這個操作是你做的，
完整代碼如下：
from base import *
# 呼叫deploy.py會獲得contract_address
contract_address = '0x5071ad6611B322647B88ACF5CBeBCA71Bead0c6f'
nonce = w3.eth.get_transaction_count(my_address)
# 實體化合約物件
storage = w3.eth.contract(address=contract_address, abi=abi)
# 呼叫addPerson方法
transaction = storage.functions.addPerson('二兩', 28).buildTransaction({
"chainId": chain_id,
"from": my_address,
"nonce": nonce
})
# 簽名
signed_transaction = w3.eth.account.sign_transaction(transaction, private_key=private_key)
# 發送交易
tx_hash = w3.eth.send_raw_transaction(signed_transaction.rawTransaction)
print('add new Person to contract...')
# 等待交易完成
tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
# 獲得people陣列中存盤的值
result = storage.functions.people(0).call()
print(f'get person info: {result}')因為 addPerson 方法會改變區塊鏈，即需要消耗 Gas 的交易行為，這類行為都需要使用私鑰進行簽名，然后才能發送交易，呼叫完 addPerson 函式后，再從 people 陣列獲取下標為 0 的資料，
這里提一下 ABI，讓大家有更直觀的理解，在上述代碼中，為啥可以呼叫 addPerson 函式和 people 陣列？因為編譯后獲得的智能合約的 ABI 中存在 addPerson 與 people，復制 compiled_code.json 中 abi 的內容：
"abi": [
{
"inputs": [
{
"internalType": "string",
"name": "_name",
"type": "string"
},
{
"internalType": "uint256",
"name": "_age",
"type": "uint256"
}
],
"name": "addPerson",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"name": "people",
"outputs": [
{
"internalType": "string",
"name": "name",
"type": "string"
},
{
"internalType": "uint256",
"name": "age",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
}
],以 addPerson 函式為例，其 type 為 function，name 為 addPerson，inputs 表示呼叫該方法需傳入的引數，也給出了 type，通過 abi，程式才知道當前的智能合約提供什么功能，
部署到 Rinkeby 測驗網路
通過上面的操作，我們已經可以將智能合約部署到測驗網路中了，那如何部署到測驗網路中？Web3.py 不像 Remix IDE 提供 Inject Web3 的功能，要部署到測驗網路，我們需要借助第三方服務，與之相關的服務有：alchemy、infura 等，
簡單而言，在這些服務對應的網站上，注冊賬號，創建應用，然后拿到開發用的 key，然后使用這個 key 與這些服務互動，我們會連接到這些服務上，然后服務會為我們將應用發布到測驗網路或以太坊主網上，與我們平時使用百度、高德等 API 平臺沒啥差別，都是創建應用獲得 key，
這里我們使用 infura 服務，infura 服務大體的作業方式如下圖，簡單來說，我們不需要將自己本地的計算機加入到以太坊網路中，成為其中的節點（挺麻煩的，要拉資料、足夠的網速和足夠的硬碟空間），而是直接通過 infura 服務連接（本質是使用 infura 的節點），
從圖中可知，我們通過 infura 提供的 ITX API 便可以與以太坊網路互動了，然后你創建應用，在應用的設定頁，可以看到相應的資訊，需要注意的是，【ENDPOINTS】處需要選擇 rinkeby 測驗網路，如下圖：
有了這些設定后，我們修改一下.env 檔案中的內容：
RINKEBY_RPC_URL=https://rinkeby.infura.io/v3/<project_id>
ACCOUNT_ADDRESS=<賬號地址>
PRIVATE_KEY=<對應的私鑰>
CHAIN_ID=4RINKEBY_RPC_URL 給我 Infura 給的 http 地址，ACCOUNT_ADDRES 與 PRIVATE_KEY 可以在 MetaMask 錢包中獲取（獲取 Rinkeby 上的），為了方便，我將 CHAIN_ID 也放到.env 中了，不同的鏈具有通過的 CHAIN_ID，可以通過 https://chainlist.org/ 查詢：
代碼中連接網路的方式不需要改變，只是我們將 CHAIN_ID 抽到.env 中了，getenv 函式會回傳字串格式，需要強轉一下，
w3 = Web3(Web3.HTTPProvider(os.getenv("RINKEBY_RPC_URL")))
chain_id = int(os.getenv("CHAIN_ID"))然后我們部署，然后呼叫合約中的方法，使用 play_storage.py 時，因為合約地址變了，所以你需要同步修改一下 contract_address 變數，呼叫后，可以通過 etherscan 查看：
專案代碼：GitHub - ayuLiao/web3py_storage: use web3.py play ethereum contract
如果你在使用 Infura 時，發現總是 403，可以嘗試洗掉掉原本的 project，創建一個新的 project，
Brownie 基礎
上面通過 Web3.py 實作了智能合約的部署與互動，可以發現還是比較麻煩的，每次觸發交易時，都需要進行簽名操作等，Brownie 框架基于 Web3.py，它將很多步驟都幫我們靜默完成了，如果你不了解 Web3.py，直接上 Brownie 框架，個人感覺也不好，因為會顯得比較黑盒，
安裝 Brownie
我們通過 pip 安裝一下 Brownie，閱讀檔案，會發現 Brownie 建議使用 pipx 來安裝，pipx 會在全域創建一個虛擬環境，然后將 Brownie 安裝在虛擬環境中，研究后發現，這是因為 Brownie 依賴比較多，安裝程序比較慢，如果你通過 venv 方式，每個專案都要來一次，挺費時間的，因我 Windows 的環境問題，我懶得折騰，我自己管理員開 Terminal 直接 pip 安裝：
pip install eth-brownie安裝完后，根據檔案，我們還需要安裝一下 ganache-cli（github.com/trufflesuite/ganache），命令列版的 ganache，npm 全域安裝一下則可，
npm install ganache-cli@latest --global在 Terminal 中輸入 brownie 與 ganache-cli 都可以正常使用則表示安裝成功，
快速使用 Brownie
創建名為【brownie_storage】的檔案夾，進入該檔案夾，然后通過 brownie init 初始化專案，會獲得如下結構，每個檔案夾的作用也標準了：
C:\USERS\AYU\WORKPLACE\BLOCKCHAIN\BROWNIE_STORAGE
├───build # 編譯、部署等結果存放目錄
│ ├───contracts
│ ├───deployments
│ └───interfaces
├───contracts # 智能合約的目錄
├───interfaces # 介面的目錄
├───reports # JSON報告檔案的目錄（使用GUI的用戶才會使用）
├───scripts # 腳本的目錄
└───tests # 測驗腳本目錄在使用 Brownie 撰寫代碼前，先使用 ganache-cli 啟動本地的以太坊網路，方便測驗：
然后，我們將 Storage.sol 復制到 contracts 目錄中，通過 brownie compile 命令編譯智能合約，該命令會將 contracts 目錄下所有的智能合約都進行編譯，編譯完成后，在 build/contracts 會出現同名的 json 檔案，與 Web3.py 類似，這里記錄著智能合約的 bytecode、abi 等資訊，
完成編譯后，接著進行部署，在 scripts 目錄下創建 deploy.py，其代碼如下：
from brownie import accounts, config, network, Storage
def deploy_storage():
account = get_account()
# Instantiate Storage contract
storage = Storage.deploy({"from": account})
# call addPerson function
transaction = storage.addPerson('二兩', 28, {"from": account})
# wait transaction finish
transaction.wait(1)
# call people function to get data from people array
result = storage.people(0)
print('result: ', result)
def get_account():
if network.show_active() == 'development':
return accounts[0]
else:
# add new account to brownie accounts
# account config data from brownie-config.yaml
return accounts.add(config['wallets']['account_key'])
def main():
deploy_storage()在 Windows 中，brownie 不支持 python 中有中文注釋，估計是沒有兼容好，
相比于 Web3.py，brownie 簡單了很多，你只需匯入 Storage，然后呼叫其 deploy 方法則可，因為 Storage 其實是動態載入的，brownie 本身并沒有這個類，所以我們不可以直接通過 python 去運行 deploy.py 檔案，而是需要使用 brownie run .\scripts\deploy.py 命令去運行：
上述代碼中，定義了 get_account 函式，該函式會判斷當前處于哪個區塊鏈，從而使用想要的方式獲得 account，brownie 默認處于 development（本地開發網路），如果不處于 development，則通過 brownie 提供的 accounts.add 函式添加賬戶物件，比如后面我們會部署到 Rinkeby，就需要從錢包里拿私鑰（賬號公鑰資訊可以通過私鑰推導獲得），這里為了方便，直接放在組態檔中，
brownie 提供的 config 模型，會自動從專案根目錄的 brownie-config.yaml 中獲取，在這里，該檔案內容如下：
dotenv: .env
wallets:
from_key: ${PRIVATE_KEY}因為私鑰比較重要，也規范一些，這里通過 ${PRIVATE_KEY} 匯入專案根目錄下.env 檔案中的內容，
此外，我們還可以使用 brownie console，進入 brownie 提供的互動式命令環境，在該環境里，你可以使用 brownie 中的任何功能，
> brownie console
Brownie v1.17.0 - Python development framework for Ethereum
BrownieStorageProject is the active project.
c:\program files\python37\lib\site-packages\brownie\network\main.py:46: BrownieEnvironmentWarning: Development network has a block height of 6
BrownieEnvironmentWarning,
Attached to local RPC client listening at '127.0.0.1:8545'...
Brownie environment is ready.
>>> from brownie import network
>>> network.show_active()
'development'
>>> from brownie import accounts
>>> account = accounts[0]
>>> from brownie import Storage
>>> storage = Storage.deploy({"from": account})
Transaction sent: 0xd7269730fb3ee3a642391c338234f9cb63993b7bd991316971c89ca6406cebe7
Gas price: 0.0 gwei Gas limit: 6721975 Nonce: 6
Storage.constructor confirmed Block: 7 Gas used: 243848 (3.63%)
Storage deployed at: 0x500F5EDceE38597164c26606E93e92D059853a46
>>> transaction = storage.addPerson('二兩', 28, {"from": account})
Transaction sent: 0x2aa19410ddc316413f54a6e1c25f6a5878b7a0877fa65a5bec80f380ba3c64aa
Gas price: 0.0 gwei Gas limit: 6721975 Nonce: 7
Storage.addPerson confirmed Block: 8 Gas used: 84259 (1.25%)
>>> transaction.wait(1)
Storage.addPerson confirmed Block: 8 Gas used: 84259 (1.25%)進行單元測驗
智能合約通常與錢相關，做好測驗是非常有必要的，brownie 使用 pytest 來實作單元測驗，至于 pytest，用過的都說好），在 tests 目錄創建名為 test_storage.py 的檔案，代碼如下：
from brownie import Storage, accounts
def test_deploy():
account = accounts[0]
storage = Storage.deploy({"from": account})
transaction = storage.addPerson('二兩', 28, {"from": account})
transaction.wait(1)
# call people function to get data from people array
result = storage.people(0)
assert result == ('二兩', 28)很常規的單元測驗代碼，可以將智能合約部署的程序與 CI/CD 流程結合，每次部署都過一遍所有的單元測驗，從而讓合約更加健碩，
使用 Brownie 將合約部署到測驗網路
閱讀檔案發現，在 Brownie 中通過 Infura 服務進行合約的部署，只需要配置一下則可，檔案內容：https://eth-brownie.readthedocs.io/en/latest/network-management.html#using-infura
除了可以通過 export 的方式添加 WEB3_INFURA_PROJECT_ID 環境變數，我們還可以將 WEB3_INFURA_PROJECT_ID 直接添加到.env 中（檔案里沒寫），
WEB3_INFURA_PROJECT_ID 就是 Infura 為你提供的 Project ID，此外，因為要連接測驗網路，所以部署時需要連接測驗網路中的賬號，你需要將你賬號的私鑰也放到.env 中，
PRIVATE_KEY= <你賬號的私鑰>
WEB3_INFURA_PROJECT_ID=<Infura中的Project ID>然后通過 brownie run .\scripts\deploy.py --network rinkeby 運行則可完成部署，
brownie 提供了多種網路，所以我們部署時不需要欄位外操作，直接指定對應的網路則可，
當然，后續開發時，我們還可以 brownie networks add 命令添加新的網路，
專案代碼：https://github.com/ayuLiao/brownie_storage
結尾
這篇文章只是簡單的介紹了 Brownie 的一些操作，Brownie 還具有很多高級功能，比如 Mock、Fork 一個區塊鏈到本地進行開發、又比如 Brownie 提供了 Debug Tools 供你進行除錯開發，后續的文章會分享這些內容，
最后提一嘴，Brownie 的檔案是很好的學習資料，
轉載請註明出處，本文鏈接：https://www.uj5u.com/qukuanlian/351046.html
標籤：區塊鏈