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日 |
#22 in #filecoin-actors
每月下载量 149次
用于 3 crates
180KB
3.5K SLoC
内置Filecoin actors
该仓库包含从2022年7月6日的网络版本16,epoch 1960320开始的Filecoin网络的链上内置actors的代码。
这些actors是用Rust编写的,并设计在Filecoin虚拟机内部运行。后者有一个在filecoin-project/ref-fvm的参考实现。
该仓库的构建过程将每个actor编译成Wasm字节码,并生成一个聚合包供所有客户端导入。该包的结构是标准化的。以下为详细信息。
该代码库在FIP-0031中被标准化。因此,从网络版本16开始,该actor实现是网络唯一认可的。
FVM之前的actors
以下nv16之前的网络版本的actors也在此实现
- nv14 actors以促进测试。
- nv15 actors以启用nv15=>nv16升级。
可导入的bundle
该仓库的主要输出是一个CARv1存档,将所有actors的Wasm字节码打包到一个文件中,具有以下特性
- CARv1头部指向一个单一的root CID。
- 根CID解析为一个DAG-CBOR编码的块,该块定义了一个
Manifest
类型(下面定义),包含一个用于包格式的版本号(目前始终为1
)和一个ManifestPayload
的CID。 - 下面定义的
ManifestPayload
包含在一个DAG-CBOR编码的块中,并定义了一个类型,该类型将演员类型名称与其相应的CID相关联。 - 所有演员的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
预编译的演员包以发布二进制文件的形式提供在此存储库中。位于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。
版本控制
一个合理的问题是如何将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客户端的演员v6实现分支的,并被改编为FVM环境。
社区
由于此代码库是所有Filecoin客户端实现中的公共财富,因此它成为所有Core Devs的汇聚点,无论他们认同哪种实现或项目。
许可
双许可:通过MIT、Apache软件许可协议v2,通过许可许可栈。
除了EVM预编译测试数据,它根据LGPL v3许可,不包括在crates或构建工件中。
依赖
~11MB
~188K SLoC