← COMP5565 全部讲次
L04b-1 · 第 4 周

L04b-1 第一份合约:Faucet 与 pragma 版本

从零弄清智能合约是什么、怎么部署,再逐行读懂 Faucet,最后看懂第一行 pragma 和各版本断点。

一句话版

智能合约就是一段部署到链上、谁都能调用、改不了的程序;Faucet 是课上的第一份完整合约,它的第一行 pragma 决定了哪些编译器能编它。

上一讲讲了 DApp 的全貌,这一页开始真正读 Solidity 代码。前置的区块链与交易概念见 L04a-1。

先认识这几个词

词 白话意思
智能合约 部署在区块链上的一段程序,按地址调用
EVM 以太坊虚拟机,所有节点都用它执行合约
EOA 外部账户,由真人用私钥控制的账户
wei / ether 以太币的最小单位和常用单位
pragma 源码第一行,声明需要哪个范围的编译器
solc Solidity 的编译器

一个类比:广场中央的自动售水机

把合约想成装在广场中央的一台自动售水机。机器的程序出厂就焊死,谁都能投币按按钮,按同一个按钮得到的结果在每个围观者眼里都一样。Faucet 是一台免费出水的机器,只规定每人每次最多接一杯。

pragma 则是贴在机器背面的铭牌:「本机只兼容 0.8 系列的零件」。零件版本换了大代,机器就装不上。

类比在哪里失效:

  • 售水机断电就停了,合约没有「开着」的状态,它只在有人发交易时才醒来执行一次。
  • 售水机的程序可以返厂重刷,合约部署后代码改不了,只能部署一份新的、换个地址。

从零讲起

1. 先补一块:智能合约与 Solidity(补充)

它解决什么问题

两个陌生人想按规则交换价值,又不想信任中间人。把规则写成程序放到链上,执行由全网节点共同完成,结果谁都改不了,这就是智能合约。Solidity 是写这种程序最流行的语言。

从哪来(补充)

Solidity 由 Gavin Wood 于 2014 年 8 月提出,后来由以太坊的 Solidity 团队开发维护,语法接近 JavaScript、C++ 和 Java。出处:Wikipedia: Solidity。另一种在用的合约语言是 Python 风格的 Vyper,它刻意砍掉了继承和修饰器来减少出错面。

直觉

课件给智能合约下的定义有五个关键词:它是计算机程序;它不可变;它是确定性的;它运行在 EVM 上下文里;整个网络像一台去中心化的世界计算机。

「确定性」最值得记住。每个节点都要独立跑同一段代码并得到同一个结果,所以合约里不能有真随机数、不能发 HTTP 请求、不能读本地文件。链需要外部数据时,只能靠预言机送进来。

一步一步看

目标:跟着一份合约从写源码到退场走完五步,看出部署靠一笔 to 字段为空的交易,之后按地址调用。

一份合约的一生分五步:

  1. 用 Solidity 这样的高级语言写源码。

  2. 用 solc 编译成 EVM 字节码和 ABI(接口描述)。

  3. 发一笔特殊的合约创建交易,把字节码送上链。这笔交易的 to 字段是空的。

  4. 网络给合约分配一个地址,之后任何人往这个地址发交易,就是在调用它。

  5. 合约可以用 selfdestruct 退场,不过这一步在 2024 年之后被大幅削弱,下一讲细说。

    合约生命周期五步横向流程图:写源码,编译成字节码和 ABI,部署时发一笔 to 字段为空的创建交易并被青绿高亮,之后按地址调用,最后 selfdestruct 退场且已被削弱

怎么判断

判断一次合约执行是谁触发的,往回追到底一定是一笔由 EOA 签名的交易。合约可以创建合约、调用合约,但没有任何合约会自己醒来。

判断合约地址怎么来:它由发起账户和该账户的 nonce 推导,即 keccak256(rlp([sender, nonce])) 的后 20 字节。同一个账户按同样顺序部署,地址可以提前算出来。

常见误解

「部署交易是发给零地址 0x0 的」对吗?

课件沿用教科书的说法写成「发往特殊的合约创建地址 0x0」。更精确的说法是创建交易的 to 字段为空。真往全零地址转账是一种销毁操作,不会创建合约。考试照课件答可以,但要知道两者不是一回事。

「合约会定时自己执行」对吗?

不对。合约没有心跳,只在被调用时执行。所以众筹合约到期不会自动退款,必须有人发一笔交易来触发退款函数。

试一下

同一个账户先后部署了两份完全相同的合约,它们的地址一样吗?

