← COMP5565 全部讲次
Lab1a · 第 5 周

Lab1a 在 Remix 里跑通第一份合约:从 10 行 SimpleStorage 到有主人的 SimpleStorageV2

Task 1–3 分步走:编译部署、读写状态、去掉 view 看按钮变色、比较开关优化器的 gas,再一件件加上 constructor、owner、modifier、event、receive。附两份可直接复制的完整合约。

一句话版

Task 1–3 把 Solidity 从「课上听过」推到「手上跑过」。先在浏览器里的 Remix 编译一份 10 行的合约,部署到模拟链,读写一次状态。再一件一件往上加 constructor、owner、require、modifier、event、receive。玩具合约就这样变成一份有主人、会发事件、能收钱的合约。Task 4–6(测试网、只拿 ABI 调合约、水龙头编程题)在 Lab1b。

先认识这几个词

读之前最好先懂智能合约和 gas 是什么,见 L01b-3 和 L02a-4。

词 全称 / 读法 一句人话
Solidity 读「索力迪提」 写以太坊智能合约最常用的编程语言
Remix Remix IDE 浏览器里就能写、编译、部署合约的在线工具
gas 燃料费 在以太坊上执行操作要付的手续费,按操作量计
EVM Ethereum Virtual Machine,以太坊虚拟机 链上真正执行合约代码的那台「虚拟电脑」
ABI Application Binary Interface,应用二进制接口 合约的「说明书」:有哪些函数、要什么参数、返回什么
Bytecode 字节码 编译后交给 EVM 执行的机器码,部署时上链的就是它
view 只读函数标记 声明这个函数只读数据、不改状态
revert 回滚 交易执行失败,所有改动撤销,像没发生过一样

题目地图

Task 在考什么 主要失分点
1 编译并部署 SimpleStorage 函数数量、默认值、view 与 gas 漏数自动 getter;把 execution cost 当答案
2 ABI 与 Bytecode 编译产物各自是什么、去了哪;优化器省在哪 以为 ABI 也上链
3 Solidity 基本件 constructor、权限、事件、收款 modifier 的 _; 摆错;Value 忘了清零

课件的代码是从 Word 里截出来的,缩进和换行都乱了。Task 3 更是只给零散片段,从头到尾没给过改完的样子。下面两份合约都整理成了能直接粘进 Remix 编译通过的完整版。

概念卡

1. 自动 getter(public state variable)

人话定义:它省掉了「为每个变量手写一个读取函数」的麻烦。状态变量(合约长期保存的数据)标了 public,编译器就替它写一个同名的只读函数,这个函数叫 getter。

例子:uint256 public storedData; 让 ABI 里多出一个 storedData(),Remix 也给它画一个蓝按钮。源码里手写了 set 和 get 两个函数,对外可调用的却是三个。

常见误解

以为 get 和 storedData 有区别 → 结果完全一样,前者手写、后者编译器送的,这份合约里 get 其实可以删。手写 getter 通常是为了返回加工过的值,或者状态变量本身想设成 private(私有,外部不可直接读)。

回讲义:L04b-4 函数:五段声明、可见性与 view / pure / payable

2. Call 与 Transact:蓝按钮和橙按钮

人话定义:它区分「只看一眼」和「真改数据」两种调用。蓝色走 eth_call,在节点上模拟一次就返回结果;橙色真发一笔交易,要签名、上链、付 gas。

例子:get 带 view 是蓝的,点了直接在按钮下面显示数值。把 view 删掉重新部署,同一个按钮变橙。点一次花 23517 gas,返回值也不再显示,要去控制台展开交易看 decoded output(解码后的返回值)。

常见误解

以为 view 函数永远免费 → 只有从链下直接调用时免费。合约 A 的写函数里调了 B 的 view 函数,那部分执行照样计入这笔交易的 gas。

回讲义:L04b-4 函数:五段声明、可见性与 view / pure / payable

3. transaction cost 与 execution cost

人话定义:它回答「这笔交易到底花了多少 gas」。transaction cost 是整笔交易实际消耗的 gas,你付的钱按它算;execution cost 只算 EVM 执行代码那一段。

例子:transaction cost 里包含 21000 的基础费和 calldata 费(按交易附带的数据收费),部署时还有把字节码写上链的费用。SimpleStorage 未开优化部署的 transaction cost 是 132939 gas。

常见误解

