Truffle詳解

以太坊最受歡迎的開發框架是使用web3.js的Truffle，

Truffle使用以太坊虛擬機（EVM）為區塊鏈提供世界一流的開發環境、測驗框架和資產管道，旨在讓開發人員的生活更輕松，

• 內置智能合約編譯、鏈接、部署和二進制管理，
• 快速開發的自動化合約測驗，
• 腳本化、可擴展的部署和遷移框架，
• 用于部署到任意數量的公共和專用網路的網路管理，
• 使用EthPM和NPM進行軟體包管理，使用ERC190標準，
• 用于直接合約通信的互動式控制臺，
• 支持緊密集成的可配置構建管道，
• 在Truffle環境中執行腳本的外部腳本運行器，

安裝Truffle

npm install -g truffle

環境要求：

• NodeJS v8.9.4或更高版本
• Windows、Linux或Mac OS X
• 一個正在運行的以太坊客戶端，該客戶端支持標準的JSON RPC API

創建專案

Truffle 大多數命令都是在 Truffle 專案目錄下運行的， 所以第一步是創建一個 Truffle 專案， 可以創建一個空專案模板，不過對于Truffle初學者，推薦使用Truffle Boxes，它提供了示例應用代碼和專案模板， 下面將使用MetaCoin box作為案例，它創建一個可以在帳戶之間轉移的Token（代幣），

1、為Truffle專案創建新目錄：

mkdir MetaCoin
cd MetaCoin

2、下載（“unbox”）MetaCoin box：

truffle unbox metacoin

可以使用 truffle unbox <box-name> 命令下載其他的 Box

3、要創建不含智能合約的空白Truffle專案，可以使用truffle init，

truffle init

可以使用一個可選的選項 –force 在當前目錄下初始化專案，不管當前目錄的狀態（即使它包含了其他人檔案和目錄）， 這個選項可用于 init 和 unbox 命令，不過要小心他會覆寫當前已經存在的檔案或目錄，

操作完成后，就有這樣的一個專案目錄結構：

• contracts/：Solidity合約目錄
• migrations/：部署腳本檔案目錄
• test/：用于測驗應用程式和合約的測驗腳本目錄
• truffle.js：Truffle組態檔

專案架構

• contracts/MetaCoin.sol：這是一個智能合約（用Solidity撰寫），可以創建一個MetaCoin令牌，注意，它參考了同目錄中的另一個Solidity檔案contracts/ConvertLib.sol，
• contracts/Migrations.sol：這是一個單獨的Solidity檔案，用于管理和更新已部署的智能合約的狀態，該檔案隨附于每個Truffle專案一起使用，通常不會編輯，
• migrations/1_initial_migration.js：該檔案是Migrations.sol中定義的遷移 (部署) 腳本
• migrations/2_deploy_contracts.js：該檔案是MetaCoin合約的遷移腳本，（遷移腳本按順序運行，因此以2開頭的檔案將在以1開頭的檔案之后運行，）
• test/TestMetaCoin.sol：這是一個用Solidity撰寫的測驗檔案，可確保你的合約正常作業，
• test/metacoin.js：這是一個用JavaScript撰寫的測驗檔案，執行的功能與上面的Solidity測驗相似，
• truffle-config.js：這是網路資訊和其他專案相關設定的Truffle組態檔，

測驗

在終端中，運行Solidity測驗：

truffle test ./test/TestMetaCoin.sol

輸出資訊：

TestMetacoin
√ testInitialBalanceUsingDeployedContract (71ms)
√ testInitialBalanceWithNewMetaCoin (59ms)

2 passing (794ms)

運行JavaScript測驗：

truffle test ./test/metacoin.js

輸出資訊

Contract: MetaCoin
√ should put 10000 MetaCoin in the first account
√ should call a function that depends on a linked library (40ms)
√ should send coin correctly (129ms)

3 passing (255ms)

編譯

編譯智能合約：

truffle compile

