← COMP5565 全部讲次
L04a-4 · 第 4 周

L04a-4 开发工具链:三个环境、七类工具和一条 JSON-RPC

写 DApp 要同时开三摊,三摊之间只说 JSON-RPC 一种话;七类工具按写、跑、连、用四段归;最后读懂一段连 MetaMask 的代码。

一句话版

写 DApp 要同时开三摊:写合约的开发环境、给用户用的前端环境、真正跑代码的以太坊网络。三摊之间只说一种话,叫 JSON-RPC。工具有七类,按“写、跑、连、用”四段记最省力。

前三页讲了 DApp 由哪些部件组成,这一页讲用什么工具把它们做出来。

先认识这几个词

词 全称 / 读法 一句人话
IDE Integrated Development Environment,集成开发环境 写代码的编辑器,带语法高亮和报错
开发框架 development framework 帮你编译、测试、部署合约的一整套工具,比如 Hardhat
节点客户端 client,如 Geth 让你的电脑加入以太坊网络的软件
RPC Remote Procedure Call,远程过程调用 让另一台机器替你执行一个函数,再把结果发回来
JSON-RPC 读 “jay-son R-P-C” 用 JSON 格式写请求和回信的 RPC
Web3 库 如 web3.js、ethers.js 把 JSON-RPC 包装成好用的函数,让程序能读写链
钱包 wallet,如 MetaMask 保管私钥、替你签名交易的软件

一个类比:装修一套房子

开发环境像设计院,图纸在这里画好、审好。以太坊网络像施工现场,图纸最终要在这里变成实物。前端环境像售楼处,住户在这里看房、签字。

三处之间靠同一种工作单沟通,格式统一,谁发出来对方都看得懂。这张工作单就是 JSON-RPC。

施工现场可以自己搭,也可以租一个现成的。自己跑 Geth 节点是自己搭,用 Alchemy、Infura 是租,租的省事,但多了一个要信任的房东。

类比在哪里失效:

  • 房子盖好还能返工。合约一上主网,代码就改不了,所以前面两处要把错都犯完。
  • 售楼处和施工现场之间通常隔着开发商。DApp 的前端可以直接连节点,不需要谁转手。

从零讲起

1. 三个环境和 JSON-RPC

它解决什么问题

写 DApp 会碰到一大堆工具名:Remix、Hardhat、MetaMask、ethers.js、Geth、Infura。一个个记很容易乱。先把它们放进三个环境,再看环境之间怎么连,就有了一张地图。

从哪来(补充)

JSON-RPC 是用 JSON 编码请求和回复的远程过程调用协议。1.0 版在 2005 年发布,2.0 版的提案在 2009 年提出,2010 年修订定稿。

它刻意做得很小:只规定请求和回信长什么样,连身份验证都不管。以太坊节点对外的接口用的就是它。

出处:Wikipedia: JSON-RPC

直觉

开发环境:用 Remix 或 VS Code 加 Hardhat 写 Solidity 合约,还可以直接复用 OpenZeppelin 的合约库。

前端环境:浏览器(Brave,或 Chrome 装 MetaMask),网页里用 web3.js 或 ethers.js。

以太坊网络:一堆“执行层客户端加共识层客户端”的节点,比如 Geth 配 Lighthouse。不想自己跑,就用 Alchemy 或 Infura 的托管节点。

一步一步看

目标:把一堆工具名放进开发、前端、网络三个框,看出三个框之间的连线都走同一种 JSON-RPC 请求。

  1. 先画三个框:开发环境、前端环境、以太坊网络。

    三个环境示意图:开发环境里是 Remix、VS Code 加 Hardhat、OpenZeppelin 合约库和 Ganache 本地链;前端环境里是浏览器加 MetaMask、web3.js 和 ethers.js;以太坊网络由执行层加共识层客户端成对组成,例如 Geth 加 Lighthouse,也可用 Alchemy、Infura 托管节点;开发环境和前端环境都通过 JSON-RPC 连到网络

  2. 开发环境连网络:把写好的合约部署上链。

  3. 浏览器钱包连网络:用户签名、发交易。

  4. Web3 库连网络:DApp 读链上数据、调用合约。

  5. 三条线标的都是 JSON-RPC。每一次请求都是一封“请帮我做哪件事”的信,加一封回信。

    JSON-RPC 请求与响应示意图:左边是发请求的前端或工具,右边是干活的钱包或节点;上方请求写着 jsonrpc 2.0、id 1 和青绿色强调的 method eth_requestAccounts;下方响应带着同一个 id 和 result 账户地址列表

  6. 信里的 method 写要做的事,id 让回信对上号。部署、签名、查询,全走这一种格式。

怎么判断

看到一个工具,先问它住在哪个环境:写合约用的,归开发环境;装在用户浏览器里或网页代码里的,归前端环境;本身就是节点或托管节点的,归以太坊网络。