两个数并排显示,抄了小的那个 → 题目问「消耗了多少 gas」,答 transaction cost。

回讲义:L02a-4 Gas 与 EIP-1559:一笔交易的手续费怎么算、钱去了哪

4. ABI 与 Bytecode

人话定义:它们解决「代码怎么上链」和「别人怎么调用」两件事。Bytecode 是上链的机器码,ABI 是留给调用方的说明书。

例子:ABI 是一个 JSON 数组(一种通用的数据格式)。每项写着 type、name、inputs、outputs、stateMutability,完全不含函数体。钱包能给 set 画出一个输入框,靠的就是 ABI 里写着它要一个名叫 x 的 uint256。

常见误解

以为部署时 ABI 跟着上了链 → 链上只有 Bytecode。没公开源码、别人手里也没有 ABI 的合约就很难调用,Lab1b 的 Task 5 演示的正是这件事。

回讲义:L03a 智能合约:一台装在每个节点上的自动售货机

5. modifier 与 _;

人话定义:它解决「好几个函数都要做同一道检查」的重复问题。modifier 把这道检查抽成一段可复用的前置代码,_; 标出原函数体插进来的位置。

例子:onlyOwner 里先 require(条件不满足就报错回滚)再 _;,就是先查身份再执行。挂到 set 上和直接在 set 里写 require 效果完全相同。好处是十个函数要同样检查时只写一次。

常见误解

把 _; 写在 require 前面 → 函数体先跑完、状态先改了才检查。检查失败时整笔交易仍会回滚,但读代码的人很难看出这是一道前置门槛。按惯例,检查一律写在 _; 之前。

回讲义:L04c-1 合约的一头一尾:构造器、selfdestruct 与修饰器

逐题拆解

Task 1:把第一份合约推上链。 操作步骤:

  1. 打开 app.remix.live → 左侧 File Explorer → Create 下拉 → New workspace → 模板选 Blank,起个名字 → OK。别选默认模板,它会塞进一堆示例合约,后面容易点错文件。
  2. 新建 first.sol,粘贴下面这份整理好的合约。
  3. 左栏 Solidity compiler → 点 Compile first.sol(或 Command-S)。
  4. 左栏 Deploy & run transactions → Environment 保持 Remix VM → Account 用第一个 → 点橙色 Deploy。
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

contract SimpleStorage {
    uint256 public storedData;

    function set(uint256 x) public {
        storedData = x;
    }

    function get() public view returns (uint256) {
        return storedData;
    }
}

pragma 那一行声明这份代码要用哪个版本的编译器。^0.8.0 允许大于等于 0.8.0、小于 0.9.0 的编译器,当前 Remix 默认的 0.8.34 落在区间里。Remix VM 是跑在浏览器里的模拟链,自带一批每个 100 ETH 的账户,不碰真实网络。

Remix 的 Deploy & run transactions 面板:Environment 选 Remix VM、右侧硬分叉显示 Osaka,Account 1 地址 0x5B3…eddC4 余额 100.000 ETH,下方 Deploy 区显示 faucet.sol 的 Faucet 已 Compiled,Value 为 0 wei、Gas limit 为 auto,最下方是蓝色 Deploy 按钮
图片来源:Lab 1 题解在 Remix 2.6.4 上的实测截图(部署面板布局与 Task 1 相同,图中已编译的是 Task 6 的合约)

部署后底部控制台出现一行绿勾。点行尾箭头展开,能看到区块号、交易哈希、合约地址和两个 gas 数字。合约卡片出现在 Deployed contracts 下面,橙色的 set 带输入框,蓝色的是 get 和 storedData。

课件里的 Deployed Contracts 面板:SIMPLESTORAGE AT 0XD91…39138 展开后余额 0 ETH,橙色的 set 按钮带一个 uint256 输入框,下面两个蓝色按钮 get 和 storedData,最底部是 Low level interactions 的 CALLDATA 输入框与 Transact 按钮
图片来源:COMP5565 Lab 1 The Solidity Language, p.3

这一节七道 Question 的答案如下。

  • 合约在链上存一个无符号整数,对外三个函数,多出来的是自动 getter。
  • pragma 区间如上,部署的 gas 看 transaction cost,未开优化时实测 132939(见 Task 2 的对照表)。
  • 未初始化变量取类型零值:uint 是 0,bool 是 false,address 是全零地址;Solidity 没有 null(空值)。
  • 点 storedData 和点 get 结果相同;点 get 不花钱,因为它是 view。
  • 把 view 去掉后,编译器警告 Function state mutability can be restricted to view。重新部署后按钮变橙、真发交易,返回值要去 decoded output 看。

