Sails  

Sails 是一个库，可以将使用 Gear协议 编写应用程序的经验提升到更简单、更清晰的水平。它处理诸如

• 消除编写某些低级样板代码的需要，让您能够专注于业务问题
• 为您的应用程序生成 IDL 文件
• 生成客户端，允许您从编写在不同语言中执行的不同运行时中编写的代码与您的应用程序交互

[!注意] Sails库以 sails-rs 的名称在 crates-io 上发布。

版本 "<= 0.2.0" 锁定到 gear 库的 v1.4.2 版本。

入门指南

将以下内容添加到您的 Cargo.toml

[dependencies]
sails-rs = "*"
gstd = { version = "*", features = ["debug"] }

然后在您的 lib.rs

#![no_std]

use sails_rs::prelude::*;
use gstd::debug;

struct MyPing;

#[service]
impl MyPing {
    pub const fn new() -> Self {
        Self
    }

    pub async fn ping(&mut self) -> bool {
        debug!("Ping called");
        true
    }
}

#[derive(Default)]
struct MyProgram;

#[program]
impl MyProgram {
    #[route("ping")]
    pub fn ping_svc(&self) -> MyPing {
        MyPing::new()
    }
}

详细信息

Gear协议 整个想法基于 请求-响应模式 的异步版本。加载到基于Gear网络的链上应用程序接收和处理来自其他链上或链下应用程序的消息。两者都可以被视为您应用程序提供的服务的外部消费者，后者可以代表与网络交互的普通人。

应用

Sails应用程序架构基于几个关键概念。

第一个关键概念是服务，它通过标记有#[service]属性的Rust结构体的实现来表示。服务的主要职责是实现应用程序业务逻辑的某些方面。

由实现定义的一组服务公共方法本质上是一组服务对外部消费者暴露的远程调用。每个在&mut self上工作的方法被视为改变某些状态的操作，而每个在&self上工作的方法被视为查询，保持一切不变并返回一些数据。这两种类型的方法都可以接受客户端传递的参数，可以是同步的或异步的。所有其他的服务方法和关联函数都被视为实现细节并被忽略。由#[service]属性在服务背后生成的代码解码传入的请求消息，并根据方法名称将其调度到适当的方法。在方法完成时，其结果被编码并作为响应返回给调用者。

#[service]
impl MyService {
    // This is a command
    pub fn do_something(&mut self, p1: u32, p2: String) -> &'static [u8] {
        ...
    }

    // This is a query
    pub fn some_value(&self, p1: Option<bool>) -> String {
        ...
    }
}

第二个关键概念是程序，它类似于服务，通过标记有#[program]属性的Rust结构体的实现来表示。程序的主要职责是托管一个或多个服务并将它们暴露给外部消费者。

它的一组关联的公共函数返回Self被视为应用程序构造函数。这些函数可以接受客户端传递的参数，可以是同步的或异步的。其中之一将在应用程序生命周期的非常开始时被调用一次，即当应用程序加载到网络上时。返回的程序实例将一直存在，直到应用程序留在网络上。如果没有发现此类方法，将生成以下签名的默认方法

pub fn default() -> Self {
    Self
}

程序的一组公共方法，在&self上工作且没有其他参数，被视为暴露的服务构造函数，并在每次需要将传入的请求消息调度到选定的服务时调用。所有其他方法和关联函数都被视为实现细节并被忽略。由#[program]属性在程序背后生成的代码从网络上接收传入的请求消息，对其进行解码并将其调度到匹配的服务进行实际处理。之后，将结果编码并作为响应返回给调用者。每个应用程序只允许有一个程序。

#[program]
impl MyProgram {
    // Application constructor
    pub fn new() -> Self {
        ...
    }

    // Yet another application constructor
    pub fn from_u32(p1: u32) -> Self {
        ...
    }

    // Service constructor
    pub fn ping_svc(&self) -> MyPing {
        ...
    }
}

最后一个关键概念是消息路由。这个概念在代码中没有强制性的表示，但可以通过应用上述描述的公共方法和关联函数上的#[route]属性来修改。这个概念本身是关于将传入的请求消息调度到特定服务的某个方法的规则，使用服务和方法的名称。默认情况下，通过程序暴露的每个服务都使用服务构造函数方法的名称转换为PascalCase。例如

#[program]
impl MyProgram {
    // The `MyPing` service is exposed as `PingSvc`
    pub fn ping_svc(&self) -> MyPing {
        ...
    }
}

可以通过应用#[route]属性来改变此行为

#[program]
impl MyProgram {
    // The `MyPing` service is exposed as `Ping`
    #[route("ping")] // The specified name will be converted into PascalCase
    pub fn ping_svc(&self) -> MyPing {
        ...
    }
}

相同的规则适用于服务方法名称