再问它和链之间走什么。答案几乎总是 JSON-RPC,区别只在谁发请求、连的是自己的节点还是别人的节点。

常见误解

前端直接读区块文件来拿链上数据

前端不碰区块文件。它通过 JSON-RPC 向一个节点发请求,节点查好再回信。

用了 Infura 就和自己跑节点一样去中心化

Infura、Alchemy 是一家公司的托管节点。它们宕机或拒绝服务,连着它们的 DApp 就读不了链。这是当前以太坊生态里被批评最多的中心化点之一。

试一下

一个网页调用 ethers.js 查询某个账户的余额。这个请求从哪个环境发出、到哪个环境、走什么协议?

从前端环境发出,到以太坊网络的某个节点,走 JSON-RPC。ethers.js 只是把这封 JSON-RPC 请求包成了一个好调用的函数。

2. 七类工具

它解决什么问题

课件用一张七行的表列出所有工具类别。考试常出连线题和归类题。按名字死记容易混,按层次记就清楚了。

直觉

七类可以归成四段:写代码、跑代码、连上链、用起来。IDE 和开发框架是写;测试链是跑;客户端和 Web3 库是连;Web3 浏览器和钱包是用。

一步一步看

目标:把七类工具按写代码、跑代码、连上链、用起来四段归位,看出哪些名字横跨两类,IDE 和框架怎么分工。

  1. 先看完整的七类表。

    类别 作用 例子
    IDE 便于编写合约 Remix、VS Code
    开发框架 开发、发布、测试合约,补充 IDE Truffle、Hardhat
    区块链与共识客户端 连主网或测试网及共识层,也可以是在线服务商 Geth + Lighthouse、Nimbus、Prysm;Alchemy、Infura
    测试链 生成虚拟链和一批假账户 Ganache、Geth
    Web3 库 给 JSON-RPC 提供抽象层 Web3.js、Ethers.js、Web3j、Alchemy、Infura
    Web3 浏览器 内置钱包和 DeFi 功能 Brave、Mist
    钱包 管币、签交易 MetaMask、Coinbase Wallet
  2. 再把七类按四段归。

    四段归类图:写代码段放 IDE 和开发框架,跑代码段放测试链,连上链段放区块链与共识客户端和青绿色强调的 Web3 库,用起来段放 Web3 浏览器和钱包;下方说明 Alchemy、Infura 同时出现在客户端和 Web3 库两类,Truffle、Ganache、Mist 已停止维护

  3. 留意重复出现的名字。Alchemy、Infura 既在客户端一类,也在 Web3 库一类:它们既托管节点,又提供自己的 SDK。

  4. 留意 IDE 和开发框架的分工。IDE 管“写”,有编辑器和语法高亮;框架管围绕写的一切:编译、测试、部署脚本、本地链、调试器。

  5. Remix 特殊,它把两者打包进一个网页,打开就能写、编译、部署。左侧图标栏里的 Solidity Compiler 选编译器版本,Deploy & Run Transactions 选部署环境。

怎么判断

碰到一个工具名,问它在开发流程里管哪一步。管编辑的是 IDE;管编译测试部署的是框架;造一条假链给你练手的是测试链;让程序和链说话的是 Web3 库;让人和链打交道的是浏览器和钱包。

常见误解

Remix 只是一个编辑器,算 IDE 就完了

Remix 还能编译、部署、在本地模拟执行,相当于 IDE 和框架装在一个网页里。入门只用 Remix 就够;项目变大,要版本控制和自动化测试时,再转到 VS Code 加 Hardhat。

表里列的工具今天都还能用

Truffle 和 Ganache 已经停止维护,Mist 也早就停了。答题按课件表答,动手时换 Hardhat 一类工具。

试一下

把这几个名字归到四段里:Hardhat、MetaMask、Ganache、ethers.js、Brave。

Hardhat 是开发框架,归“写”。Ganache 是测试链,归“跑”。ethers.js 是 Web3 库,归“连”。MetaMask 是钱包、Brave 是 Web3 浏览器,都归“用”。

3. 网页连钱包

它解决什么问题

前端要让用户签交易,就得先连上用户的钱包。网页本身拿不到私钥,只能请钱包帮忙。课件给了一段能直接用的代码,读懂它就知道前端和钱包之间怎么打交道。

从哪来(补充)

钱包注入网页的这个对象,接口规范是 EIP-1193 “Ethereum Provider JavaScript API”,创建于 2018 年,现在是 Final 状态。

它规定了一个 request() 方法:传入 method 和参数,返回一个 Promise。window.ethereum 这个挂载位置只是历史惯例,规范正文里并没有写死。

出处:EIP-1193

直觉

