譯者 | 崔皓

審校 | 孫淑娟

開篇

如果你是Solidity的開發(fā)者，你會很高興聽到Truffle現(xiàn)在支持Solidity智能合約的控制臺記錄。讓我們來看看是如何實現(xiàn)的吧。雖然 Truffle 長期以來處于智能合約開發(fā)工具領(lǐng)導(dǎo)者的地位--為創(chuàng)建、測試和調(diào)試智能合約提供使用環(huán)境--直接集成控Console.log是它需要開發(fā)的一項功能。

但現(xiàn)在不需要了! 開發(fā)人員現(xiàn)在可以輕松地記錄信息和調(diào)試智能合約，所有這些都在Truffle（Ganache）環(huán)境中。讓我們來看看它是如何實現(xiàn)的。

什么是Console.log？

Console.log是JavaScript中一個非常流行的功能，被開發(fā)人員用于輸出日志信息，并直接從代碼中提取細(xì)節(jié)。在Web3和智能合約開發(fā)的背景下，console.log扮演著類似的角色，允許開發(fā)者從他們的智能合約中打印出Solidity變量和其他信息。

例如，您可以使用 console.log 來顯示一個變量的值或智能合約中的一個函數(shù)調(diào)用的輸出。在調(diào)試或測試你的智能合約時，這可能是非常有用的。

console.log("Console Logging: The Smart Contract Developer's Best Friend");

如何在Truffle中使用控制臺記錄

使用其console.log非常簡單。首先，確保電腦上運行的是最新的Truffle版本。如果存在任何問題，可能需要完全卸載軟件包，然后再重新安裝它。在這篇文章中使用的命令，我們將使用NPM作為我們的包管理器。

$ npm install -g truffle

安裝成功后，我建議你修改truffle配置文件（即truffle-config.js），如下所示：

module.exports = {
  . . .
  solidityLog: {
    displayPrefix: ' :', // defaults to ""
    preventConsoleLogMigration: true, // defaults to false
  }

• displayPrefix：裝飾來自console.log的輸出，使其與CLI顯示的其他內(nèi)容相區(qū)別。
• preventConsoleLogMigration：當(dāng)在測試時，阻止合同部署的進行。如果你希望在部署合同時包含console.log，你可以選擇不這樣做。然而，如果你選擇這樣做，請記住console.log在使用Gas時有不可預(yù)知的行為。（編者注明：Gas 在使用了智能合約時，交易要是按照智能合約的規(guī)定一步一步執(zhí)行命令，每執(zhí)行一個命令都會產(chǎn)生一定的消耗，這個消耗用Gas作為單位）

如果你準(zhǔn)備好了，可以試一試了。像往常一樣將 contract.sol 合同導(dǎo)入你的 Solidity 代碼中?，F(xiàn)在你已經(jīng)準(zhǔn)備好像在 JavaScript 中那樣使用 console.log() 命令。

這包括使用字符串替換，如%s和%f：

pragma solidity ^0.8.9;
import "truffle/console.sol";
contract BookStore {
  //...

  function transfer(address to, uint256 amount) external {
    console.log("Transferring %s tokens to %s", amount, to);

    require(balances[msg.sender] >= amount, "Not enough tokens");

    balances[msg.sender] -= amount;
    balances[to] += amount;

    emit Transfer(amount, to, msg.sender);
  }
}

上面的轉(zhuǎn)移函數(shù)顯示了console.log的作用。想象一下，對轉(zhuǎn)移函數(shù)的調(diào)用因 " Not enough tokens"錯誤而失敗。在這種情況下，console.log行將顯示該調(diào)用試圖轉(zhuǎn)移的代幣數(shù)量。這使得開發(fā)者可以看到正在轉(zhuǎn)移的地址和代幣數(shù)量。該消息看起來像這樣。

...
Transferring 10 tokens to 0x377bbcae5327695b32a1784e0e13bedc8e078c9c

一個更好的調(diào)試方法是將余額[msg.sender]加入到console.log語句中，或?qū)⑵鋯为毚蛴〕鰜?。這樣一來，發(fā)件人的余額在控制臺中也是可見的。就是這么簡單！

你也可以在測試和主網(wǎng)中留下日志；這樣一來，你就有了一個觀察你的智能合約的好方法。而且值得一提的是，像Tenderly這樣的工具會整合日志的報廢，這在生產(chǎn)環(huán)境中調(diào)試和測試智能合約時很有用。（編者注明：主網(wǎng)就是發(fā)生實際交易的地方，在主網(wǎng)上會記錄在特定的分布式賬本上。 例如，以太坊主網(wǎng)是公共區(qū)塊鏈，能進行網(wǎng)絡(luò)驗證和交易。）

最后，在使用控制臺日志時，重要的是要遵循你已經(jīng)知道的所有良好的使用規(guī)則，例如使用清晰和描述性的日志信息。這將使其更容易理解，并識別可能出現(xiàn)的任何問題。

Truffle中的其他調(diào)試工具

雖然控制臺日志是調(diào)試智能合約的強大工具，但請記住，Truffle也提供其他調(diào)試工具。Truffle有一個強大的內(nèi)置調(diào)試器CLI工具，可用于逐步執(zhí)行智能合約并檢查執(zhí)行中不同點的變量狀態(tài)。此外，針對事件可以進行記錄信息和跟蹤智能合約行為。

也就是說，只為變量輸出使用調(diào)試器可能是矯枉過正。同樣，事件記錄只有在交易成功時才會發(fā)揮作用，這在某些情況下可能是一種限制。

console.log  中的Bottom line功能與Truffle中的其他調(diào)試工具相結(jié)合，使調(diào)試工作更加簡單易用，為開發(fā)者提供更好的體驗。它使開發(fā)人員能夠快速、輕松地記錄信息并監(jiān)控其智能合約的行為，而其他調(diào)試工具可用于更高級的調(diào)試和故障排除。

試用

Truffle的新控制臺記錄功能是對智能合約開發(fā)的寶貴補充。它容易使用，可以簡化調(diào)試和測試過程。記錄信息和實時跟蹤智能合約行為的能力可以減少效率低下和頭痛的問題。它將會成為你工具箱中的一個偉大工具。

譯者介紹

崔皓，51CTO社區(qū)編輯，資深架構(gòu)師，擁有18年的軟件開發(fā)和架構(gòu)經(jīng)驗，10年分布式架構(gòu)經(jīng)驗。

原文標(biāo)題：??Easy Smart Contract Debugging With Truffle’s Console.log??，作者：Michael Bogan