在Web3的浪潮中，以太坊作为最著名的区块链平台，其智能合约是构建去中心化应用（DApps）的核心，而与这些智能合约进行交互，尤其是读取和修改其存储的数据，是开发者日常工作的关键一环，在Solidity编程语言中，public关键字扮演着至关重要的角色，它简化了合约变量的访问方式，本文将深入探讨Web3环境下如何访问以太坊智能合约中标记为public类型的变量,并解释其背后的原理。

什么是Solidity中的public类型

在Solidity中，当你声明一个状态变量（存储在区块链上的变量）时，可以为其指定可见性修饰符，如public、private、internal或external。

当你为变量添加public修饰符时，Solidity编译器会自动为你生成一个免费的公共 getter 函数,这意味着：

  1. 无需手动编写函数：你不需要为了暴露变量的值而额外编写一个function来返回它。
  2. 简化访问：其他合约或外部应用程序（如通过Web3库）可以直接通过变量名来读取该变量的值。

以下是一个简单的合约：

pragma solidity ^0.8.0;
contract SimpleStorage {
    uint256 public storedData; // 被标记为 public
    function set(uint256 x) public {
        storedData = x;
    }
    // 编译器会自动为 storedData 生成一个 getter 函数
    // 相当于存在一个 function storedData() public view returns (uint256) { return storedData; }
}

在这个例子中，storedData被标记为public，因此任何人都可以调用storedData()这个自动生成的函数来获取其值。

Web3库如何访问Public变量

在Web3应用中，我们通常使用JavaScript库（如web3.js或ethers.js）与以太坊节点进行通信，进而读取智能合约的状态，访问public变量主要通过以下步骤实现：

连接到以太坊网络

你需要一个与以太坊网络连接的提供者（Provider），这可以是一个本地节点（如Ganache）、一个远程节点服务（如Infura、Alchemy）或一个浏览器钱包（如MetaMask）提供的注入对象。

以ethers.js为例：

const { ethers } = require("ethers");
// 假设我们使用 Infura 作为节点提供商
const provider = new ethers.providers.JsonRpcProvider("https://mainnet.infura.io/v3/YOUR_PROJECT_ID");
// 或者使用 MetaMask 提供者（在浏览器环境中）
// const provider = new ethers.providers.Web3Provider(window.ethereum);

获取合约实例

要访问合约的public变量，你需要合约的地址和ABI（Application Binary Interface）。

  • 合约地址：部署在以太坊网络上的合约的唯一标识符。
  • ABI：描述合约接口的JSON数组，包含了所有函数的签名、参数类型、返回值类型等，对于public变量,ABI中会包含其自动生成的getter函数的信息。
// 合约地址（示例，需替换为实际地址）
const contractAddress = "0x1234567890123456789012345678901234567890";
// 合约 ABI（仅包含必要部分，实际中会更长）
// 注意：对于 public 变量，ABI 中会有对应的 getter 函数描述
const contractABI = [
    "function storedData() view returns (uint256)"
];
// 创建合约实例
const contract = new ethers.Contract(contractAddress, contractABI, provider);

读取Public变量的值（调用自动生成的Getter函数）

一旦有了合约实例，访问public变量就像调用一个view或pure函数一样简单。ethers.js会根据ABI中的信息,知道如何构造对自动生成的getter函数的调用。

async function getStoredData() {
    try {
        // 调用自动生成的 storedData() getter 函数
        const data = await contract.storedData();
        console.log("Stored Data is:", data.toString());
    } catch (error) {
        console.error("Error fetching data:", error);
    }
}
getStoredData();

在这个例子中，contract.storedData()实际上是在调用编译器为public变量storedData自动生成的getter函数，由于这个函数是view类型，它不会修改区块链状态，因此只需要一个provider（读取节点）即可。

public vs public的Getter函数：本质与区别

理解public变量与其自动生成的getter函数之间的关系至关重要：

  • 变量本身：存储在合约的存储槽（Storage Slot）中,是一个具体的数据位置。
  • Getter函数：是一个公开的函数接口，允许外部世界访问该变量的值，对于值类型（如uint256, address），getter函数直接返回变量的值，对于数组或映射等复杂类型,getter函数可能需要参数来定位特定元素。

当你在Web3代码中“访问public变量”时，你实际上是在“调用该public变量对应的getter函数”。

注意事项与最佳实践

  1. ABI的重要性：确保你使用的ABI是准确且包含public变量对应getter函数的描述,错误的ABI会导致无法正确调用函数或解析返回值。
  2. Gas成本：读取public变量（调用view/pure函数）通常不需要支付Gas费（除了可能的节点费用）,因为不涉及状态写入。
  3. 数据类型：注意Solidity数据类型与JavaScript/TypeScript数据类型之间的转换，Solidity的uint256在JavaScript中通常表示为BigNumber（在随机配图