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日

#18 in #filecoin-actors

Download history 89/week @ 2024-03-30 34/week @ 2024-04-06

每月下载量 146
用于 3 crates

MIT/Apache

215KB
4K SLoC

内置 Filecoin 演员们

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

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

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

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

Pre-FVM 演员们

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

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

可导入的包

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

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

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
  • 我们努力以圆形主crate版本来表示给定网络升级的最终发布版本。然而,由于无法预测软件工程的某些方面,这并非硬性规则,可能需要通过增加补丁号来发布更多版本。

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

以下是一个将此政策应用于v10 actor版本谱系的示例

  • 不稳定开发版本通过提交哈希引用。
  • 稳定的开发版本被标记为发布候选版本: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
~205K SLoC