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 模块，同时导出所有用户所需的内容

支持

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

贡献

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

许可证

所有软件代码均为 Fluence Labs, Inc. 版权所有，根据 Apache-2.0 许可证。