gclient 1.10.0

API client for Gear node in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

// This file is part of Gear.

// Copyright (C) 2021-2025 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

use anyhow::Context;
use demo_ping::WASM_BINARY;
use futures::StreamExt;
use gclient::{GearApi, UserMessageSentFilter};
use gear_core::ids::ActorId;
use std::convert::TryFrom;
use tokio::time::{Duration, timeout};

const GEAR_PATH: &str = "../target/release/gear";
const SUBSCRIPTION_TIMEOUT: Duration = Duration::from_secs(5);

/// Running this test requires gear node to be built in advance.
#[tokio::test]
async fn subscribe_user_messages_receives_reply() -> anyhow::Result<()> {
    let api = GearApi::dev_from_path(GEAR_PATH).await?;

    let destination =
        ActorId::try_from(api.account_id().as_ref()).expect("account id must be a valid ActorId");

    let mut subscription = api
        .subscribe_user_message_sent(
            UserMessageSentFilter::new()
                .with_destination(destination)
                .with_payload_prefix(b"PONG"),
        )
        .await?;

    let gas_limit = api.block_gas_limit()?;
    let salt = gclient::now_micros().to_le_bytes();

    // Upload `demo_ping` with payload that triggers the reply to the user.
    api.upload_program_bytes(WASM_BINARY, salt, b"PING".to_vec(), gas_limit, 0)
        .await?;

    let mut received = None;
    for _ in 0..10 {
        let next_event = timeout(SUBSCRIPTION_TIMEOUT, subscription.next())
            .await
            .context("timed out waiting for user message event")?;

        match next_event {
            Some(Ok(event)) if event.destination == destination => {
                if event.payload == b"PONG" {
                    received = Some(event);
                    break;
                }
            }
            Some(Ok(_)) => continue,
            Some(Err(err)) => return Err(err.into()),
            None => break,
        }
    }

    let event = received.expect("expected user message reply");
    assert_eq!(event.payload, b"PONG");
    let reply = event.reply.expect("expected reply details");
    assert!(
        reply.code.is_success(),
        "expected successful reply code, got {:?}",
        reply.code
    );

    Ok(())
}