做完记得把 view 加回去,Task 2 一开头就要求这样做。

Task 2:看编译产物。 编译器面板底部有 ABI 和 Bytecode 两个复制按钮,分别粘进 first.abi 和 first.bin。打开 first.abi 能看到三项,编译器按函数名字母序输出 get、set、storedData。源码里没写的 storedData 出现在这里,就是自动 getter 的证据。

对照实验:编译器面板 Advanced Configuration → 勾 Enable optimization(runs 默认 200)→ 重新编译部署。优化器(optimizer)是编译时压缩代码的开关,runs 表示预计合约代码会被调用多少次。

操作 未开优化 开优化
部署 SimpleStorage 132939 93655
set(42) 首次写入 43718 43513

部署省了 39284 gas,约三成;set 只省 205。优化器压缩的是字节码长度,部署费里很大一块按字节码长度算。set 的大头是一次写存储,优化器动不了。runs 调小偏向部署便宜,调大偏向每次调用便宜。

Task 3:把玩具合约改成有主人的合约

在 SimpleStorage 上按顺序加六样东西,每加一样重新部署验证一次:

  1. constructor(构造函数):部署那一刻执行一次,写 storedData = 10;。部署后点 get 得到 10。
  2. Owner:加 address public Owner;,constructor 里写 Owner = msg.sender;(msg.sender 是发起这次调用的地址)。点 Owner 按钮显示 Account 1 的地址。
  3. require:set 开头加 require(msg.sender == Owner, "Not the owner");。Account 下拉切到 Account 2 调 set,控制台报 revert。
  4. modifier:把这句检查抽成 onlyOwner,set 里的 require 删掉、函数声明后面挂上 onlyOwner。
  5. event(事件):声明 event Set(string message);,set 末尾 emit Set("New value set");。展开那笔交易,在 logs 一栏能看到它。
  6. receive(收款函数):加 receive() external payable {}。顶部 Value 填金额、看清单位。到合约卡片最底部 Low level interactions,CALLDATA 留空,点 Transact,卡片上的 Balance 随之变化。转完立刻把 Value 改回 0。
课件里的控制台报错截图:红色 revert 标记,提示 The transaction has been reverted to the initial state,下一行写明 Reason provided by the contract 冒号后是引号包住的 Not the owner,最后一行建议 Debug the transaction to get more information
图片来源:COMP5565 Lab 1 The Solidity Language, p.6

最后那道 Question 问「只收 owner 的钱怎么写」,答案是把 modifier 直接挂到 receive 上。六样加齐之后的完整合约:

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

contract SimpleStorageV2 {
    uint256 public storedData;
    address public Owner;

    event Set(string message);

    modifier onlyOwner() {
        require(msg.sender == Owner, "Not the owner");
        _;
    }

    constructor() {
        storedData = 10;
        Owner = msg.sender;
    }

    function set(uint256 x) public onlyOwner {
        storedData = x;
        emit Set("New value set");
    }

    function get() public view returns (uint256) {
        return storedData;
    }

    // 只收 owner 的钱:直接复用 onlyOwner
    receive() external payable onlyOwner {}
}

合约名改成 SimpleStorageV2 只为和 Task 1 的版本区分,沿用原名也可以。事件写进交易收据,合约自己读不到,是给链下的前端和索引服务看的。它的存储成本也比写状态变量低得多。

一步一步看

目标:看非主人改值、主人改值、主人转账、带着钱调用各会怎样,分清 onlyOwner、receive 和 payable 各管哪一关。