不一样。第二次部署时账户的 nonce 已经加了 1,地址由 sender 和 nonce 一起算出,所以两次结果不同。

2. Faucet 逐行读

它解决什么问题

Faucet(水龙头)是测试网上发免费测试币的合约。它短小,却把状态变量、构造器、修饰器、权限检查、收钱和打钱全用上了,整讲后面会反复回到它。

直觉

它的逻辑可以用三句话说完:部署的人是主人;任何人都可以来取钱,但每次有上限;只有主人可以把钱转给任意地址。合约里的钱则来自别人直接往合约地址的转账。

一步一步看

目标:按代码顺序逐行读 Faucet,看出状态变量、构造器、修饰器、收钱和打钱各在哪一行,谁能调哪个函数。

按代码顺序读一遍(图里把变量名缩短了,课件原文写的是 withdraw_amount):

  1. // SPDX-License-Identifier: MIT 声明许可证。不写只会得到警告,不会编译失败。

  2. pragma solidity ^0.8.18; 声明编译器版本范围,第 3 个概念细说。

  3. contract Faucet { ... } 开一个合约,类比别的语言里的 class。

  4. address Owner; 是状态变量,永久存在链上。

  5. 构造器里写 Owner = msg.sender;,部署者成为主人。构造器只在部署那一刻跑一次。

  6. 修饰器 onlyOwner 先检查调用者是不是 Owner,_; 处再放入函数体。

  7. withdraw 谁都能调,用 require 限制单次提款额,然后把钱打给调用者。

  8. transfer 带 onlyOwner,只有主人能调。

  9. receive 和 fallback 都标了 payable,负责收下别人打进来的钱。

    Faucet 简化版逐行对照表:pragma 行声明编译器范围,contract 行开合约,receive 行收钱,withdraw 行任何人都能调,require 那一行限制一次最多 0.1 ether 并被青绿框出,transfer 行把钱打给调用者

怎么算

课件原文的上限写成一长串零:require(withdraw_amount <= 100000000000000000);。换算方法是数零再对照单位。

1 ether = 10^18 wei,而 100000000000000000 是 1 后面跟 17 个零,也就是 10^17 wei。

意思是:这行代码限制单次最多取 0.1 ether。课件后面继承版的 Faucet 把同一行写成 require(withdraw_amount <= 0.1 ether);,两种写法完全等价,后者不容易多打或少打一个零。

常见误解

「require 失败时会告诉用户为什么」对吗?

这份 withdraw 的 require 没写错误消息,失败时钱包里只看到一句没有信息的 revert。课件后面专门把它改成带消息的版本。

「Owner 和 owner 是两个变量」对吗?

是同一个东西。课件开头的 Faucet 首字母大写,后面的继承示例写成小写。Solidity 惯例是小驼峰,读题时不要被大小写绕进去。

试一下

合约余额只剩 0.03 ether 时,有人调 withdraw 取 0.05 ether,会怎样?

require 那一行通过(0.05 不超过上限),但 transfer 发现余额不够,抛异常,整笔交易回滚。错误信息同样不友好。

3. pragma 与版本断点

它解决什么问题

Solidity 更新很快,不同版本之间有不兼容的改动。pragma 写在源码第一行,告诉编译器「我只在这个范围内能正确编译」,防止拿错版本的编译器编出意料之外的字节码。

直觉

版本号用语义化版本 MAJOR.MINOR.PATCH:主版本递增表示有不兼容变更,次版本是兼容地加特性,补丁是兼容地修 bug。

Solidity 的特殊之处在于主版本长期停在 0,于是 0.x 里的 x 实际扮演了主版本的角色。0.5、0.6、0.7、0.8 每一次跨越都会让一部分旧代码编译不过。

一步一步看

目标:对照三种 pragma 写法和四个版本断点,看出 ^0.8.18 允许哪些版本,换版本时哪些写法会失效。

读懂 pragma 的三种常见写法:

  1. ^0.8.18:允许 0.8.18 及以上、但小于 0.9.0 的版本。^ 锁住最左边的非零位。

  2. =0.4.21:只认 0.4.21 这一个版本,课件里的老式构造器示例就这么写。

  3. >=0.7.0 <0.9.0:手动给一个区间。

    pragma 写法与允许版本对照表:^0.8.18 允许 0.8.18 到 0.8.x、拒绝 0.8.17 和 0.9.0,该行被青绿框出;=0.4.21 只允许这一个版本;大于等于 0.8.0 小于 0.9.0 允许整个 0.8 系列

再记住课件里反复踩到的四个断点:

