blokli-client 0.33.1

Client connector to Blokli
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

use hex::ToHex;

use super::{Uint64, schema};
use crate::api::v1::TicketSelector;

/// GraphQL subscription variables for the `ticketRedeemed` subscription.
///
/// At most one filter field should be set; all `None` matches every redemption.
/// Constructed via the [`From<TicketSelector>`] impl.
#[derive(cynic::QueryVariables, Default)]
pub struct TicketRedeemedVariables {
    pub channel_id: Option<cynic::Id>,
    pub issuer_address: Option<cynic::Id>,
    pub recipient_address: Option<cynic::Id>,
}

impl From<TicketSelector> for TicketRedeemedVariables {
    fn from(value: TicketSelector) -> Self {
        match value {
            TicketSelector::ChannelId(channel_id) => TicketRedeemedVariables {
                channel_id: Some(channel_id.encode_hex::<String>().into()),
                ..Default::default()
            },
            TicketSelector::IssuerAddress(address) => TicketRedeemedVariables {
                issuer_address: Some(address.encode_hex::<String>().into()),
                ..Default::default()
            },
            TicketSelector::RecipientAddress(address) => TicketRedeemedVariables {
                recipient_address: Some(address.encode_hex::<String>().into()),
                ..Default::default()
            },
            TicketSelector::Any => TicketRedeemedVariables::default(),
        }
    }
}

/// cynic query fragment for the `ticketRedeemed` GraphQL subscription.
///
/// Use [`TicketRedeemedVariables`] to set optional filters before executing.
#[derive(cynic::QueryFragment, Debug)]
#[cynic(graphql_type = "SubscriptionRoot", variables = "TicketRedeemedVariables")]
pub struct SubscribeTicketRedeemed {
    #[arguments(channelId: $channel_id, issuerAddress: $issuer_address, recipientAddress: $recipient_address)]
    pub ticket_redeemed: RedeemTicketDetails,
}

/// Details of a single on-chain ticket redemption event.
///
/// Returned as stream items by [`crate::api::BlokliSubscriptionClient::subscribe_ticket_redeemed`].
/// The `epoch` and `index` fields identify which ticket was redeemed; `result` indicates
/// whether the chain accepted or rejected it.
#[derive(cynic::QueryFragment, Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct RedeemTicketDetails {
    /// Ticket issuer address encoded as a hex string.
    pub issuer_address: String,
    /// Ticket recipient address encoded as a hex string.
    pub recipient_address: String,
    /// Ticket epoch.
    pub epoch: Uint64,
    /// Ticket index within the channel epoch.
    pub index: Uint64,
    /// Redemption outcome reported by the chain.
    pub result: RedemptionResult,
}

/// Outcome of an on-chain ticket redemption attempt.
#[derive(cynic::Enum, Clone, Copy, Debug, PartialEq, Eq)]
pub enum RedemptionResult {
    #[cynic(rename = "REDEEMED")]
    Redeemed,
    #[cynic(rename = "REJECTED")]
    Rejected,
}