内置 Filecoin 演员库

此仓库包含从 2022 年 7 月 6 日网络版本 16，epoch 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关联起来。
• 所有角色的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发布中。

客户端实现说明

获取actor捆绑包

有两种选择：

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

从源代码构建说明（选项1）

1. 克隆仓库。
2. 检出相关分支或标签（见下面的版本部分）。
3. 从工作区根目录执行make bundle。

捆绑包将写入output/builtin-actors.car。

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

集成actor捆绑包

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

1. 将捆绑的CARv1字节嵌入到分布的二进制文件中。
2. 启动时下载CARv1文件（具有某种形式的校验和以增加安全性）。

使用ref-fvm加载和actor捆绑包

一旦实现验证了捆绑包的完整性，它应该执行以下操作：

1. 将CARv1导入到blockstore。
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。
• 我们努力使主要版本号呈圆形，以表示给定网络升级的最终版本。然而，由于无法预测软件工程的一些方面，这并非硬性规定，后续可能通过增加补丁号来发布新的版本。

开发版本将使用类似 -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客户端实现中的公共财富，因此它成为所有核心开发者汇聚的地方，无论他们认同的实现或项目如何。

许可协议

双许可：通过MIT、Apache软件许可证v2，根据许可堆栈。

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