课件先讲了一句历史:Web 1.0 到 Web 2.0 的变化关于交互性和标准 API;给网页加上和区块链的交互,就是 Web 3.0。

钱包扩展会往网页里塞一个对象 window.ethereum,这是网页和钱包之间唯一的桥。网页通过它发 JSON-RPC 请求,钱包弹窗问用户同不同意。

一步一步看

目标:顺着课件代码走一遍网页连 MetaMask 的四步,看清没装钱包、用户同意、用户拒绝时各得到什么。

  1. 读 window.ethereum。没装钱包时它是 undefined,所以要先判断有没有。

  2. 有的话,再看 isMetaMask,区分是不是 MetaMask,其他钱包也会注入这个对象。

  3. 调 request,method 写 eth_requestAccounts。MetaMask 弹出授权窗口。

  4. 用户点同意,拿到账户地址;用户点拒绝,这个调用会抛错。

    网页连钱包流程图:第一步读 window.ethereum,第二步判断有没有以及是不是 MetaMask,没有就提示用户装钱包;第三步 request 发 eth_requestAccounts,MetaMask 弹出授权窗;用户同意拿到账户地址,用户拒绝则抛错,青绿色框标出要用 try catch 接住,当正常流程处理

  5. 对照课件代码看一遍:

    const { ethereum } = window;
    if (ethereum && ethereum.isMetaMask) {
      try {
        await ethereum.request({ method: 'eth_requestAccounts' });
      } catch (error) {
        console.error(error);
      }
    }

怎么判断

检查一段连钱包的代码写得对不对,看四处:有没有先判断 window.ethereum 存在;有没有区分钱包;请求的 method 对不对;有没有用 try/catch 接住用户拒绝。四处少一处都算有缺陷。

常见误解

用户点了拒绝是异常情况,不用专门处理

拒绝授权是正常操作。没有 try/catch,用户点一下拒绝,页面就报错卡住。这是新手最常漏的一处。

只要判断了 window.ethereum,装几个钱包都没问题

用户装了多个钱包扩展时,它们会争抢 window.ethereum。后来的 EIP-6963 定义了多钱包发现机制来解决这个冲突,课件这段代码属于“能用但偏老”的写法。

试一下

把课件代码里的 try/catch 删掉,用户在弹窗里点拒绝,会发生什么?

ethereum.request 返回的 Promise 被拒绝,抛出的错误没人接住,控制台报未处理的错误,后面的代码也不再执行,页面就卡在那里。

把它们串起来

三个概念从粗到细。第一个给出地图:三个环境,靠 JSON-RPC 连成一条线。第二个把七类工具填进地图,按写、跑、连、用四段归。第三个放大其中一条线:网页通过钱包注入的对象发 JSON-RPC 请求,钱包代用户签名。

eth_requestAccounts 本身就是一个 JSON-RPC 方法名。所以网页连钱包,归根到底也是在发那封“请帮我做哪件事”的信。

跑代码那一段的测试链、测试网和主网有什么区别,下一页讲。

课件里的坑

  • p.21 的表按 2026 年的现状有三处过时:Truffle 已停止维护(Consensys 于 2023-09 宣布 sunset),Ganache 随它一起退役,Mist 也已停止开发。答题按课件表答,动手时换 Hardhat Network 或 Foundry 的 Anvil。
  • p.27 最后一行写着 “Both integrate with Visual Studio and other IDEs”,上面却只列了 Hardhat 一个框架,“Both” 悬空了。原因是删掉了 Truffle 那一行。问框架有哪些,按 p.21 答 Truffle 和 Hardhat。
  • p.20 图里每个节点都写 “Ethereum + consensus client”。Merge 之后执行层客户端(Geth)和共识层客户端(Lighthouse)必须成对运行。
  • p.29 的代码能用但偏老。window.ethereum 的接口规范是 EIP-1193,多钱包冲突由 EIP-6963 解决。

课后 10 分钟

这 10 分钟怎么用:合上页面,画出三个环境和三条 JSON-RPC 线,再默写七类工具并按四段归类,最后对着代码说出四个要点。

