iota-sdk 2.0.0-beta.1

The IOTA SDK provides developers with a seamless experience to develop on IOTA by providing account abstractions and clients to interact with node APIs.
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

// Copyright 2022 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

//! IOTA node indexer routes.

use crate::{
    client::{
        node_api::indexer::query_parameters::{
            AccountOutputQueryParameters, AnchorOutputQueryParameters, BasicOutputQueryParameters,
            DelegationOutputQueryParameters, FoundryOutputQueryParameters, NftOutputQueryParameters,
            OutputQueryParameters,
        },
        Client, ClientError,
    },
    types::{
        api::plugins::indexer::OutputIdsResponse,
        block::{
            address::ToBech32Ext,
            output::{AccountId, AnchorId, DelegationId, FoundryId, NftId, OutputId},
        },
    },
};

impl Client {
    /// Get account, anchor, basic, delegation, nft and foundry outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Returns Err(Node(NotFound) if no results are found.
    /// api/indexer/v2/outputs
    pub async fn output_ids(&self, query_parameters: OutputQueryParameters) -> Result<OutputIdsResponse, ClientError> {
        let route = "api/indexer/v2/outputs";

        self.get_output_ids(route, query_parameters, true).await
    }

    /// Get basic outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Returns Err(Node(NotFound) if no results are found.
    /// api/indexer/v2/outputs/basic
    pub async fn basic_output_ids(
        &self,
        query_parameters: BasicOutputQueryParameters,
    ) -> Result<OutputIdsResponse, ClientError> {
        let route = "api/indexer/v2/outputs/basic";

        self.get_output_ids(route, query_parameters, true).await
    }

    /// Get account outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Returns Err(Node(NotFound) if no results are found.
    /// api/indexer/v2/outputs/account
    pub async fn account_output_ids(
        &self,
        query_parameters: AccountOutputQueryParameters,
    ) -> Result<OutputIdsResponse, ClientError> {
        let route = "api/indexer/v2/outputs/account";

        self.get_output_ids(route, query_parameters, true).await
    }

    /// Get account output by its accountID.
    /// api/indexer/v2/outputs/account/{bech32Address}
    pub async fn account_output_id(&self, account_id: AccountId) -> Result<OutputId, ClientError> {
        let bech32_address = account_id.to_bech32(self.get_bech32_hrp().await?);
        let route = format!("api/indexer/v2/outputs/account/{bech32_address}");

        Ok(*(self
            .get_output_ids(&route, AccountOutputQueryParameters::new(), true)
            .await?
            .first()
            .ok_or_else(|| ClientError::NoOutput(format!("{account_id:?}")))?))
    }

    /// Get anchor outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Returns Err(Node(NotFound) if no results are found.
    /// api/indexer/v2/outputs/anchor
    pub async fn anchor_output_ids(
        &self,
        query_parameters: AnchorOutputQueryParameters,
    ) -> Result<OutputIdsResponse, ClientError> {
        let route = "api/indexer/v2/outputs/anchor";

        self.get_output_ids(route, query_parameters, true).await
    }

    /// Get anchor output by its anchorID.
    /// api/indexer/v2/outputs/anchor/{bech32Address}
    pub async fn anchor_output_id(&self, anchor_id: AnchorId) -> Result<OutputId, ClientError> {
        let bech32_address = anchor_id.to_bech32(self.get_bech32_hrp().await?);
        let route = format!("api/indexer/v2/outputs/anchor/{bech32_address}");

        Ok(*(self
            .get_output_ids(&route, AnchorOutputQueryParameters::new(), true)
            .await?
            .first()
            .ok_or_else(|| ClientError::NoOutput(format!("{anchor_id:?}")))?))
    }

    /// Get delegation outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Returns Err(Node(NotFound) if no results are found.
    /// api/indexer/v2/outputs/delegation
    pub async fn delegation_output_ids(
        &self,
        query_parameters: DelegationOutputQueryParameters,
    ) -> Result<OutputIdsResponse, ClientError> {
        let route = "api/indexer/v2/outputs/delegation";

        self.get_output_ids(route, query_parameters, true).await
    }

    /// Get delegation output by its delegationID.
    /// api/indexer/v2/outputs/delegation/:{DelegationId}
    pub async fn delegation_output_id(&self, delegation_id: DelegationId) -> Result<OutputId, ClientError> {
        let route = format!("api/indexer/v2/outputs/delegation/{delegation_id}");

        Ok(*(self
            .get_output_ids(&route, DelegationOutputQueryParameters::new(), true)
            .await?
            .first()
            .ok_or_else(|| ClientError::NoOutput(format!("{delegation_id:?}")))?))
    }

    /// Get foundry outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Returns Err(Node(NotFound) if no results are found.
    /// api/indexer/v2/outputs/foundry
    pub async fn foundry_output_ids(
        &self,
        query_parameters: FoundryOutputQueryParameters,
    ) -> Result<OutputIdsResponse, ClientError> {
        let route = "api/indexer/v2/outputs/foundry";

        self.get_output_ids(route, query_parameters, true).await
    }

    /// Get foundry output by its foundryID.
    /// api/indexer/v2/outputs/foundry/:{FoundryID}
    pub async fn foundry_output_id(&self, foundry_id: FoundryId) -> Result<OutputId, ClientError> {
        let route = format!("api/indexer/v2/outputs/foundry/{foundry_id}");

        Ok(*(self
            .get_output_ids(&route, FoundryOutputQueryParameters::new(), true)
            .await?
            .first()
            .ok_or_else(|| ClientError::NoOutput(format!("{foundry_id:?}")))?))
    }

    /// Get NFT outputs filtered by the given parameters.
    /// Returns Err(Node(NotFound) if no results are found.
    /// api/indexer/v2/outputs/nft
    pub async fn nft_output_ids(
        &self,
        query_parameters: NftOutputQueryParameters,
    ) -> Result<OutputIdsResponse, ClientError> {
        let route = "api/indexer/v2/outputs/nft";

        self.get_output_ids(route, query_parameters, true).await
    }

    /// Get NFT output by its nftID.
    /// api/indexer/v2/outputs/nft/{bech32Address}
    pub async fn nft_output_id(&self, nft_id: NftId) -> Result<OutputId, ClientError> {
        let bech32_address = nft_id.to_bech32(self.get_bech32_hrp().await?);
        let route = format!("api/indexer/v2/outputs/nft/{bech32_address}");

        Ok(*(self
            .get_output_ids(&route, NftOutputQueryParameters::new(), true)
            .await?
            .first()
            .ok_or_else(|| ClientError::NoOutput(format!("{nft_id:?}")))?))
    }
}