#[service]
impl MyPing {
    // The `do_ping` method is exposed as `Ping`
    #[route("ping")]
    pub fn do_ping(&mut self) {
        ...
    }

    // The `ping_count` method is exposed as `PingCount`
    pub fn ping_count(&self) -> u64 {
        ...
    }
}

事件

Sails提供了一种机制，可以在处理命令时从您的服务中发出事件。这些事件作为通知链下订阅者应用程序状态变化的手段。在Sails中，事件通过#[service]属性的events参数进行配置和发出。它们由一个Rust枚举定义，每个变体代表一个单独的事件及其可选数据。一旦服务声明它发出事件，#[service]属性将自动生成notify_on服务方法。此方法可以被服务调用以发出事件。例如

fn counter_mut() -> &'static mut u32 {
    static mut COUNTER: u32 = 0;
    unsafe { &mut COUNTER }
}

struct MyCounter;

#[derive(Encode, TypeInfo)]
enum MyCounterEvent {
    Incremented(u32),
}

#[service(events = MyCounterEvent)]
impl MyCounter {
    pub fn new() -> Self {
        Self
    }

    pub fn increment(&mut self) {
        *counter_mut() += 1;
        self.notify_on(MyCounterEvent::Incremented(*counter_mut())).unwrap();
    }

    // This method is generated by the `#[service]` attribute
    fn notify_on(&mut self, event: MyCounterEvent) -> Result<()> {
        ...
    }
}

需要注意的是，内部上，事件使用与Gear协议中任何其他消息传输相同的机制。这意味着只有当发出事件的命令成功完成后，事件才会被发布。

服务扩展（混入）

Sails的一个显著特性是其扩展（或混入）现有服务的能力。这通过在#[service]属性中使用extends参数来实现。考虑你有一个服务A和服务B，可能来自外部包，并且你希望将它们的功能集成到新的服务C中。这种集成将导致服务A和B的方法和事件无缝地集成到服务C中，就像它们最初就是其一部分一样。在这种情况下，服务C中可用的方法代表来自服务A和服务B的组合。如果出现方法名冲突，即服务A和B都包含具有相同名称的方法，则优先考虑extends参数中首先指定的服务的方法。这种策略不仅促进了功能的融合，还允许通过在新服务中定义具有相同名称的方法来覆盖原始服务中的特定方法。对于事件名称，不允许冲突。不幸的是，当发生错误时，IDL生成过程是最早报告这种情况的。例如

struct MyServiceA;

#[service]
impl MyServiceA {
    pub fn do_a(&mut self) {
        ...
    }
}

struct MyServiceB;

#[service]
impl MyServiceB {
    pub fn do_b(&mut self) {
        ...
    }
}

struct MyServiceC;

#[service(extends = [MyServiceA, MyServiceB])]
impl MyServiceC {
    // New method
    pub fn do_c(&mut self) {
        ...
    }

    // Overridden method from MyServiceA
    pub fn do_a(&mut self) {
        ...
    }

    // do_b from MyServiceB will exposed due to the extends argument
}

有效载荷编码

使用Sails编写的应用程序在其基础中使用SCALE Codec进行编码/解码数据。

预期的每个传入请求消息都应具有以下格式

| SCALE编码的服务名称 | SCALE编码的方法名称 | SCALE编码的参数 |

每个传出响应消息都应具有以下格式

| SCALE编码的服务名称 | SCALE编码的方法名称 | SCALE编码的结果 |

每个传出事件消息都应具有以下格式

| SCALE 编码的服务名称 | SCALE 编码的事件名称 | SCALE 编码的事件数据 |

客户端

与应用程序具有强大的交互能力至关重要。Sails 提供了多种交互选项。

首先，它支持使用 Gear 协议进行手动交互。您可以使用

• 来自 gstd crate 的 msg::send 函数在应用程序之间进行交互。
• 使用 gclient crate 从链下代码与链上应用程序交互。
• 使用 @gear-js/api 库从 JavaScript 与程序交互。

您只需要根据 负载编码 部分中概述的布局组合一个字节负载，并将其发送到应用程序。

感谢生成的 IDL，Sails 提供了一种使用类似后端暴露接口的生成客户端以更清晰的方式与您的应用程序交互的方法。目前，Sails 可以生成 Rust 和 TypeScript 的客户端代码。

当涉及到 Rust 时，有两个选项

• 使用生成的代码可以为您编码和解码字节负载，允许您继续使用发送原始字节的函数。
• 使用完全生成的代码以 RPC 风格与您的应用程序交互。

有关 TypeScript 的更多信息，请参阅 生成客户端 文档。

假设您有一个公开了名为 MyService 服务的应用程序，该服务有一个名为 do_something 的命令

struct Output {
    m1: u32,
    m2: String,
}