首次運行時，將編譯所有合約， 在后續運行中，Truffle將僅編譯自上次編譯以來有更改的合約， 如果我們想覆寫此行為，可以使用 --all 選項運行上面的命令，

輸出資訊：

Compiling .\contracts\ConvertLib.sol...
Compiling .\contracts\MetaCoin.sol...
Compiling .\contracts\Migrations.sol...

Writing artifacts to .\build\contracts

設定truffle專案的solidity編譯器版本

truffle允許我們指定專案中使用哪個版本的編譯器，只需要在truffle專案的組態檔truffle.js中設定compiler選項，例如，下面的組態檔將當前專案的solidity編譯器設定為0.8.0版本：

module.exports = {
  networks: {
    ... etc ...
  },
  compilers: {
     solc: {
       version: "0.8.0"
     }
  }
};

只需要在compilers.solc.version處指定要啟用的solidity編譯器版本就行了，truffle會自動從官方拉取相應版本的編譯器，無需手動下載配置，

使用Truffle Develop遷移

要部署我們的智能合約，我們需要連接到區塊鏈，Truffle有一個內置的個人區塊鏈，可用于測驗，此區塊鏈是你的本地區塊鏈，不與以太坊主網路互動，

你可以創建此區塊鏈，并使用Truffle Develop與之互動，

運行Truffle Develop：

truffle develop

輸出資訊：

Truffle Develop started at http://127.0.0.1:9545/

Accounts:
(0) 0x627306090abab3a6e1400e9345bc60c78a8bef57
(1) 0xf17f52151ebef6c7334fad080c5704d77216b732
(2) 0xc5fdf4076b8f3a5357c5e395ab970b5b54098fef
(3) 0x821aea9a577a9b44299b9c15c88cf3087f3b5544
(4) 0x0d1d4e623d10f9fba5db95830f7d3839406c6af2
(5) 0x2932b7a2355d6fecc4b5c0b6bd44cc31df247a2e
(6) 0x2191ef87e392377ec08e7c08eb105ef5448eced5
(7) 0x0f4f2ac550a1b4e2280d04c21cea7ebd822934b5
(8) 0x6330a553fc93768f612722bb8c2ec78ac90b3bbc
(9) 0x5aeda56215b167893e80b4fe645ba6d5bab767de

Private Keys:
(0) c87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3
(1) ae6ae8e5ccbfb04590405997ee2d52d2b330726137b875053c36d94e974d162f
(2) 0dbbe8e4ae425a6d2687f1a7e3ba17bc98c673636790f1b8ad91193c05875ef1
(3) c88b703fb08cbea894b6aeff5a544fb92e78a18e19814cd85da83b71f772aa6c
(4) 388c684f0ba1ef5017716adb5d21a053ea8e90277d0868337519f97bede61418
(5) 659cbb0e2411a44db63778987b1e22153c086a95eb6b18bdf89de078917abc63
(6) 82d052c865f5763aad42add438569276c00d3d88a2d062d36b2bae914d58b8c8
(7) aa3680d5d48a8283413f7a108367c7299ca73f553735860a87b08f39395618b7
(8) 0f62d96d6675f32685bbdb8ac13cda7c23436f63efbb9d07700d8669ff12b7c4
(9) 8d5366123cb560bb606379f90a0bfd4769eecc0557f1b362dcae9012b548b1e5

Mnemonic: candy maple cake sugar pudding cream honey rich smooth crumble sweet treat

?? Important ?? : This mnemonic was created for you by Truffle. It is not secure.
Ensure you do not use it on production blockchains, or else you risk losing funds.

truffle(development)>

這里列出了在與區塊鏈互動時可以使用的十個帳戶（及其私鑰），

在Truffle develop提示符上，可以通過省略truffle前綴來運行Truffle命令，例如，要在提示符上運行truffle compile，請鍵入compile，將編譯的合約部署到區塊鏈的命令是truffle migrate，因此在提示符處鍵入：

migrate

輸出資訊：

