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日

#19 in #filecoin-actors


3 crate 中使用

MIT/Apache

170KB
3.5K SLoC

内置 Filecoin 演员们

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

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

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

此代码库在 FIP-0031 中进行了规范。因此,从网络版本 16 以后,此演员实现是网络唯一认可的实现。

Pre-FVM 演员们

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

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

可导入的包

本仓库的主要输出是一个CARv1存档,将所有演员的Wasm字节码打包成一个文件,具有以下特点:

  • CARv1头部指向一个单一的根CID。
  • 根CID解析为DAG-CBOR编码的块,该块定义了一个Manifest类型(如下定义),包含捆绑格式版本号(当前始终为1)和ManifestPayload的CID。
  • 下面的ManifestPayload(如下定义)包含在DAG-CBOR编码的块中,并定义了一个类型,将演员类型名称与其对应的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

在当前仓库中提供预编译的演员捆绑包作为发布二进制文件。位于crates.io上的fil_builtin_actors_bundle存储库将不会更新。

发布

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

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

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

客户端实现说明

获取演员捆绑包

有两种选择

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

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

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

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

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

集成演员捆绑包

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

  1. 将捆绑包的CARv1字节嵌入到发行版的二进制文件中。
  2. 在启动时下载CARv1文件(使用某种形式的校验和以增加安全性)。

使用ref-fvm加载和调用演员捆绑包

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

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

支持多个网络版本

因为每个网络版本可能由不同的演员代码支持,实现应该准备好加载多个演员捆绑包并将它们按网络版本索引。

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

版本化

一个公平的问题是存储库版本如何与协议概念ActorVersion相关联。我们采用与specs-actors类似的政策

  • 存储库版本中的主版本号与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 客户端实现中的公共财富,它为所有 Core Devs 提供了一个汇聚点,无论他们属于哪种实现或项目。

许可证

双许可:通过 MITApache 软件许可证 v2,通过 许可许可证堆栈

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

依赖关系

~12MB
~203K SLoC