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
175
176
177
178
179
180
181
182

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

//! IOTA node indexer routes
use bee_block::output::{AliasId, FoundryId, NftId, OutputId};

use crate::{node_api::indexer::query_parameters::QueryParameter, Client, Error, Result};

// hornet: https://github.com/gohornet/hornet/blob/develop/plugins/indexer/routes.go

macro_rules! verify_query_parameters {
    ($query_parameters:ident, $first:path $(, $rest:path)*) => {
        if let Some(qp) = $query_parameters.iter().find(|qp| {
            !matches!(qp, $first(_) $(| $rest(_))*)
        }) {
            Err(Error::UnsupportedQueryParameter(qp.clone()))
        } else {
            Ok(())
        }
    };
}

impl Client {
    /// Get basic outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Query parameters: "address", "hasStorageDepositReturn", "storageDepositReturnAddress",
    /// "hasExpiration", "expiresBefore", "expiresAfter", "hasTimelock", "timelockedBefore",
    /// "timelockedAfter", "sender", "tag", "createdBefore" and "createdAfter". Returns an empty Vec if no results
    /// are found. api/indexer/v1/outputs/basic
    pub async fn basic_output_ids(&self, query_parameters: Vec<QueryParameter>) -> Result<Vec<OutputId>> {
        let route = "api/indexer/v1/outputs/basic";

        verify_query_parameters!(
            query_parameters,
            QueryParameter::Address,
            QueryParameter::HasNativeTokens,
            QueryParameter::MinNativeTokenCount,
            QueryParameter::MaxNativeTokenCount,
            QueryParameter::HasStorageDepositReturn,
            QueryParameter::StorageDepositReturnAddress,
            QueryParameter::HasTimelock,
            QueryParameter::TimelockedBefore,
            QueryParameter::TimelockedAfter,
            QueryParameter::HasExpiration,
            QueryParameter::ExpiresBefore,
            QueryParameter::ExpiresAfter,
            QueryParameter::ExpirationReturnAddress,
            QueryParameter::Sender,
            QueryParameter::Tag,
            QueryParameter::CreatedBefore,
            QueryParameter::CreatedAfter,
            QueryParameter::PageSize,
            QueryParameter::Cursor
        )?;

        self.get_output_ids_with_pagination(route, query_parameters, true, false)
            .await
    }

    /// Get alias outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Query parameters: "stateController", "governor", "issuer", "sender", "createdBefore", "createdAfter"
    /// Returns an empty list if no results are found.
    /// api/indexer/v1/outputs/alias
    pub async fn alias_output_ids(&self, query_parameters: Vec<QueryParameter>) -> Result<Vec<OutputId>> {
        let route = "api/indexer/v1/outputs/alias";

        verify_query_parameters!(
            query_parameters,
            QueryParameter::StateController,
            QueryParameter::Governor,
            QueryParameter::Issuer,
            QueryParameter::Sender,
            QueryParameter::HasNativeTokens,
            QueryParameter::MinNativeTokenCount,
            QueryParameter::MaxNativeTokenCount,
            QueryParameter::CreatedBefore,
            QueryParameter::CreatedAfter,
            QueryParameter::PageSize,
            QueryParameter::Cursor
        )?;

        self.get_output_ids_with_pagination(route, query_parameters, true, false)
            .await
    }

    /// Get alias output by its aliasID.
    /// api/indexer/v1/outputs/alias/:{AliasId}
    pub async fn alias_output_id(&self, alias_id: AliasId) -> Result<OutputId> {
        let route = format!("api/indexer/v1/outputs/alias/{alias_id}");

        Ok(*(self
            .get_output_ids_with_pagination(&route, Vec::new(), true, false)
            .await?
            .first()
            .ok_or_else(|| crate::Error::NodeError("no output id for alias".to_string()))?))
    }

    /// Get foundry outputs filtered by the given parameters.
    /// GET with query parameter returns all outputIDs that fit these filter criteria.
    /// Query parameters: "address", "createdBefore", "createdAfter"
    /// Returns an empty list if no results are found.
    /// api/indexer/v1/outputs/foundry
    pub async fn foundry_output_ids(&self, query_parameters: Vec<QueryParameter>) -> Result<Vec<OutputId>> {
        let route = "api/indexer/v1/outputs/foundry";

        verify_query_parameters!(
            query_parameters,
            QueryParameter::AliasAddress,
            QueryParameter::HasNativeTokens,
            QueryParameter::MinNativeTokenCount,
            QueryParameter::MaxNativeTokenCount,
            QueryParameter::CreatedBefore,
            QueryParameter::CreatedAfter,
            QueryParameter::PageSize,
            QueryParameter::Cursor
        )?;

        self.get_output_ids_with_pagination(route, query_parameters, true, false)
            .await
    }

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

        Ok(*(self
            .get_output_ids_with_pagination(&route, Vec::new(), true, false)
            .await?
            .first()
            .ok_or_else(|| crate::Error::NodeError("no output id for foundry".to_string()))?))
    }

    /// Get NFT outputs filtered by the given parameters.
    /// Query parameters: "address", "hasStorageDepositReturn", "storageDepositReturnAddress",
    /// "hasExpiration", "expiresBefore", "expiresAfter", "hasTimelock", "timelockedBefore",
    /// "timelockedAfter", "issuer", "sender", "tag", "createdBefore", "createdAfter"
    /// Returns an empty list if no results are found.
    /// api/indexer/v1/outputs/nft
    pub async fn nft_output_ids(&self, query_parameters: Vec<QueryParameter>) -> Result<Vec<OutputId>> {
        let route = "api/indexer/v1/outputs/nft";

        verify_query_parameters!(
            query_parameters,
            QueryParameter::Address,
            QueryParameter::HasNativeTokens,
            QueryParameter::MinNativeTokenCount,
            QueryParameter::MaxNativeTokenCount,
            QueryParameter::HasStorageDepositReturn,
            QueryParameter::StorageDepositReturnAddress,
            QueryParameter::HasTimelock,
            QueryParameter::TimelockedBefore,
            QueryParameter::TimelockedAfter,
            QueryParameter::HasExpiration,
            QueryParameter::ExpiresBefore,
            QueryParameter::ExpiresAfter,
            QueryParameter::ExpirationReturnAddress,
            QueryParameter::Sender,
            QueryParameter::Tag,
            QueryParameter::CreatedBefore,
            QueryParameter::CreatedAfter,
            QueryParameter::PageSize,
            QueryParameter::Cursor
        )?;

        self.get_output_ids_with_pagination(route, query_parameters, true, false)
            .await
    }

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

        Ok(*(self
            .get_output_ids_with_pagination(&route, Vec::new(), true, false)
            .await?
            .first()
            .ok_or_else(|| crate::Error::NodeError("no output id for nft".to_string()))?))
    }
}