使用Truffle Console.log！智能合约调试更轻松

审校 | 孙淑娟

开篇

如果你是Solidity的开发者，你会很高兴听到Truffle现在支持Solidity智能合约的控制台记录。让我们来看看是如何实现的吧。虽然 Truffle 长期以来处于智能合约开发工具领导者的地位--为创建、测试和调试智能合约提供使用环境--直接集成控Console.log是它需要开发的一项功能。

但现在不需要了! 开发人员现在可以轻松地记录信息和调试智能合约，所有这些都在Truffle（Ganache）环境中。让我们来看看它是如何实现的。

什么是Console.log？

Console.log是JavaScript中一个非常流行的功能，被开发人员用于输出日志信息，并直接从代码中提取细节。在Web3和智能合约开发的背景下，console.log扮演着类似的角色，允许开发者从他们的智能合约中打印出Solidity变量和其他信息。

例如，您可以使用 console.log 来显示一个变量的值或智能合约中的一个函数调用的输出。在调试或测试你的智能合约时，这可能是非常有用的。

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显示的其他内容相区别。
• preventConsoleLogMigration：当在测试时，阻止合同部署的进行。如果你希望在部署合同时包含console.log，你可以选择不这样做。然而，如果你选择这样做，请记住console.log在使用Gas时有不可预知的行为。（编者注明：Gas 在使用了智能合约时，交易要是按照智能合约的规定一步一步执行命令，每执行一个命令都会产生一定的消耗，这个消耗用Gas作为单位）

如果你准备好了，可以试一试了。像往常一样将 contract.sol 合同导入你的 Solidity 代码中。现在你已经准备好像在 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);
  }
}

上面的转移函数显示了console.log的作用。想象一下，对转移函数的调用因 " Not enough tokens"错误而失败。在这种情况下，console.log行将显示该调用试图转移的代币数量。这使得开发者可以看到正在转移的地址和代币数量。该消息看起来像这样。

...
Transferring 10 tokens to 0x377bbcae5327695b32a1784e0e13bedc8e078c9c

一个更好的调试方法是将余额[msg.sender]加入到console.log语句中，或将其单独打印出来。这样一来，发件人的余额在控制台中也是可见的。就是这么简单！

你也可以在测试和主网中留下日志；这样一来，你就有了一个观察你的智能合约的好方法。而且值得一提的是，像Tenderly这样的工具会整合日志的报废，这在生产环境中调试和测试智能合约时很有用。（编者注明：主网就是发生实际交易的地方，在主网上会记录在特定的分布式账本上。 例如，以太坊主网是公共区块链，能进行网络验证和交易。）

最后，在使用控制台日志时，重要的是要遵循你已经知道的所有良好的使用规则，例如使用清晰和描述性的日志信息。这将使其更容易理解，并识别可能出现的任何问题。

Truffle中的其他调试工具

虽然控制台日志是调试智能合约的强大工具，但请记住，Truffle也提供其他调试工具。Truffle有一个强大的内置调试器CLI工具，可用于逐步执行智能合约并检查执行中不同点的变量状态。此外，针对事件可以进行记录信息和跟踪智能合约行为。

也就是说，只为变量输出使用调试器可能是矫枉过正。同样，事件记录只有在交易成功时才会发挥作用，这在某些情况下可能是一种限制。

console.log  中的Bottom line功能与Truffle中的其他调试工具相结合，使调试工作更加简单易用，为开发者提供更好的体验。它使开发人员能够快速、轻松地记录信息并监控其智能合约的行为，而其他调试工具可用于更高级的调试和故障排除。

试用

Truffle的新控制台记录功能是对智能合约开发的宝贵补充。它容易使用，可以简化调试和测试过程。记录信息和实时跟踪智能合约行为的能力可以减少效率低下和头痛的问题。它将会成为你工具箱中的一个伟大工具。

译者介绍

崔皓，51CTO社区编辑，资深架构师，拥有18年的软件开发和架构经验，10年分布式架构经验。

原文​​Easy Smart Contract Debugging With Truffle’s Console.log​​，作者：Michael Bogan