regit-web3 1.0.1

Modular Web3 primitives for exact values, chain and provider reads, swap quotes, and transaction preparation
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
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 Regit

use super::{Currency, HistoryRequest, MarketsRequest, PricesRequest, SearchQuery};
use crate::{
    domain::{
        Timestamp,
        market::{Identifier, Label, NonnegativeDecimal, UnixMilliseconds, UtcDateTime, unique},
    },
    error::{Error, ValidationError},
};
use serde::{Deserialize, Serialize};

/// Price availability for one explicitly requested ID/currency pair.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(tag = "status", content = "value", rename_all = "snake_case")]
pub enum PriceAvailability {
    /// The provider supplied an exact nonnegative price.
    Present(NonnegativeDecimal),
    /// The provider explicitly supplied null for this price.
    NotReported,
    /// The requested listing ID was absent from the response.
    AssetUnavailable,
    /// The listing existed but the requested currency field was absent.
    CurrencyUnavailable,
}

/// A search candidate with provider ID and separate display metadata.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct SearchCoin {
    id: Identifier,
    name: Label,
    symbol: Label,

    #[serde(deserialize_with = "crate::domain::deserialize_optional")]
    market_cap_rank: Option<u64>,
}
impl SearchCoin {
    /// Records explicitly supplied validated field values.
    #[must_use]
    pub const fn new(
        id: Identifier,
        name: Label,
        symbol: Label,
        market_cap_rank: Option<u64>,
    ) -> Self {
        Self {
            id,
            name,
            symbol,
            market_cap_rank,
        }
    }
    /// `CoinGecko` listing ID.
    #[must_use]
    pub const fn id(&self) -> &Identifier {
        &self.id
    }
    /// Provider display name.
    #[must_use]
    pub const fn name(&self) -> &Label {
        &self.name
    }
    /// Provider display symbol; not an identity.
    #[must_use]
    pub const fn symbol(&self) -> &Label {
        &self.symbol
    }
    /// Explicit optional provider market-cap rank.
    #[must_use]
    pub const fn market_cap_rank(&self) -> &Option<u64> {
        &self.market_cap_rank
    }
}

/// One requested listing/currency pair with explicit data availability.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PriceQuote {
    id: Identifier,
    currency: Currency,
    availability: PriceAvailability,

    #[serde(deserialize_with = "crate::domain::deserialize_optional")]
    last_updated_at: Option<Timestamp>,
}
impl PriceQuote {
    /// Records explicitly supplied validated field values.
    #[must_use]
    pub const fn new(
        id: Identifier,
        currency: Currency,
        availability: PriceAvailability,
        last_updated_at: Option<Timestamp>,
    ) -> Self {
        Self {
            id,
            currency,
            availability,
            last_updated_at,
        }
    }
    /// Requested listing ID.
    #[must_use]
    pub const fn id(&self) -> &Identifier {
        &self.id
    }
    /// Requested quote currency.
    #[must_use]
    pub const fn currency(&self) -> &Currency {
        &self.currency
    }
    /// Value or explicit missing/null availability.
    #[must_use]
    pub const fn availability(&self) -> &PriceAvailability {
        &self.availability
    }
    /// Provider data time in Unix seconds, if supplied.
    #[must_use]
    pub const fn last_updated_at(&self) -> &Option<Timestamp> {
        &self.last_updated_at
    }
}

/// An exact market record; currency applies to price, capitalization and volume.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct CoinMarket {
    id: Identifier,
    name: Label,
    symbol: Label,
    currency: Currency,
    values: MarketValues,

    #[serde(deserialize_with = "crate::domain::deserialize_optional")]
    market_cap_rank: Option<u64>,

    #[serde(deserialize_with = "crate::domain::deserialize_optional")]
    last_updated: Option<UtcDateTime>,
}
impl CoinMarket {
    /// Records explicitly supplied validated field values.
    #[must_use]
    pub const fn new(
        id: Identifier,
        name: Label,
        symbol: Label,
        currency: Currency,
        values: MarketValues,
        market_cap_rank: Option<u64>,
        last_updated: Option<UtcDateTime>,
    ) -> Self {
        Self {
            id,
            name,
            symbol,
            currency,
            values,
            market_cap_rank,
            last_updated,
        }
    }
    /// Listing ID.
    #[must_use]
    pub const fn id(&self) -> &Identifier {
        &self.id
    }
    /// Display name.
    #[must_use]
    pub const fn name(&self) -> &Label {
        &self.name
    }
    /// Display symbol.
    #[must_use]
    pub const fn symbol(&self) -> &Label {
        &self.symbol
    }
    /// Explicit quote currency.
    #[must_use]
    pub const fn currency(&self) -> &Currency {
        &self.currency
    }
    /// Reported price; null remains absent.
    #[must_use]
    pub const fn current_price(&self) -> &Option<NonnegativeDecimal> {
        self.values.current_price()
    }
    /// Reported capitalization in the quote currency.
    #[must_use]
    pub const fn market_cap(&self) -> &Option<NonnegativeDecimal> {
        self.values.market_cap()
    }
    /// Reported 24-hour volume in the quote currency.
    #[must_use]
    pub const fn total_volume(&self) -> &Option<NonnegativeDecimal> {
        self.values.total_volume()
    }
    /// Provider rank, without an inferred value.
    #[must_use]
    pub const fn market_cap_rank(&self) -> &Option<u64> {
        &self.market_cap_rank
    }
    /// Provider UTC data timestamp; null remains absent.
    #[must_use]
    pub const fn last_updated(&self) -> &Option<UtcDateTime> {
        &self.last_updated
    }
}

