10个版本

0.1.9 2021年5月17日
0.1.8 2021年5月14日
0.1.3 2021年4月28日

#65 in #fluence

Apache-2.0

4KB

Marine Rust SDK

crates.io version

此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导出以下主要组件

支持的Rust类型

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

  • 以下Rust基本类型之一:boolu8u16u32u64i8i16i32i64f32f64
  • 字符串 String&str
  • 上述类型的元素组成的向量
  • 由上述类型的向量组成的向量,其中可以接受递归,例如,类型 Vec<Vec<Vec<u8>>> 是允许的
  • 上述所有类型的引用
  • 所有字段都是基本Rust类型的结构体
  • 所有字段都是上述类型或其他以这种方式构建的结构体的结构体

文档

此外,请查看我们的 YouTube频道

仓库结构

  • crates
  • src 包含 call_parameters 和 mounted_binary 模块,并重新导出所有用户所需的内容

支持

如果您发现了一个错误,请提交问题。您也可以通过 DiscordTelegram 联系我们。我们将尽最大努力尽快解决问题。

贡献

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

许可证

所有软件代码均为 Fluence Labs, Inc. 的版权所有(c),受Apache-2.0许可证的约束。

依赖项

~20MB
~390K SLoC