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结构的impl表示。服务的主要职责是实现应用程序业务逻辑的某些方面。

实现定义的一组服务的 公共 方法本质上是一组服务暴露给外部消费者的远程调用集合。每个在 &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中，事件是通过events参数在#[service]属性中按服务配置和发出的。它们由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，可能来自外部crate，您希望将它们的函数集成到新的服务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编解码器来编码/解码数据。

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

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

每个输出的响应消息都有以下格式

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

每个输出的事件消息都有以下格式

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

客户端

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

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

• msg::send函数从gstdcrate与应用程序交互。
• gclientcrate从链下代码与链上应用程序交互。
• @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;
}

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

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

示例

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

通过程序公开服务

示例基于几个程序公开几个服务的原则。请参阅DemoProgram，该示例展示了这一点，包括程序的多重构造函数和用于公开服务的#[route]属性。该示例还包括Rust 构建脚本，该脚本将程序构建为WASM应用程序，准备加载到Gear网络上。

基本服务

有几个服务展示了基本的服务结构，公开了一些基于输入参数操作并返回一些结果的原生方法。它们是开发您的服务的极好起点。请参阅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库作为依赖项。

许可协议