#[service]
impl MyService {
    pub fn do_something(&mut self, p1: u32, p2: String) -> Output {
        ...
    }
}

#[program]
impl MyProgram {
    pub fn my_service(&self) -> MyService {
        MyService::new()
    }
}

然后在客户端应用程序中，如果在 Rust 构建脚本中发生代码生成，您可以使用生成的代码如下（选项 1）

include!(concat!(env!("OUT_DIR"), "/my_service.rs"));

fn some_client_code() {
    let call_payload = my_service::io::DoSomething::encode_call(42, "Hello".to_string());
    let reply_bytes = gstd::msg::send_bytes_for_reply(target_app_id, call_payload, 0, 0).await.unwrap();
    let reply = my_service::io::DoSomething::decode_reply(&reply_bytes).unwrap();
    let m1 = reply.m1;
    let m2 = reply.m2;
}

或者这样（选项 2）

include!(concat!(env!("OUT_DIR"), "/my_service.rs"));

fn some_client_code() {
    let mut my_service = MyService::new(remoting); // remoting is an abstraction provided by Sails
    let reply_ticket = client.do_something(42, "Hello".to_string())
        .with_reply_deposit(42)
        .publish(target_app_id)
        .await.unwrap();
    let reply = reply_ticket.reply().await.unwrap();
    let m1 = reply.m1;
    let m2 = reply.m2;
}

第二个选项提供了您代码的可测试性，因为生成的代码依赖于可以轻松模拟的 trait。

当涉及到 TypeScript 时，可以使用 sails-js 库与程序交互。有关更多详细信息，请参阅 sails-js 文档。

示例

您可以在 此处 找到所有示例，包括在文件夹级别提供的一些描述。您还可以在代码中找到一些解释性注释。以下是上述功能的简要概述和示例展示

通过程序公开服务

示例基于几个程序公开几个服务的原则。请参阅 DemoProgram，它演示了这一点，包括使用 [route] 属性的一个示例。该示例还包括 Rust

基本服务

有几个服务展示了基本的服务结构，通过输入参数执行一些原始方法，并返回一些结果。它们是开发您服务的绝佳起点。请参阅Ping和ThisThat服务。后者除了基本功能外，还展示了服务方法中可以使用的各种参数和返回值类型。

数据处理

在现实世界中，几乎所有的应用程序都以某种形式处理数据，使用Sails开发的应用程序也不例外。如应用程序部分所述，为每个传入的请求消息实例化服务，表明这些服务是无状态的。然而，有几种方法可以使您的服务保持某些状态。在这种情况下，状态将被视为服务外部。

最推荐的方法是在Counter服务中演示，其中数据作为程序的一部分存储，并通过RefCell传递给服务。服务模块仅定义数据的形状，但需要从外部传递数据本身。此选项为您提供完全的灵活性，并允许您在多线程环境中对服务进行单元测试，确保测试不会相互影响。

另一种方法在RmrkCatalog和RmrkResource服务中演示，其中数据存储在服务模块的静态变量中。这种策略确保状态完全隐藏在外部，使服务完全自包含。然而，这种方法在多线程环境中的单元测试中并不理想，因为每个测试都可能影响其他测试。此外，在首次使用服务之前，务必要调用服务的seed方法。

您还可以探索其他方法，例如使服务的数据需要&'a mut（这使服务不可克隆），或使用Cell（这需要数据复制，造成额外的开销）。

在所有情况下，除了使用Cell外，考虑数据的静态性质至关重要，尤其是在服务方法中的异步调用期间。这意味着在启动异步调用之前访问的数据可能在调用完成时发生变化。有关详细信息，请参阅RmrkResource服务的add_part_to_resource方法。

事件

您可以在Counter和RmrkResource服务中找到如何从服务中发出事件的示例。

服务扩展（混入）

使用Dog服务演示了服务扩展的例子，该服务扩展了来自同一crate的Mammal服务以及来自不同crate的Walker服务。被扩展的服务必须实现Clone特质，而扩展服务必须为被扩展服务实现AsRef特质。

使用Rust生成客户端

Demo Client crate展示了如何将IDL文件生成客户端代码作为单独的Rust crate。或者，你也可以直接在你的应用程序crate中使用相同的方法。请参阅Rmrk Resource。

你可以在Demo Tests中找到如何使用生成的客户端代码与应用程序交互的各种示例。查看代码中的注释以获取更多详细信息。

由于生成的代码对所有环境都相同，无论是来自测试还是来自另一个应用程序的交互，这些交互的技术也相同。你可以在Rmrk Resource服务的add_part_to_resource方法中找到一个应用程序交互的例子。

请注意，使用生成的客户端需要将sails_rs crate作为依赖项。

许可证

lib.rs:

Sails框架的过程宏。