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日 |
#21 在 #filecoin-actors 中
每月下载量 146 次
在 3 crates 中使用
190KB
4K SLoC
内置 Filecoin Actor
此仓库包含从 2022 年 7 月 6 日网络版本 16,epoch 1960320 开始,为 Filecoin 网络提供动力的链上内置 Actor 的代码。
这些 Actor 使用 Rust 编写,并设计在 Filecoin 虚拟机 内部运行。后者有一个参考实现,位于 filecoin-project/ref-fvm。
此仓库的构建过程将每个 Actor 编译成 Wasm 字节码,并生成一个聚合包供所有客户端导入。此包的结构是标准化的。下面将详细介绍。
此代码库在 FIP-0031 中进行了规范。因此,从网络版本 16 开始,此 Actor 实现是网络唯一认可的。
FVM 之前的 Actor
以下网络版本(nv16 之前)的 Actor 也在此实现
- nv14 Actor,用于测试。
- nv15 Actor,用于启用 nv15=>nv16 升级。
可导入的包
此仓库的主要输出是一个 CARv1 存档,将所有 Actor 的 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
来同时发布所有演员、运行时和状态抽象。
- 在顶层
Cargo.toml
文件中更改workspace.package.version
。 - 在GitHub中创建一个发布。
这将触发GitHub CI的自动捆绑构建,生成的捆绑包将附加到GitHub发布中。
客户端实现的说明
获取演员包
有两种选择
- 从源代码构建。
- 从GitHub下载预编译的发布捆绑包。
从源代码构建的说明(选项1)
- 克隆存储库。
- 检出相关分支或标签(见下文版本部分)。
- 从工作区根目录执行
make bundle
。
捆绑包将写入到output/builtin-actors.car
。
这两种选项都适用于通过脚本或CI管道进行自动化。
集成演员包
这部分是特定于实现的。选项包括
- 将捆绑包的CARv1字节嵌入到发行版的二进制文件中。
- 在启动时下载CARv1文件(使用某些形式的校验和以增加安全性)。
使用ref-fvm加载和使用演员包
一旦实现验证了捆绑包的真实性,它应该执行以下操作
- 将CARv1导入到块存储中。
- 根据网络版本在内存中保留根CID,进行索引。
- 将根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客户端实现中的公共财富,因此它成为所有核心开发者的汇聚点,无论他们认同哪种实现或项目。
许可
双许可:MIT、Apache软件许可证v2,通过许可许可证栈。
除了EVM预编译测试数据,该数据受LGPL v3许可,不包括在crates或构建工件中。
依赖关系
~11MB
~188K SLoC