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协议的异步版本请求-响应模式。加载到基于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，可能来自外部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 Codec进行编码/解码数据。

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

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

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

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

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

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

客户端

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

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

• 使用来自msg::send函数的gstd包与应用程序进行交互。
• 使用gclient包从链下代码与链上应用程序进行交互。
• 使用@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生成的客户端

示例客户端 包展示了如何从一个IDL文件生成客户端代码作为一个独立的Rust包。或者，你也可以直接在你的应用程序包中应用相同的方法。参见 Rmrk资源。

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

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

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

许可