Marine Rust SDK

此 SDK 使开发者能够创建通用 Wasm 模块，并在 interface-types 和一个 无共享链接 方案的帮助下，将它们组合成多模块设置。SDK 提供了所有必要的宏和其他功能，以使 Wasm 开发过程尽可能接近 "vanilla" Rust。编译后的模块旨在与 Marine 运行时一起运行。

用法

SDK 的核心组件是 #[marine] 宏，该宏应与导出函数、外部块和结构一起使用。让我们考虑一个包含一个导出函数的模块的简单场景

use marine_rs_sdk::marine;

#[marine]
pub fn greeting(name: String) -> String {
    format!("Hi, {}", name)
}

此代码导入了 Marine SDK 并使用 #[marine] 宏包装了问候函数。任何以这种方式包装的函数都将从编译后的 Wasm 模块中导出。

要将此代码编译为 Wasm，您需要 Marine CLI 工具。如果您尚未安装 cli，请使用 cargo install marine

marine build --release

最后，您将获得一个嵌入到 Wasm 二进制文件中的构建清单，并可以与 Marine REPL (mrepl) 中的模块进行交互。如果您还没有，请使用 cargo install mrepl 安装它

> marine info ./target/wasm32-wasi/release/greeting.wasm
it version:  0.23.1
sdk version: 0.7.0
authors:     <user-name>
version:     0.1.0
description:
repository:
build time:  2023-02-15 18:52:37.865550 +00:00 UTC

> mrepl --quiet
1> load greeting ./target/wasm32-wasi/release/greeting.wasm
module successfully loaded into App service
elapsed time: 52.153308ms

2> interface
Application service interface:
greeting:
  fn greeting(name: String) -> String

3> call greeting greeting "user"
result: String("Hi, user")
 elapsed time: 132.021µs

有关开发此简单模块的完整指南，请参阅 此处。

SDK 组件

SDK 导出以下主要组件

• #[marine] 宏，可以应用于以下场景
  • 函数，使其能够从模块中导出
  • 外部块，使其以Marine兼容的方式导入模块
  • 结构体，使其可作为导出或导入函数的参数使用
• 调用参数接口，旨在提供一组模块启动参数
• 挂载二进制接口，可用于调用CLI工具
• module_manifest 宏，旨在将一些信息嵌入到编译后的Wasm中
• 日志功能，允许调整Marine的日志机制

支持的Rust类型

目前，#[marine] 宏允许以下Rust类型作为导出和导入函数的参数或结构体的字段

• 以下Rust基本类型之一：bool、u8、u16、u32、u64、i8、i16、i32、i64、f32、f64
• 字符串 String、&str
• 以上类型的元素组成的向量
• 由以上类型向量组成的向量，其中递归是可接受的，例如，类型 Vec<Vec<Vec<u8>>> 是允许的
• 所有以上类型的引用
• 所有字段都是基本Rust类型的结构体
• 所有字段都是以上类型或其他以这种方式构建的结构体的结构体

文档

• Marine 书籍
• Marine 示例
• 快速入门

还可以查看我们的 YouTube频道。

仓库结构

• crates
  • macro-testing-utils 包含内部测试工具
  • main 包含 export_allocator、logger 和 results 模块
  • marine-macro 是 #[marine] 宏的 proc-macro crate
  • marine-macro-impl 是 #[marine] 宏的实际实现
  • timestamp-macro 是一个宏，用于将时间戳嵌入编译后的 Wasm 二进制文件
• src 包含 call_parameters 和 mounted_binary 模块，以及重新导出所有必要的用户资源

支持

如果您发现了一个错误，请提交一个 issue。您也可以通过Discord或Telegram联系我们。我们将尽力尽快解决问题。

贡献

任何感兴趣的人都可以为该项目做出贡献。请确保您已阅读并遵循一些基本的规则。

许可证

所有软件代码版权所有（c）Fluence Labs，Inc.，根据Apache-2.0许可证。