Starting migrations...
======================
> Network name: 'develop'
> Network id: 4447
> Block gas limit: 6721975

1_initial_migration.js
======================

Deploying 'Migrations'
----------------------
> transaction hash: 0x3fd222279dad48583a3320decd0a2d12e82e728ba9a0f19bdaaff98c72a030a2
> Blocks: 0 Seconds: 0
> contract address: 0xa0AdaB6E829C818d50c75F17CFCc2e15bfd55a63
> account: 0x627306090abab3a6e1400e9345bc60c78a8bef57
> balance: 99.99445076
> gas used: 277462
> gas price: 20 gwei
> value sent: 0 ETH
> total cost: 0.00554924 ETH

> Saving migration to chain.
> Saving artifacts
-------------------------------------
> Total cost: 0.00554924 ETH

2_deploy_contracts.js
=====================

Deploying 'ConvertLib'
----------------------
> transaction hash: 0x97e8168f1c05fc40dd8ffc529b9a2bf45cc7c55b07b6b9a5a22173235ee247b6
> Blocks: 0 Seconds: 0
> contract address: 0xfb39FeaeF3ac3fd46e2123768e559BCe6bD638d6
> account: 0x627306090abab3a6e1400e9345bc60c78a8bef57
> balance: 99.9914458
> gas used: 108240
> gas price: 20 gwei
> value sent: 0 ETH
> total cost: 0.0021648 ETH

Linking
-------
* Contract: MetaCoin <--> Library: ConvertLib (at address: 0xfb39FeaeF3ac3fd46e2123768e559BCe6bD638d6)

Deploying 'MetaCoin'
--------------------
> transaction hash: 0xee4994097c10e7314cc83adf899d67f51f22e08b920e95b6d3f75c5eb498bde4
> Blocks: 0 Seconds: 0
> contract address: 0x6891Ac4E2EF3dA9bc88C96fEDbC9eA4d6D88F768
> account: 0x627306090abab3a6e1400e9345bc60c78a8bef57
> balance: 99.98449716
> gas used: 347432
> gas price: 20 gwei
> value sent: 0 ETH
> total cost: 0.00694864 ETH

> Saving migration to chain.
> Saving artifacts
-------------------------------------
> Total cost: 0.00911344 ETH

Summary
=======
> Total deployments: 3
> Final cost: 0.01466268 ETH

這將顯示已部署合約的交易ID和地址，它還包括成本摘要和實時狀態更新，

替代方案：使用Ganache遷移

雖然Truffle Develop是一個多合一的個人區塊鏈和控制臺，但你也可以使用桌面應用程式Ganache啟動你的個人區塊鏈，Ganache對于以太坊和區塊鏈的新手來說，這可能是一個更易于理解的工具，因為它預先顯示更多資訊，

除了運行Ganache外，唯一的額外步驟是它需要編輯Truffle組態檔才能指向Ganache實體，

1、下載并安裝Ganache，

2、在文本編輯器中打開truffle-config.js，將內容替換為以下內容：

module.exports = {
  networks: {
    development: {
      host: "127.0.0.1",
      port: 7545,
      network_id: "*"
    }
  }
};

這將允許使用Ganache的默認連接引數進行連接，

3、保存并關閉該檔案，

4、啟動Ganache

5、在終端上，將合約遷移到Ganache創建的區塊鏈：

truffle migrate

輸出結果：

Compiling your contracts...
===========================
> Compiling ./contracts/ConvertLib.sol
> Compiling ./contracts/MetaCoin.sol
> Compiling ./contracts/Migrations.sol
> Artifacts written to /home/david/work/MetaCoin/build/contracts
> Compiled successfully using:
- solc: 0.5.16+commit.9c3226ce.Emscripten.clang

Starting migrations...
======================
> Network name: 'development'
> Network id: 5777
> Block gas limit: 6721975 (0x6691b7)

1_initial_migration.js
======================