版本 不兼容的改动
0.5.0 函数必须显式写可见性;禁止函数与合约同名;this.balance 改为 address(this).balance
0.6.0 fallback 拆成 receive 和 fallback 两个
0.7.0 构造器不能再写可见性
0.8.0 算术默认检查溢出;byte 改名 bytes1;引入 custom error

怎么判断

拿到一段代码和一个编译器版本,分两步判断:先看 pragma 允许不允许这个版本;允许的话,再看代码里有没有用到在该版本前已被删掉的写法。

例如 pragma solidity ^0.8.18; 下面写了 byte[5] arr;,pragma 这一关能过,但 byte 在 0.8.0 已改名,照样编译失败。

常见误解

「^0.8.18 允许升级到 0.9」对吗?

不对。^ 只允许在当前次版本系列内升级,^0.8.18 的上界是小于 0.9.0。在 Solidity 里 0.8 到 0.9 的跳变按主版本对待。

「pragma 写得越宽越好,兼容性强」对吗?

不对。范围越宽,越可能被一个行为不同的编译器编出来。课件的最佳实践写的是用最新的编译器,新版本经常在语言层面堵掉一类漏洞,0.8 的溢出检查就是例子。

试一下

pragma solidity ^0.7.6; 能不能用 0.8.0 编译?

不能。^0.7.6 的上界是小于 0.8.0,0.8.0 正好落在范围外。

把它们串起来

一份合约从源码到链上要经过编译和一笔 to 字段为空的创建交易,部署后谁都能按地址调用它。Faucet 把这个过程落到具体代码:构造器在部署那一刻把部署者记成主人,withdraw 用 require 卡住每次 0.1 ether 的上限,receive 收下别人捐进来的钱。

第一行的 pragma 决定了这段代码能用哪些编译器。课件代码横跨多个 Solidity 版本,读到某行「编译不过」时,先去版本断点表里找原因,多半是写法早已被某个 0.x 版本删掉了。

下一页接着拆 Faucet 里出现的那些类型:uint256、address、mapping 各存什么、没赋值时读到什么、存在哪里。

课件里的坑

  • [口径过时] 课件说创建交易「发往特殊的合约创建地址 0x0」,更精确的说法是创建交易的 to 字段为空,往全零地址转账不会创建合约(p.4)
  • [复制残留] 注释 // Our first contract is a faucet 出现了两次,一次在 contract Faucet { 之前、一次在花括号内;不影响编译(p.9)
  • [大小写不一] 状态变量写成首字母大写的 Owner,后面继承示例写成小写 owner,两处是同一个东西(p.9、p.47)
  • [可读性差] 上限写成 100000000000000000,继承版改写为 0.1 ether,两者等价,后者不易数错零(p.10、p.48)

课后 10 分钟:考点复习

这 10 分钟怎么用:先默写合约生命周期五步和四个版本断点;再把 Faucet 的四个函数各自的角色说一遍;最后做完整例题,练「先看 pragma 再看写法」的两步判断。

必背

  1. 智能合约是不可变的计算机程序,在 EVM 上下文中确定性地运行;所有合约执行归根结底都由一笔 EOA 发起的交易触发。
  2. 合约创建交易的 to 字段为空,合约地址由发起账户和 nonce 推导:keccak256(rlp([sender, nonce])) 的后 20 字节。
  3. Faucet 的单次提款上限 100000000000000000 wei = 10^17 wei = 0.1 ether,与 0.1 ether 的写法完全等价,后者可读性远高。
  4. 语义化版本 MAJOR.MINOR.PATCH:主版本不兼容、次版本兼容加特性、补丁兼容修 bug;^0.8.18 表示 >=0.8.18 且 <0.9.0。
  5. Solidity 主版本长期停在 0,0.5、0.6、0.7、0.8 每次跨越都带来不兼容变更:0.5.0 函数必须写可见性,0.8.0 默认检查溢出、byte 改名 bytes1。

课件例题

例 1(课件 p.9–10):读懂 Faucet.sol

题面:Faucet 的 withdraw 里写着 require(withdraw_amount <= 100000000000000000);,transfer 带 onlyOwner 修饰器。(1) 单次最多能提多少 ether?(2) 一个普通账户调 withdraw 提 0.05 ether、提 0.2 ether,分别会怎样?(3) 它调 transfer 会怎样?

提示

先数零换算单位;再分别看 require 和 onlyOwner 这两道门各自拦什么人、拦什么金额。