拿 SimpleStorageV2 连做五次调用,盯住三个状态:storedData、Owner、合约余额。每步只有一格在变。

  1. Account 1 部署。constructor 只跑这一次,storedData 写成 10,Owner 记下部署者 Account 1。

    第 1 步状态表:Account 1 部署后 storedData 为 10,Owner 是 Account 1,合约余额 0 ETH,storedData 一格被标出

  2. 切到 Account 2 调 set(7)。onlyOwner 里的 require 不通过,整笔回滚,storedData 仍是 10。

    第 2 步状态表:Account 2 调 set(7) 被 revert,报错 Not the owner,三个状态都没变,结果一格被标出

  3. 切回 Account 1 调 set(42)。检查通过,函数体执行,storedData 变成 42,logs 里多一条 Set 事件。

    第 3 步状态表:Account 1 调 set(42) 成功,storedData 从 10 变成 42,logs 里出现 Set 事件,storedData 一格被标出

  4. Account 1 把 Value 填 1 Ether,CALLDATA 留空,点 Transact。data 为空,进 receive;转账的正是 Owner,onlyOwner 放行。

    第 4 步状态表:Account 1 经 Low level interactions 转 1 Ether,进入 receive,合约余额从 0 变成 1 ETH,余额一格被标出

  5. Value 没改回 0 就调 set(5)。这笔调用带着 1 Ether,set 不是 payable,交易 revert,storedData 停在 42。

    第 5 步状态表:Value 仍是 1 Ether 时调 set(5) 被 revert,因为 set 不是 payable,storedData 停在 42,结果一格被标出

课件里的坑

  • [课件有误] p.2 那段「Failed to parse the current file as JSON ABI」的提示放错了位置。它只在打开 .abi 文件时出现,粘 .sol 代码不会触发,属于 Task 5,到 Lab1b 再用(p.2)。
  • [课件有误] p.2 说 Remix VM 的硬分叉是 Prague,当前界面显示 Osaka,是 Prague 之后的下一次升级,对这份 Lab 的所有操作没有影响(p.2)。
  • [课件留白] p.2 说选错编译器版本会弹提示,没附图;p.4 说要看 decoded output,那一页整页只有一句话,没有截图。decoded output 在控制台展开交易后的详情列表里(p.2、p.4)。
  • [课件留白] Task 3 只给零散片段,没给改完的完整合约,各段该放在哪、require 改成 modifier 后要不要删都靠自己拼。上面的 SimpleStorageV2 就是拼好的版本(p.5–7)。
  • [术语区别] msg.sender 是这一次调用的直接调用者。部署时是点 Deploy 的账户,所以 constructor 里记下的就是部署者;以后合约 A 调合约 B 时,B 看到的 msg.sender 是 A 的地址(p.6)。
  • [补充] p.7 截图里 Value 单位选的是 Ether,新版默认 wei。填之前看一眼下拉,差一档就是 10 的 18 次方倍(p.7)。
  • [补充] p.7 加粗那句「用完把 Value 改回 0」要当真。Value 是部署面板的全局设置,之后每次 Transact 都会带上这笔钱,带着非零 Value 调非 payable 的 set 会直接 revert,报错还看不出原因(p.7)。

课后 10 分钟:考点复习

这 10 分钟怎么用:合上页面,先默写 SimpleStorageV2 的骨架——状态变量、event、modifier、constructor、set、receive 各一行签名;再把下面的完整例题按顺序在 Remix 里点一遍,每一步先猜结果再点;最后回查两处最容易错的地方:transaction cost 和 execution cost 抄哪个、Value 用完有没有清零。

必背

  1. caret 版本号 ^0.8.0 的含义是大于等于 0.8.0 且小于 0.9.0,caret 锁住的是最左边那个非零的版本号
  2. 状态变量声明成 public 后编译器会自动生成一个同名 getter,它出现在 ABI 里,所以 SimpleStorage 对外有三个可调用函数
  3. view 函数从链下调用走 eth_call,不发交易也不花 gas;同一个函数在别的交易执行过程中被调用时照样计 gas
  4. 问一笔交易花了多少 gas 答 transaction cost,execution cost 只算 EVM 执行那一段,不含基础费和 calldata 费
  5. ABI 只描述接口、不含函数体,而且不上链;部署交易真正发上链的是 Bytecode
  6. modifier 里的 _; 是被修饰函数体执行的位置,检查要写在它前面;require 失败整笔回滚,已用掉的 gas 不退
  7. data 为空的转账优先走 receive,既没有 receive 也没有 payable fallback 的合约收不了 ETH,转账会 revert

完整例题

用 Account 1 部署上面的 SimpleStorageV2,然后依次做六步,写出每一步的结果。