Deploying 'Migrations'
----------------------
> transaction hash: 0x3eef05e35ce694c0b7112cc22ba462b9cc0563abc2cc444ee9683b6d89865e3c
> Blocks: 0 Seconds: 0
> contract address: 0x8CdaF0CD259887258Bc13a92C0a6dA92698644C0
> block number: 1
> block timestamp: 1587421933
> account: 0x627306090abaB3A6e1400e9345bC60c78a8BEf57
> balance: 99.9967165
> gas used: 164175 (0x2814f)
> gas price: 20 gwei
> value sent: 0 ETH
> total cost: 0.0032835 ETH

> Saving migration to chain.
> Saving artifacts
-------------------------------------
> Total cost: 0.0032835 ETH

2_deploy_contracts.js
=====================

Deploying 'ConvertLib'
----------------------
> transaction hash: 0x23de020bafa41e30615b1d775d2fa9604e876415408e012d1f0faf79eed3a32f
> Blocks: 0 Seconds: 0
> contract address: 0x345cA3e014Aaf5dcA488057592ee47305D9B3e10
> block number: 3
> block timestamp: 1587421933
> account: 0x627306090abaB3A6e1400e9345bC60c78a8BEf57
> balance: 99.99396028
> gas used: 95470 (0x174ee)
> gas price: 20 gwei
> value sent: 0 ETH
> total cost: 0.0019094 ETH

Linking
-------
* Contract: MetaCoin <--> Library: ConvertLib (at address: 0x345cA3e014Aaf5dcA488057592ee47305D9B3e10)

Deploying 'MetaCoin'
--------------------
> transaction hash: 0x0cc20353422c4d435f72e8e7850f8178f43bf8d00c8c0d09cc8e0ccdfa81b799
> Blocks: 0 Seconds: 0
> contract address: 0xf25186B5081Ff5cE73482AD761DB0eB0d25abfBF
> block number: 4
> block timestamp: 1587421934
> account: 0x627306090abaB3A6e1400e9345bC60c78a8BEf57
> balance: 99.98822922
> gas used: 286553 (0x45f59)
> gas price: 20 gwei
> value sent: 0 ETH
> total cost: 0.00573106 ETH

> Saving migration to chain.
> Saving artifacts
-------------------------------------
> Total cost: 0.00764046 ETH

Summary
=======
> Total deployments: 3
> Final cost: 0.01092396 ETH

這將顯示已部署合約的交易ID和地址，它還包括費用摘要和實時狀態更新，

1. 在Ganache中，單擊“TRANSACTIONS”按鈕查看交易是否已處理，
2. 要與合約互動，可以使用Truffle console，Truffle console與Truffle Develop相似，只是它連接到現有的區塊鏈（在這種情況下，是由Ganache生成的區塊鏈），

truffle console

你將看到以下提示：

truffle(development)>

與合約互動

控制臺通過以下方式與合約互動：

從Truffle v5起，控制臺支持異步/等待功能，從而實作與合約的更簡單的互動，

首先建立已部署的MetaCoin合約實體和由Truffle的內置區塊鏈或Ganache創建的帳戶：

truffle(development)> let instance = await MetaCoin.deployed()
truffle(development)> let accounts = await web3.eth.getAccounts()

檢查部署合約的帳戶的metacoin余額：

truffle(development)> let balance = await instance.getBalance(accounts[0])
truffle(development)> balance.toNumber()

查看該余額價值多少ETH（并注意合約將metacoin定義為價值2ETH）：

truffle(development)> let ether = await instance.getBalanceInEth(accounts[0])
truffle(development)> ether.toNumber()

將一些metacoin從一個帳戶轉移到另一個帳戶：

truffle(development)> instance.sendCoin(accounts[1], 500)

檢查收到metacoin的帳戶余額：

truffle(development)> let received = await instance.getBalance(accounts[1])
truffle(development)> received.toNumber()

檢查發送metacoin的帳戶余額：

truffle(development)> let newBalance = await instance.getBalance(accounts[0])
truffle(development)> newBalance.toNumber()