解答
  1. 100000000000000000 wei = 10^17 wei,1 ether = 10^18 wei,所以上限是 0.1 ether。
  2. 提 0.05 ether:不超上限,合约余额够就转给调用者。提 0.2 ether:require 不成立,整笔回滚,这行 require 没写错误消息,钱包里只看到一句无信息的 revert。
  3. 调 transfer:先跑 onlyOwner 里的 require(msg.sender == Owner, "Not Owner"),普通账户不是部署者,回滚并报 “Not Owner”,函数体根本不执行。

完整例题

题面:下面三段代码各自声明了 pragma,并分别交给指定版本的编译器。判断每段能否编译,不能的写出原因。

// (a) 交给 0.8.21
pragma solidity ^0.8.18;
contract A { byte[5] arr; }

// (b) 交给 0.6.12
pragma solidity >=0.5.0 <0.7.0;
contract B { function f() returns (uint) { return 1; } }

// (c) 交给 0.8.21
pragma solidity ^0.8.18;
contract C { function bal() public view returns (uint) { return address(this).balance; } }
  1. 约定两步走:第一步只看 pragma 是否接纳给定的编译器;第二步再查代码里有没有该版本已经删掉的写法。两步都过才算能编译。
  2. (a) 第一步:^0.8.18 的范围是 0.8.18 到小于 0.9.0,0.8.21 在范围内,通过。
  3. (a) 第二步:byte 在 0.8.0 改名为 bytes1,0.8.21 不认识 byte,编译失败。应改成 bytes1[5] arr;。
  4. (b) 第一步:区间是 0.5.0 到小于 0.7.0,0.6.12 在内,通过。
  5. (b) 第二步:函数 f 没写可见性。0.5.0 起函数必须显式声明可见性,编译失败。应写成 function f() public pure returns (uint)。
  6. (c):pragma 接纳 0.8.21;address(this).balance 是 0.5.0 之后的正确写法,函数只读余额,标 view 合适。能编译。
  7. 要点:pragma 只保证「编译器版本对得上」,不保证代码在该版本下合法。课件里多处旧代码就是 pragma 写着 0.8、正文却用了老写法。

答题格式:每段写「pragma 是否接纳 → 有无失效写法 → 结论」三项,失效写法要点名是哪个版本删掉的。

变式题(先自己做)

(1) 把例 1 的 Faucet 上限改成 require(withdraw_amount <= 50000000000000000);,单次上限是多少 ether?(2) 有人想把 pragma 改成 pragma solidity ^0.4.24; 再用 0.4.26 编译这份 Faucet,至少会在哪两处出问题?

提示

第一问照样数零。第二问去版本断点表里找:Faucet 用到的 receive 是哪个版本才有的?payable(msg.sender) 这种类型转换呢?

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

判分点:① 第一问换算正确并写出 wei 与 ether 的关系;② 第二问至少指出两处具体写法,并说明对应版本。

(1) 50000000000000000 是 5 × 10^16 wei,除以 10^18 得 0.05 ether。

(2) 一是 receive() 是 0.6.0 才拆出来的函数,0.4 系列只有一个无名 fallback 函数;二是 payable(msg.sender) 这种转换写法到 0.6 系列才有,0.4 里地址本身就能直接调 transfer,这行在 0.4.26 下编译不过。另外 0.4 系列没有默认的溢出检查。答出前两处即可得满分。

闪卡自测

1. 智能合约定义里的五个关键词是什么?

计算机程序、不可变、确定性、运行在 EVM 上下文中、去中心化的世界计算机(p.3)。

2. ^0.8.18 允许哪些编译器版本?

大于等于 0.8.18、小于 0.9.0。语义化版本里主版本不兼容、次版本兼容加特性、补丁兼容修 bug;Solidity 还在 0.x,所以 0.8 到 0.9 的跳变就当主版本看(p.7)。

3. 合约地址怎么来?

由发起账户和它的 nonce 推导,即 keccak256(rlp([sender, nonce])) 的后 20 字节,所以可以提前算出(p.4)。

4. Faucet 里的 ether 从哪来?

任何人直接往合约地址转账,由 receive() 收下;带数据却没匹配函数的调用由 fallback() 兜底(p.10)。

5. 不写 SPDX 许可证行会怎样?

编译器给警告,不报错(p.9)。

下一讲

下一页 L04b-2 拆 Faucet 里出现的类型:整数、地址、单位后缀、数组、mapping、enum 各存什么,没赋值时读到什么,以及 storage、memory、calldata 三个数据位置的区别。

下一讲 →
L04b-2 L04b-2 类型、零值与三个数据位置

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