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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
use std::sync::Arc;
use celestia_rpc::ShareClient;
use crate::Result;
use crate::api::share::{GetRangeResponse, GetRowResponse, SampleCoordinates};
use crate::client::ClientInner;
use crate::types::namespace_data::NamespaceData;
use crate::types::nmt::Namespace;
use crate::types::sample::Sample;
use crate::types::{ExtendedDataSquare, Share};
/// Share API for quering bridge nodes.
pub struct ShareApi {
inner: Arc<ClientInner>,
}
impl ShareApi {
pub(crate) fn new(inner: Arc<ClientInner>) -> ShareApi {
ShareApi { inner }
}
/// Performs a subjective validation to check if the shares committed to the
/// header at the specified height are available and retrievable from the network.
///
/// Returns `Ok(())` if shares are available.
pub async fn shares_available(&self, height: u64) -> Result<()> {
Ok(self.inner.rpc.share_shares_available(height).await?)
}
/// Retrieves a specific share from the [`ExtendedDataSquare`] at the given
/// height using its row and column coordinates.
pub async fn get(
&self,
height: u64,
square_width: u16,
row: u16,
column: u16,
) -> Result<Share> {
Ok(self
.inner
.rpc
.share_get_share(height, square_width, row, column)
.await?)
}
/// Retrieves a specific share from the [`ExtendedDataSquare`] at the given
/// height using its row and column coordinates.
///
/// # NOTE
///
/// This method will first fetch and validate the header at a given height and
/// then use it to provide necessary data for validation and post-processing.
///
/// If you already have access to the necessary data, it is recommended to use
/// the equivalent method without the `_with_root` suffix.
pub async fn get_with_root(&self, height: u64, row: u16, column: u16) -> Result<Share> {
let header = self.inner.get_header_validated(height).await?;
Ok(self
.inner
.rpc
.share_get_share(header.height(), header.square_width(), row, column)
.await?)
}
/// Retrieves multiple shares from the [`ExtendedDataSquare`] at the given
/// sample coordinates.
///
/// `coordinates` is a list of `(row, column)`.
pub async fn get_samples<I, C>(&self, height: u64, coordinates: I) -> Result<Vec<Sample>>
where
I: IntoIterator<Item = C>,
C: Into<SampleCoordinates>,
{
Ok(self
.inner
.rpc
.share_get_samples(height, coordinates)
.await?)
}
/// Retrieves multiple shares from the [`ExtendedDataSquare`] at the given
/// sample coordinates.
///
/// `coordinates` is a list of `(row, column)`.
///
/// # NOTE
///
/// This method will first fetch and validate the header at a given height and
/// then use it to provide necessary data for validation and post-processing.
///
/// If you already have access to the necessary data, it is recommended to use
/// the equivalent method without the `_with_root` suffix.
pub async fn get_samples_with_root<I, C>(
&self,
height: u64,
coordinates: I,
) -> Result<Vec<Sample>>
where
I: IntoIterator<Item = C>,
C: Into<SampleCoordinates>,
{
let header = self.inner.get_header_validated(height).await?;
Ok(self
.inner
.rpc
.share_get_samples(header.height(), coordinates)
.await?)
}
/// Retrieves the complete [`ExtendedDataSquare`] for the specified height.
pub async fn get_eds(&self, height: u64) -> Result<ExtendedDataSquare> {
Ok(self.inner.rpc.share_get_eds(height).await?)
}
/// Retrieves the complete [`ExtendedDataSquare`] for the specified height.
///
/// # NOTE
///
/// This method will first fetch and validate the header at a given height and
/// then use it to provide necessary data for validation and post-processing.
///
/// If you already have access to the necessary data, it is recommended to use
/// the equivalent method without the `_with_root` suffix.
pub async fn get_eds_with_root(&self, height: u64) -> Result<ExtendedDataSquare> {
let header = self.inner.get_header_validated(height).await?;
Ok(self.inner.rpc.share_get_eds(header.height()).await?)
}
/// Retrieves all shares from a specific row of the [`ExtendedDataSquare`]
/// at the given height.
pub async fn get_row(
&self,
height: u64,
square_width: u16,
row: u16,
) -> Result<GetRowResponse> {
Ok(self
.inner
.rpc
.share_get_row(height, square_width, row)
.await?)
}
/// Retrieves all shares from a specific row of the [`ExtendedDataSquare`]
/// at the given height.
///
/// # NOTE
///
/// This method will first fetch and validate the header at a given height and
/// then use it to provide necessary data for validation and post-processing.
///
/// If you already have access to the necessary data, it is recommended to use
/// the equivalent method without the `_with_root` suffix.
pub async fn get_row_with_root(&self, height: u64, row: u16) -> Result<GetRowResponse> {
let header = self.inner.get_header_validated(height).await?;
Ok(self
.inner
.rpc
.share_get_row(header.height(), header.square_width(), row)
.await?)
}
/// Retrieves all shares that belong to the specified namespace within the
/// [`ExtendedDataSquare`] at the given height.
///
/// The shares are returned in a row-by-row order, maintaining the original
/// layout if the namespace spans multiple rows.
pub async fn get_namespace_data(
&self,
height: u64,
namespace: Namespace,
) -> Result<NamespaceData> {
Ok(self
.inner
.rpc
.share_get_namespace_data(height, namespace)
.await?)
}
/// Retrieves all shares that belong to the specified namespace within the
/// [`ExtendedDataSquare`] at the given height.
///
/// The shares are returned in a row-by-row order, maintaining the original
/// layout if the namespace spans multiple rows.
///
/// # NOTE
///
/// This method will first fetch and validate the header at a given height and
/// then use it to provide necessary data for validation and post-processing.
///
/// If you already have access to the necessary data, it is recommended to use
/// the equivalent method without the `_with_root` suffix.
pub async fn get_namespace_data_with_root(
&self,
height: u64,
namespace: Namespace,
) -> Result<NamespaceData> {
let header = self.inner.get_header_validated(height).await?;
Ok(self
.inner
.rpc
.share_get_namespace_data(header.height(), namespace)
.await?)
}
/// Retrieves a list of shares and their corresponding proof.
///
/// The start and end index ignores parity shares and corresponds to ODS.
pub async fn get_range(&self, height: u64, start: u64, end: u64) -> Result<GetRangeResponse> {
Ok(self.inner.rpc.share_get_range(height, start, end).await?)
}
/// Retrieves a list of shares and their corresponding proof.
///
/// The start and end index ignores parity shares and corresponds to ODS.
///
/// # NOTE
///
/// This method will first fetch and validate the header at a given height and
/// then use it to provide necessary data for validation and post-processing.
///
/// If you already have access to the necessary data, it is recommended to use
/// the equivalent method without the `_with_root` suffix.
pub async fn get_range_with_root(
&self,
height: u64,
start: u64,
end: u64,
) -> Result<GetRangeResponse> {
let header = self.inner.get_header_validated(height).await?;
Ok(self
.inner
.rpc
.share_get_range(header.height(), start, end)
.await?)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::test_utils::{ensure_serializable, ensure_serializable_deserializable};
#[allow(dead_code)]
#[allow(unused_variables)]
#[allow(unreachable_code)]
#[allow(clippy::diverging_sub_expression)]
async fn enforce_serde_bounds() {
// intentionally no-run, compile only test
let api = ShareApi::new(unimplemented!());
let _: () = api.shares_available(0).await.unwrap();
let coordinates: Vec<SampleCoordinates> =
ensure_serializable_deserializable(unimplemented!());
ensure_serializable(api.get_samples(0, coordinates).await.unwrap());
ensure_serializable(api.get_eds(0).await.unwrap());
ensure_serializable_deserializable(api.get(0, 0, 0, 0).await.unwrap());
ensure_serializable_deserializable(api.get_row(0, 0, 0).await.unwrap());
let namespace = ensure_serializable_deserializable(unimplemented!());
ensure_serializable_deserializable(api.get_namespace_data(0, namespace).await.unwrap());
ensure_serializable_deserializable(api.get_range(0, 0, 0).await.unwrap());
}
}