步骤 操作 结果
1 Account 1 点 get 10,constructor 写进去的
2 Account 1 点 Owner Account 1 的地址
3 切到 Account 2,调 set(7) revert,Reason provided by the contract: "Not the owner";再点 get 仍是 10
4 切回 Account 1,调 set(42) 成功;展开交易,logs 里有 Set,参数是 New value set;get 变成 42
5 Account 2,Value 填 1 Ether,Low level interactions → Transact revert,同样报 Not the owner,1 ETH 退回 Account 2
6 Account 1,Value 填 1 Ether,Transact 成功,合约卡片 Balance 变成 1 ETH

逐步说明:

  1. 第 3 步失败后状态不变,这是 require 的回滚语义:整笔交易像没发生过,只有已消耗的 gas 被扣掉。
  2. 第 4 步看事件的位置是控制台那笔交易的 logs,合约卡片上不会显示。
  3. 第 5 步说明 receive 上的 onlyOwner 生效了:转账时 data 为空,EVM 进的是 receive,先跑 modifier 里的检查。
  4. 第 6 步做完把 Value 改回 0。忘了清零接着调 set,交易会因为给非 payable 函数带钱而 revert。

变式题

把 SimpleStorageV2 改两处:onlyOwner 写成 _; require(msg.sender == Owner, "Not the owner");,并且删掉整行 receive。(1) Account 2 调 set(7) 结果是什么,storedData 最后是多少?(2) Account 1 用 Value 1 Ether 加空 CALLDATA 转账,结果是什么?(3) 改完后 ABI 里少了哪一项?

提示

第 (1) 问想清楚 _; 在前时函数体和检查的先后,再想 revert 撤销的是哪些改动。第 (2) 问回到概念卡里「data 为空的转账找谁」那张表。第 (3) 问回忆 ABI 每一项的 type 字段有哪些取值。

参考答案与自检(非官方评分标准)

自检要点:① 说出函数体先执行、检查后失败、整笔回滚;② 说出没有 receive 也没有 payable fallback 时转账 revert;③ 指出少掉的是 type 为 receive 的那一项。

(1) set 的函数体先把 storedData 改成 7、发出 Set 事件,然后 require 失败。revert 撤销整笔交易的全部效果,所以 storedData 仍是 10,事件也不会留在收据里。结果和检查写在前面时一样,区别在于读代码的人很难一眼看出这是前置检查,而且失败前白跑了一遍函数体,gas 更多。

(2) revert,1 ETH 退回。合约既没有 receive 也没有 payable fallback,data 为空的转账无处可去。

(3) 少了 "type": "receive"、"stateMutability": "payable" 那一项。

闪卡自测

^0.8.0 允许 0.8.34 吗?允许 0.9.0 吗?允许 0.8.34,不允许 0.9.0。caret 锁住最左边的非零版本号,主版本号是 0 时锁的就是次版本号 8。
源码里只写了两个函数,ABI 里为什么有三项?public 状态变量 storedData 被编译器自动配了一个同名 getter,它和手写函数一样出现在 ABI 里。
从链下点 get 不花 gas,那合约 A 在交易里调 B 的 view 函数花不花?花。「view 免费」只对从链下直接调用成立,交易执行过程中的调用照样按 EVM 指令计费。
去掉 view 之后返回值去哪看?控制台展开那笔交易,找 decoded output 一栏。交易的返回值不会像 eth_call 那样直接送回来。
开优化后部署省了三成,set 却几乎没省,为什么?优化器压的是字节码长度,部署费里很大一块按字节码长度算;set 的成本大头是一次写存储,优化器动不了。
合约同时有 receive 和 payable fallback,data 为空的转账走哪个?data 为 0x1234 呢?空 data 走 receive;0x1234 匹配不上任何函数,走 fallback。
Value 留着 1 ETH 忘了清零,接着调 set(5) 会怎样?交易 revert。set 不是 payable 函数,带着非零 Value 调它一定失败。

下一步

先把 SimpleStorageV2 原样粘进 Remix,照完整例题那六步点一遍,每一步先说出预期再点,对不上就停下来查是哪一行代码在起作用。点熟之后自己加一个 transferOwnership(address newOwner),挂上 onlyOwner,测一遍老 owner 交出权限后还能不能调 set。接着去 Lab1b:那里要装 MetaMask 连到 Sepolia、只拿 ABI 去调一份看不到源码的链上合约,再自己写一个会记账、会排序的水龙头,这一页里的 modifier、event、receive 和 Value 清零全都会再用到。

下一讲 →
Lab1b Lab1b 连上测试网、只拿 ABI 调陌生合约,再写一个会记账的水龙头

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