Web3.js 全面指南：发布和执行智能合约

2023-11-06 11:15:34

前言

在去中心化应用程序（dApp）开发中，智能合约扮演着至关重要的角色。智能合约是存储在区块链上的程序，可以自动执行预先定义的规则和条款。为了与智能合约进行交互，开发者需要使用专门的工具，例如 Web3.js。

Web3.js 是一个开源 JavaScript 库，可简化与以太坊区块链的交互。它提供了一个直观的 API，允许开发者轻松发布、调用和监听智能合约。本文将深入探讨使用 Web3.js 与智能合约交互的各个方面，包括合约生命周期、函数调用和事件监听。

智能合约生命周期

智能合约的生命周期分为以下几个阶段：

创建

合约创建始于编写智能合约代码。通常使用 Solidity 语言编写合约代码，Solidity 是一种面向智能合约的高级编程语言。代码完成后，将其编译成字节码，字节码是可以在区块链上执行的低级代码。

部署

编译后的字节码可以通过 Web3.js 部署到区块链上。部署过程涉及向网络发送交易，该交易包含合约字节码和相关参数。成功部署后，合约将获得一个唯一的地址。

交互

部署后的合约可以通过 Web3.js 进行交互。交互包括调用合约函数、读取合约状态或监听合约事件。

销毁

在某些情况下，可能需要销毁合约。销毁合约需要调用一个特殊的函数（例如 selfdestruct），该函数将从区块链中删除合约。

函数调用

Web3.js 允许开发者调用智能合约中定义的函数。调用函数的过程如下：

创建合约实例： 使用 web3.eth.contract() 创建合约实例，并指定合约的 ABI（应用程序二进制接口）和地址。
调用函数： 使用合约实例调用函数，并传递必要的参数。
发送交易： Web3.js 将函数调用打包成交易，并将其发送到网络。
等待确认： 等待网络确认交易，以确保函数调用成功执行。

事件监听

智能合约可以发出事件，以通知应用程序状态的变化或动作的完成。Web3.js 允许开发者监听这些事件并做出相应的反应。监听事件的过程如下：

创建事件过滤器： 使用 合约实例.events 创建事件过滤器，并指定要监听的事件类型。
监听事件： 使用 on() 方法监听事件，并提供一个回调函数来处理事件。
取消监听： 当不再需要监听事件时，可以使用 off() 方法取消监听。

实际应用

让我们通过一个实际示例来说明使用 Web3.js 与智能合约交互的过程。我们将构建一个简单的投票合约，允许用户对候选人进行投票。

编写智能合约

pragma solidity ^0.8.0;

contract Voting {
    // 候选人列表
    string[] public candidates;
    
    // 投票结果
    mapping(string => uint) public votes;

    // 添加候选人
    function addCandidate(string memory _candidate) public {
        candidates.push(_candidate);
    }

    // 为候选人投票
    function vote(string memory _candidate) public {
        votes[_candidate] += 1;
    }

    // 获取获胜候选人
    function getWinner() public view returns (string memory) {
        string memory winner;
        uint maxVotes = 0;

        for (uint i = 0; i < candidates.length; i++) {
            if (votes[candidates[i]] > maxVotes) {
                winner = candidates[i];
                maxVotes = votes[candidates[i]];
            }
        }

        return winner;
    }
}

与合约交互

在撰写了智能合约代码后，我们可以使用 Web3.js 与合约交互：

// 创建合约实例
const contract = new web3.eth.Contract(abi, contractAddress);

// 添加候选人
contract.methods.addCandidate("候选人 A").send();
contract.methods.addCandidate("候选人 B").send();

// 为候选人投票
contract.methods.vote("候选人 A").send();
contract.methods.vote("候选人 B").send();

// 获取获胜候选人
contract.methods.getWinner().call().then((result) => {
  console.log(`获胜候选人：${result}`);
});