/// One exact nonnegative sample at explicit Unix milliseconds.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ChartPoint {
    timestamp: UnixMilliseconds,
    value: NonnegativeDecimal,
}
impl ChartPoint {
    /// Records explicitly supplied validated field values.
    #[must_use]
    pub const fn new(timestamp: UnixMilliseconds, value: NonnegativeDecimal) -> Self {
        Self { timestamp, value }
    }
    /// Provider time in Unix milliseconds.
    #[must_use]
    pub const fn timestamp(&self) -> &UnixMilliseconds {
        &self.timestamp
    }
    /// Exact sampled value, in the enclosing series currency.
    #[must_use]
    pub const fn value(&self) -> &NonnegativeDecimal {
        &self.value
    }
}

/// Search candidates returned for one exact term; no candidate is selected.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(try_from = "SearchFields")]
pub struct SearchResults {
    query: SearchQuery,
    coins: Vec<SearchCoin>,
}
impl SearchResults {
    /// Requires a bounded candidate list without duplicate listing IDs.
    /// # Errors
    /// Rejects more than 100,000 candidates or duplicate IDs.
    pub fn new(query: SearchQuery, coins: Vec<SearchCoin>) -> Result<Self, Error> {
        if coins.len() > 100_000 || !unique(coins.iter().map(SearchCoin::id)) {
            return Err(ValidationError::InvalidMarketRecord.into());
        }
        Ok(Self { query, coins })
    }
    /// Returns the requested term.
    #[must_use]
    pub const fn query(&self) -> &SearchQuery {
        &self.query
    }
    /// Returns every returned candidate, in provider order.
    #[must_use]
    pub fn coins(&self) -> &[SearchCoin] {
        &self.coins
    }
}
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct SearchFields {
    query: SearchQuery,
    coins: Vec<SearchCoin>,
}
impl TryFrom<SearchFields> for SearchResults {
    type Error = Error;
    fn try_from(v: SearchFields) -> Result<Self, Error> {
        Self::new(v.query, v.coins)
    }
}

/// Exact prices for every requested ID/currency pair, including missing values.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(try_from = "PriceFields")]
pub struct Prices {
    request: PricesRequest,
    quotes: Vec<PriceQuote>,
}
impl Prices {
    /// Requires exactly one quote per requested pair in caller matrix order.
    /// # Errors
    /// Rejects missing, extra, reordered or mismatched quote identities.
    pub fn new(request: PricesRequest, quotes: Vec<PriceQuote>) -> Result<Self, Error> {
        if quotes.len() != request.ids().len() * request.currencies().len()
            || request
                .ids()
                .iter()
                .flat_map(|id| {
                    request
                        .currencies()
                        .iter()
                        .map(move |currency| (id, currency))
                })
                .zip(&quotes)
                .any(|((id, currency), q)| id != q.id() || currency != q.currency())
        {
            return Err(ValidationError::InvalidMarketRecord.into());
        }
        Ok(Self { request, quotes })
    }
    /// Returns the exact request matrix.
    #[must_use]
    pub const fn request(&self) -> &PricesRequest {
        &self.request
    }
    /// Returns quotes in requested ID/currency matrix order.
    #[must_use]
    pub fn quotes(&self) -> &[PriceQuote] {
        &self.quotes
    }
}
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct PriceFields {
    request: PricesRequest,
    quotes: Vec<PriceQuote>,
}
impl TryFrom<PriceFields> for Prices {
    type Error = Error;
    fn try_from(v: PriceFields) -> Result<Self, Error> {
        Self::new(v.request, v.quotes)
    }
}