必背

  1. 开发工具链分三个环境:开发环境(Remix / VS Code + Hardhat 写 Solidity,OpenZeppelin 合约库)、前端环境(Brave 或 Chrome + MetaMask,web3.js / ethers.js)、以太坊网络(Geth + Lighthouse 这类执行层加共识层客户端,或 Alchemy / Infura 托管节点)
  2. 三个环境之间统一走 JSON-RPC:部署合约、钱包发交易、DApp 读写链都走同一个接口,区别只在谁发请求、连的是谁的节点
  3. 七类工具:IDE(Remix、VS Code)、开发框架(Truffle、Hardhat)、区块链与共识客户端(Geth + Lighthouse、Nimbus、Prysm;Alchemy、Infura)、测试链(Ganache、Geth)、Web3 库(Web3.js、Ethers.js、Web3j)、Web3 浏览器(Brave、Mist)、钱包(MetaMask、Coinbase Wallet)
  4. 七类工具按写代码、跑代码、连上链、用起来四段归;Alchemy 和 Infura 同时出现在客户端和 Web3 库两类,因为它们既托管节点又提供 SDK
  5. IDE 管写,开发框架管编译、测试、部署、调试;Remix 把两者打包进网页所以零安装;Truffle、Ganache、Mist 已停止维护
  6. 网页连钱包四要点:window.ethereum 是钱包注入的桥(规范是 EIP-1193),isMetaMask 区分钱包,eth_requestAccounts 是 JSON-RPC 方法,必须 try/catch 处理用户拒绝

课件例题

本讲课件没有例题落在这一页的主题上,p.19–p.29 是工具介绍和一段示例代码。

完整例题

题面(按课件 p.20、p.21 的考法自编):一个学生用 Remix 写好合约,通过 MetaMask 部署到 Sepolia,再写了一个网页用 ethers.js 读合约里的数据,网页连的是 Infura 的节点。(a) 这里出现的每个工具各属于七类里的哪一类、三个环境里的哪一个?(b) 一共有几条 JSON-RPC 连接,分别连接谁和谁?

  1. Remix:IDE(也带框架功能),属于开发环境。
  2. MetaMask:钱包,属于前端环境。这里它替 Remix 签名部署交易。
  3. ethers.js:Web3 库,属于前端环境。
  4. Infura:托管节点服务,七类表里既算区块链客户端也算 Web3 库,它本身属于以太坊网络这一摊。
  5. Sepolia:测试网,是以太坊网络的一种,不在七类工具表里。
  6. (b) 第一条:Remix 通过 MetaMask 把部署交易发到网络,对应“开发环境 ↔ 网络”和“钱包 ↔ 网络”。
  7. 第二条:网页里的 ethers.js 向 Infura 节点发查询,对应“Web3 库 ↔ 网络”。
  8. 三条线全是 JSON-RPC,区别只在谁发请求。

要点:分清“工具类别”和“所在环境”两个维度;Sepolia 是网络不是工具。

变式题(先自己做)

自编情境:(1) 一个团队决定不用 Infura,自己跑 Geth 加 Lighthouse 节点给前端用。这改变了七类表里的哪一类选择?带来什么好处和代价?(2) 一个网页没有判断 window.ethereum 是否存在,就直接调 ethereum.request。在没装钱包的浏览器里会怎样?

提示

第一问回到“区块链与共识客户端”那一行,想想自己跑节点要付什么。第二问想想没装钱包时这个对象是什么。

判分点与答案(非官方评分标准)

判分点:① 第一问点出“区块链与共识客户端”一类;② 好处写“少一个信任方”,代价写“存储和同步成本”;③ 第二问写出 window.ethereum 为 undefined、调用报错。

(1) 改变的是“区块链与共识客户端”这一类:从在线服务商换成自建节点。好处是不再依赖一家公司,少一个信任方。代价是全节点要上 TB 级磁盘,同步要数小时到数天,还得自己运维。

(2) 没装钱包时 window.ethereum 是 undefined,对它调用 request 会直接抛出类型错误,页面脚本中断。应该先判断对象存在,不存在就提示用户安装钱包。

闪卡自测

1. 三个环境之间用什么协议通信?

JSON-RPC。p.20 图上连接开发环境、前端环境和以太坊网络的三条箭头全部标着它。

2. Alchemy 和 Infura 为什么在工具表里出现了两次?

它们既算区块链客户端,也算 Web3 库:既托管节点,又提供自己的 SDK(p.21)。

3. 七类工具按四段怎么归?

写:IDE、开发框架。跑:测试链。连:区块链与共识客户端、Web3 库。用:Web3 浏览器、钱包(p.21)。

4. IDE 和开发框架怎么分工?

IDE 管写;框架管编译、链接、部署、二进制管理和断点调试(p.27)。

5. p.27 那个悬空的 "Both" 是怎么来的?

这一页原来列着 Truffle 和 Hardhat 两个框架,Truffle 那一行被删了,“Both” 没跟着改。

6. 用户在 MetaMask 弹窗里点了拒绝,前端会怎样?

ethereum.request 会抛错。前端必须用 try/catch 接住,把拒绝当正常流程处理(p.29)。

下一讲

主网、测试网和本地链怎么选,Ganache 面板上的数字怎么读,见 L04a-5 网络与 Ganache:在哪条链上试。

下一讲 →
L04a-5 L04a-5 网络与 Ganache:同一份合约先在哪条链上试

个人整理的学习笔记,不是官方材料;数字与结论以课件和讲师为准。