使用NPM安装Web3.js,Web3开发入门指南

安装Node.js

• 下载安装包：访问Node.js官网，根据操作系统选择LTS（长期支持）版本（推荐稳定版）。
• 安装过程：Windows用户可双击.msi文件按提示安装；macOS用户可通过Homebrew安装（brew install node）；Linux用户（如Ubuntu）可执行：

  curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
  sudo apt-get install -y nodejs

• 验证安装：打开终端/命令行工具，输入以下命令检查版本：

  node -v  # 显示Node.js版本（如v18.17.0）
  npm -v   # 显示NPM版本（如9.6.7）

  若返回版本号,说明安装成功。

项目初始化（可选）

若为全新项目,建议先初始化NPM项目（创建package.json文件）：

mkdir my-web3-project
cd my-web3-project
npm init -y  # 生成默认package.json

通过NPM安装Web3.js

Web3.js提供了两个主要版本：Web3.js v1.x（稳定版，广泛使用）和Web3.js v4.x（新版，优化API但仍在迭代中），推荐新手使用v1.x，本文以v1.10.0为例说明安装步骤。

安装Web3.js

在项目根目录下执行以下命令：

npm install web3@1.10.0

• 说明：@1.10.0为版本号，可省略（默认安装最新版），但指定版本可避免因版本更新导致的API变更问题。
• 安装后验证：安装完成后，项目目录下会新增node_modules文件夹（包含Web3.js依赖）和package-lock.json（锁定依赖版本）。

安装特定模块（可选）

Web3.js支持模块化引入（若项目支持ES6），可按需安装：

# 安装仅核心模块（体积更小）
npm install web3@1.10.0 --save-exact

Web3.js基础用法：连接区块链与调用智能合约

安装完成后,即可在代码中引入Web3.js并实现与区块链的交互，以下以连接以太坊测试网（如Ropsten）和调用简单智能合约为例。

引入Web3.js

• CommonJS方式（适用于Node.js或传统项目）：

  const Web3 = require('web3');

• ES6模块方式（需确保package.json中"type": "module"）：

  import Web3 from 'web3';

连接以太坊节点

Web3.js需通过HTTP/WS节点或浏览器钱包（如MetaMask）连接区块链，以下是两种常见方式：

方式1：连接远程HTTP节点（推荐新手）

使用Infura、Alchemy等节点服务商提供的免费节点（需注册获取项目ID）：

const web3 = new Web3('https://ropsten.infura.io/v3/YOUR_PROJECT_ID'); // 替换为你的Infura项目ID

方式2：连接本地节点（如Geth）

若本地运行以太坊节点（如Geth），地址通常为http://localhost:8545：

const web3 = new Web3('http://localhost:8545');

方式3：通过MetaMask连接（浏览器环境）

在DApp中,可通过window.ethereum（MetaMask注入的对象）连接：

let web3;
if (typeof window.ethereum !== 'undefined') {
  // 使用MetaMask提供的节点
  web3 = new Web3(window.ethereum);
  // 请求用户授权账户
  try {
    await window.ethereum.request({ method: 'eth_requestAccounts' });
  } catch (error) {
    console.error('用户拒绝授权:', error);
  }
} else {
  console.error('请安装MetaMask!');
}

获取账户信息

连接节点后,可查询账户余额、地址等：

// 获取账户列表（需节点支持）
web3.eth.getAccounts().then(accounts => {
  console.log('账户列表:', accounts);
  const account = accounts[0]; // 使用第一个账户
  console.log('当前账户:', account);
  // 查询账户余额（单位：wei）
  web3.eth.getBalance(account).then(balance => {
    console.log('账户余额 (wei):', balance);
    console.log('账户余额 (ETH):', web3.utils.fromWei(balance, 'ether'));
  });
});

调用智能合约

需先获取合约的ABI（应用二进制接口）和地址，然后创建合约实例。

步骤1：准备合约ABI和地址

假设有一个简单智能合约（如存储数字的SimpleStorage），其ABI（编译后生成）和部署地址如下：

const contractABI = [
  {
    "inputs": [],
    "name": "get",
    "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [{"internalType": "uint256", "name": "x", "type": "uint256"}],
    "name": "set",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  }
];
const contractAddress = '0x123...'; // 替换为你的合约部署地址

步骤2：创建合约实例并调用

const contract = new web3.eth.Contract(contractABI, contractAddress);
// 调用view函数（无需gas）
contract.methods.get().call().then(result => {
  console.log('当前存储的值:', result);
});
// 调用写函数（需要签名交易）
const account = '0x...'; // 替换为你的账户地址
contract.methods.set(42).send({ from: account }).then(receipt => {
  console.log('交易回执:', receipt);
});

常见问题与解决方案

安装时提示“permission denied”

原因：Linux/macOS下NPM全局安装权限不足。 解决：使用sudo或配置NPM全局目录（推荐后者）：

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

运行代码报错“Invalid provider”

原因：Web3实例化时传入的节点地址无效（如URL错误、节点未启动）。 解决：检查节点地址是否正确，确保远程节点可访问（如Infura项目ID有效）。

调用合约方法报错“invalid address”

原因：合约地址格式错误（需以0x开头，42位十六进制字符）。 解决：检查合约地址是否正确，可通过区块链浏览器（如Etherscan）验证。

交易一直“pending”

原因：节点拥堵、gas价格过低或账户余额不足。 解决：提高gas价格（通过web3.eth.getGasPrice()获取建议价格），或等待网络拥堵缓解。

通过NPM安装Web3.js是开启Web3开发的第一步，本文从环境准备、安装步骤到基础用法（连接节点、查询账户、调用合约）进行了详细说明，并提供了常见问题的解决方案，Web3.js功能强大，支持节点管理、交易签名、事件监听等高级特性，建议结合官方文档（Web3.js Docs）深入学习，希望本文能帮助你快速上手Web3开发，构建属于自己的去中心化应用！