/// Honest page-size information, without an inferred exhaustive catalogue.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum PageStatus {
    /// Fewer records than requested were returned for this operation.
    ShortPage,
    /// A full page was returned, so more records may exist.
    MayHaveMore,
}
/// One explicit markets page; no additional pages are collected implicitly.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(try_from = "MarketsPageFields")]
pub struct MarketsPage {
    request: MarketsRequest,
    coins: Vec<CoinMarket>,
}
impl MarketsPage {
    /// Checks page count, listing uniqueness, selected IDs and quote currencies.
    /// # Errors
    /// Rejects a record outside the requested page contract.
    pub fn new(request: MarketsRequest, coins: Vec<CoinMarket>) -> Result<Self, Error> {
        if coins.len() > usize::from(request.count())
            || !unique(coins.iter().map(CoinMarket::id))
            || coins.iter().any(|v| {
                v.currency() != request.currency()
                    || request.ids().is_some_and(|ids| !ids.contains(v.id()))
            })
        {
            return Err(ValidationError::InvalidMarketRecord.into());
        }
        Ok(Self { request, coins })
    }
    /// Returns the original page request.
    #[must_use]
    pub const fn request(&self) -> &MarketsRequest {
        &self.request
    }
    /// Returns provider records in returned order.
    #[must_use]
    pub fn coins(&self) -> &[CoinMarket] {
        &self.coins
    }
    /// Returns observed page-size information without predicting future pages.
    #[must_use]
    pub fn status(&self) -> PageStatus {
        if self.coins.len() == usize::from(self.request.count()) {
            PageStatus::MayHaveMore
        } else {
            PageStatus::ShortPage
        }
    }
}
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct MarketsPageFields {
    request: MarketsRequest,
    coins: Vec<CoinMarket>,
}
impl TryFrom<MarketsPageFields> for MarketsPage {
    type Error = Error;
    fn try_from(v: MarketsPageFields) -> Result<Self, Error> {
        Self::new(v.request, v.coins)
    }
}

/// Independent exact price, capitalization and 24-hour-volume historical series.
/// Timestamps are not artificially aligned across the three provider series.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(try_from = "HistoryFields")]
pub struct HistoricalChart {
    request: HistoryRequest,
    prices: Vec<ChartPoint>,
    market_caps: Vec<ChartPoint>,
    total_volumes: Vec<ChartPoint>,
}
impl HistoricalChart {
    /// Requires bounded, strictly increasing samples inside the requested range.
    /// # Errors
    /// Rejects excessive, repeated, reordered or out-of-range data times.
    pub fn new(
        request: HistoryRequest,
        prices: Vec<ChartPoint>,
        market_caps: Vec<ChartPoint>,
        total_volumes: Vec<ChartPoint>,
    ) -> Result<Self, Error> {
        let from = request.from_unix_seconds() * 1000;
        let to = request.to_unix_seconds() * 1000;
        if [&prices, &market_caps, &total_volumes].iter().any(|v| {
            v.len() > 100_000
                || v.iter()
                    .any(|p| !(from..=to).contains(&p.timestamp().get()))
                || v.windows(2).any(|p| p[0].timestamp() >= p[1].timestamp())
        }) {
            return Err(ValidationError::InvalidMarketRecord.into());
        }
        Ok(Self {
            request,
            prices,
            market_caps,
            total_volumes,
        })
    }
    /// Returns ID, currency and requested range in Unix seconds.
    #[must_use]
    pub const fn request(&self) -> &HistoryRequest {
        &self.request
    }
    /// Returns exact prices in quote currency, at provider Unix milliseconds.
    #[must_use]
    pub fn prices(&self) -> &[ChartPoint] {
        &self.prices
    }
    /// Returns market capitalization in the explicit quote currency.
    #[must_use]
    pub fn market_caps(&self) -> &[ChartPoint] {
        &self.market_caps
    }
    /// Returns 24-hour trading volume in the explicit quote currency.
    #[must_use]
    pub fn total_volumes(&self) -> &[ChartPoint] {
        &self.total_volumes
    }
}
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct HistoryFields {
    request: HistoryRequest,
    prices: Vec<ChartPoint>,
    market_caps: Vec<ChartPoint>,
    total_volumes: Vec<ChartPoint>,
}
impl TryFrom<HistoryFields> for HistoricalChart {
    type Error = Error;
    fn try_from(v: HistoryFields) -> Result<Self, Error> {
        Self::new(v.request, v.prices, v.market_caps, v.total_volumes)
    }
}

/// Related price, capitalization and trading-volume values in one quote currency.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct MarketValues {
    #[serde(deserialize_with = "crate::domain::deserialize_optional")]
    current_price: Option<NonnegativeDecimal>,

    #[serde(deserialize_with = "crate::domain::deserialize_optional")]
    market_cap: Option<NonnegativeDecimal>,

    #[serde(deserialize_with = "crate::domain::deserialize_optional")]
    total_volume: Option<NonnegativeDecimal>,
}
impl MarketValues {
    /// Records explicitly reported values; null remains distinct from zero.
    #[must_use]
    pub const fn new(
        current_price: Option<NonnegativeDecimal>,
        market_cap: Option<NonnegativeDecimal>,
        total_volume: Option<NonnegativeDecimal>,
    ) -> Self {
        Self {
            current_price,
            market_cap,
            total_volume,
        }
    }
    /// Returns reported price in quote currency.
    #[must_use]
    pub const fn current_price(&self) -> &Option<NonnegativeDecimal> {
        &self.current_price
    }
    /// Returns reported capitalization in quote currency.
    #[must_use]
    pub const fn market_cap(&self) -> &Option<NonnegativeDecimal> {
        &self.market_cap
    }
    /// Returns reported 24-hour trading volume in quote currency.
    #[must_use]
    pub const fn total_volume(&self) -> &Option<NonnegativeDecimal> {
        &self.total_volume
    }
}