28 个稳定版本 (3 个主要版本)

9.0.1 2022 年 10 月 20 日
8.0.0 2022 年 6 月 23 日
7.5.1 2022 年 5 月 27 日
7.2.2 2022 年 4 月 29 日
6.1.0 2022 年 3 月 29 日

#24 in #filecoin-actors

Download history 5/week @ 2024-03-11 170/week @ 2024-04-01

每月下载量 159
用于 3 crates

MIT/Apache

170KB
3.5K SLoC

内置 Filecoin 演员模块

此仓库包含从 2022 年 7 月 6 日网络版本 16、时代 1960320 开始,Filecoin 网络所使用的链上内置演员的代码。

这些演员是用 Rust 编写的,并设计在 Filecoin 虚拟机 内运行。后者在 filecoin-project/ref-fvm 存在一个参考实现。

此仓库的构建过程将每个演员编译成 Wasm 字节码,并生成一个包含所有演员的聚合包,以便所有客户端导入。该包的结构是标准化的。以下为详细信息。

此代码库已在 FIP-0031 中规范化。因此,从网络版本 16 开始,此演员实现是网络唯一认可的。

预 FVM 演员模块

以下网络版本(nv16 之前)的演员也在此实现

  • nv14 演员以促进测试。
  • nv15 演员以启用 nv15=>nv16 升级。

可导入的包

此仓库的主要输出是一个 CARv1 存档,将所有演员的 Wasm 字节码打包到一个文件中,具有以下特性

  • CARv1 标头指向单个根 CID。
  • 根CID解析为一个DAG-CBOR编码的块,定义了一个Manifest类型(如下定义),包含一个表示包格式的版本号(目前始终为1)和一个ManifestPayload的CID。
  • 下面定义的ManifestPayload包含在DAG-CBOR编码的块中,定义了一个类型,将actor类型名称与其对应的CID关联起来。
  • 所有actor的CID都包含在相同的CARv1存档中,与RAW块中的编译好的Wasm字节码一起。

Manifest 模式

# Manifest is encoded as: [version, CID]
type Manifest struct {
  version Int
  payload &ManifestPayload
} representation tuple

# ManifestPayload is encoded as: [ ["actorkey", CID], ["actorkey", CID], ... ]
#
# It alternatively may be interpreted as:
#   type ManifestPayload {String : &ActorBytecode} representation listpairs
# Or simply as a list of tuples.
type ManifestPayload struct {
  system &ActorBytecode
  init &ActorBytecode
  cron &ActorBytecode
  account &ActorBytecode
  storagepower &ActorBytecode
  storageminer &ActorBytecode
  storagemarket &ActorBytecode
  paymentchannel &ActorBytecode
  multisig &ActorBytecode
  reward &ActorBytecode
  verifiedregistry &ActorBytecode
  datacap &ActorBytecode
  placeholder &ActorBytecode
  evm &ActorBytecode
  eam &ActorBytecode
  ethaccount &ActorBytecode
} representation listpairs

# RAW block
type ActorBytecode bytes

预编译的actor包作为此仓库中的发布二进制文件提供。在crates.io上的fil_builtin_actors_bundle存储库将不会更新。

发布

我们通过更改顶级Cargo.toml文件中的workspace.package.version同时发布所有actor、运行时和状态抽象。

  1. 在顶层Cargo.toml文件中更改workspace.package.version
  2. 在GitHub中创建一个发布

这将触发GitHub CI的自动打包构建,生成的包将附加到GitHub发布中。

客户端实现说明

获取actors包

有两种选择

  1. 从源代码构建。
  2. 从GitHub下载预编译的发布包。

从源代码构建说明(选项1)

  1. 克隆仓库。
  2. 检出相关分支或标记(见下文版本部分)。
  3. 从工作区根目录执行make bundle

包将写入到output/builtin-actors.car

两种选项都支持通过脚本或CI管道进行自动化。

集成actors包

这部分是特定于实现的。选项包括

  1. 将包的CARv1字节嵌入到分发程序的二进制文件中。
  2. 启动时下载CARv1文件(使用某种形式的校验和以提高安全性)。

使用ref-fvm加载和使用actors包

一旦实现验证了包的真实性,它应该执行以下操作

  1. 将CARv1导入到块存储中。
  2. 按网络版本在内存中保留根CID。
  3. 将根CID馈送到ref-fvm的Machine构造函数中,以告诉ref-fvm哪个CodeCID映射到哪个内置actor。

支持多个网络版本

由于每个网络版本可能由不同的actor代码支持,实现应该准备加载多个actor包,并按网络版本进行索引。

在实例化ref-fvm Machine时,必须传递网络版本和相应的Manifest根CID。

版本控制

一个合理的问题是crate版本控制如何与协议概念ActorVersion相关。我们采用了类似于specs-actors的政策

  • crate版本中的主要数字与ActorVersion相关。
  • 我们通常不使用次要版本;这些版本始终设置为0
  • 我们努力将主要crate版本进行四舍五入,以表示给定网络升级的最终发布。然而,由于无法预测软件工程的某些方面,这不是一条硬性规则,并且可以通过增加修补程序编号进行进一步的发布。

开发版本将使用类似于 -rc(发布候选)的限定符。

以下是一个将此策略应用于v10演员版本谱系的示例

  • 不稳定开发版本通过提交哈希引用。
  • 稳定开发版本被标记为发布候选:10.0.0-rc1,10.0.0-rc2,等等。
  • 最终发布版本:10.0.0。
  • 修补后的最终发布版本:10.0.1。
  • 修补后的最终发布版本:10.0.2。
  • 网络升级于10.0.2版本生效。

关于此代码库

与specs-actors的关系

此存储库取代了specs-actors,并承担两个角色

  • 内置演员的可执行规范。
  • 内置演员的规范、可移植实现。

致谢

此代码库最初是从Forest客户端的actors v6实现分支出来的,并适应了FVM环境。

社区

由于此代码库是所有Filecoin客户端实现中的公共财富,它成为所有Core Devs(无论其识别的实现或项目)的汇聚点。

许可证

双重许可:通过MITApache软件许可协议v2,通过许可协议栈

除了EVM预编译测试数据,该数据根据LGPL v3许可,不包括在crates或构建工件中。

依赖项

~11MB
~188K SLoC