gadget-sdk 0.6.2

SDK for building Blueprints and gadget on Tangle Network
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use std::future::Future;
use tangle_subxt::tangle_testnet_runtime::api::runtime_types::tangle_primitives::services::{Service, ServiceBlueprint};
use tangle_subxt::tangle_testnet_runtime::api::runtime_types::sp_arithmetic::per_things::Percent;
use tangle_subxt::tangle_testnet_runtime::api::runtime_types::pallet_multi_asset_delegation::types::operator::OperatorMetadata;
use tangle_subxt::tangle_testnet_runtime::api::assets::events::burned::Balance;
use tangle_subxt::tangle_testnet_runtime::api::assets::events::accounts_destroyed::AssetId;
use tangle_subxt::tangle_testnet_runtime::api::runtime_types::tangle_testnet_runtime::{MaxDelegations, MaxDelegatorBlueprints, MaxOperatorBlueprints, MaxUnstakeRequests, MaxWithdrawRequests};
use tangle_subxt::tangle_testnet_runtime::api::system::storage::types::number::Number;
use tangle_subxt::tangle_testnet_runtime::api::runtime_types::pallet_multi_asset_delegation::types::delegator::DelegatorMetadata;

/// `ServicesContext` trait provides access to the current service and current blueprint from the context.
#[allow(clippy::type_complexity)]
pub trait ServicesContext {
    type Config: subxt::Config;
    /// Get the current blueprint information from the context.
    fn current_blueprint(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
    ) -> impl Future<Output = color_eyre::Result<ServiceBlueprint, subxt::Error>>;

    /// Query the current blueprint owner from the context.
    fn current_blueprint_owner(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
    ) -> impl Future<Output = color_eyre::Result<subxt::utils::AccountId32, subxt::Error>>;

    /// Get the current service operators with their restake exposure  from the context.
    /// This function will return a list of service operators that are selected to run this service
    /// instance.
    fn current_service_operators(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
    ) -> impl Future<Output = color_eyre::Result<Vec<(subxt::utils::AccountId32, Percent)>, subxt::Error>>;

    #[allow(clippy::type_complexity)]
    /// Get metadata for a list of operators from the context.
    fn operators_metadata(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
        operators: Vec<subxt::utils::AccountId32>,
    ) -> impl Future<
        Output = color_eyre::Result<
            Vec<(
                subxt::utils::AccountId32,
                OperatorMetadata<
                    subxt::utils::AccountId32,
                    Balance,
                    AssetId,
                    MaxDelegations,
                    MaxOperatorBlueprints,
                >,
            )>,
            subxt::Error,
        >,
    >;

    /// Get metadata for a single operator from the context.
    /// This function will return the metadata for a single operator.
    fn operator_metadata(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
        operator: subxt::utils::AccountId32,
    ) -> impl Future<
        Output = color_eyre::Result<
            Option<
                OperatorMetadata<
                    subxt::utils::AccountId32,
                    Balance,
                    AssetId,
                    MaxDelegations,
                    MaxOperatorBlueprints,
                >,
            >,
            subxt::Error,
        >,
    >;

    /// Get the current service instance from the context.
    fn service_instance(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
    ) -> impl Future<
        Output = color_eyre::Result<
            Service<subxt::utils::AccountId32, Number, AssetId>,
            subxt::Error,
        >,
    >;

    #[allow(clippy::type_complexity)]
    /// Get delegations for a list of operators from the context.
    fn operator_delegations(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
        operators: Vec<subxt::utils::AccountId32>,
    ) -> impl Future<
        Output = color_eyre::Result<
            Vec<(
                subxt::utils::AccountId32, // operator
                Option<
                    DelegatorMetadata<
                        subxt::utils::AccountId32,
                        AssetId,
                        Balance,
                        MaxWithdrawRequests,
                        MaxDelegations,
                        MaxUnstakeRequests,
                        MaxDelegatorBlueprints,
                    >,
                >,
            )>,
            subxt::Error,
        >,
    >;

    /// Get delegations for a single operator from the context.
    fn operator_delegation(
        &self,
        client: &subxt::OnlineClient<Self::Config>,
        operator: subxt::utils::AccountId32,
    ) -> impl Future<
        Output = color_eyre::Result<
            Option<
                DelegatorMetadata<
                    subxt::utils::AccountId32,
                    AssetId,
                    Balance,
                    MaxWithdrawRequests,
                    MaxDelegations,
                    MaxUnstakeRequests,
                    MaxDelegatorBlueprints,
                >,
            >,
            subxt::Error,
        >,
    >;
}