chio-link 0.1.2

Oracle runtime for Chio cross-currency budget enforcement
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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
use alloy_json_rpc::{RequestPacket, ResponsePacket};
use alloy_primitives::Address;
use alloy_provider::{Provider, ProviderBuilder};
use alloy_rpc_client::ClientBuilder as AlloyClientBuilder;
use alloy_sol_types::sol;
use alloy_transport::{TransportError, TransportErrorKind, TransportFut};
use chio_egress_contract::{client_builder_with_contract, send_with_contract, HttpEgressContract};
use reqwest::{Client, Url};
use std::task;
use tower::Service;

use crate::config::{ChainlinkFeedConfig, ChainlinkNetworkConfig, PairConfig};
use crate::{ExchangeRate, OracleBackend, OracleBackendKind, OracleFuture, PriceOracleError};

sol! {
    #[sol(rpc)]
    contract AggregatorV3Interface {
        function latestRoundData() external view returns (
            uint80 roundId,
            int256 answer,
            uint256 startedAt,
            uint256 updatedAt,
            uint80 answeredInRound
        );
        function decimals() external view returns (uint8 decimalsValue);
    }
}

#[derive(Clone, Debug)]
pub(crate) struct ContractJsonRpcTransport {
    url: Url,
    http_client: Client,
    egress_contract: HttpEgressContract,
}

impl ContractJsonRpcTransport {
    fn new(url: Url, egress_contract: &HttpEgressContract) -> Result<Self, PriceOracleError> {
        // Policy check only; the pinned ContractDnsResolver on the client built
        // below enforces hostname address-class at connect, so this does not
        // resolve DNS here (a config-time lookup would be redundant + offline-fragile).
        egress_contract
            .enforce_url(url.as_str(), 0)
            .map_err(|err| {
                PriceOracleError::InvalidConfiguration(format!(
                    "HttpEgressContract rejects JSON-RPC endpoint: {err}"
                ))
            })?;
        let http_client = client_builder_with_contract(egress_contract)
            .build()
            .map_err(|err| {
                PriceOracleError::Unavailable(format!(
                    "building contract-backed JSON-RPC client failed: {err}"
                ))
            })?;
        Ok(Self {
            url,
            http_client,
            egress_contract: egress_contract.clone(),
        })
    }

    async fn send_json_rpc(self, req: RequestPacket) -> Result<ResponsePacket, TransportError> {
        let request = self
            .http_client
            .post(self.url.clone())
            .json(&req)
            .headers(req.headers())
            .build()
            .map_err(TransportErrorKind::custom)?;
        let response = send_with_contract(&self.egress_contract, &self.http_client, request)
            .await
            .map_err(TransportErrorKind::custom)?;
        let status = response.status();
        let body = response.body();
        if !status.is_success() {
            return Err(TransportErrorKind::http_error(
                status.as_u16(),
                String::from_utf8_lossy(body).into_owned(),
            ));
        }
        serde_json::from_slice(body)
            .map_err(|err| TransportError::deser_err(err, String::from_utf8_lossy(body)))
    }
}

impl Service<RequestPacket> for ContractJsonRpcTransport {
    type Response = ResponsePacket;
    type Error = TransportError;
    type Future = TransportFut<'static>;

    fn poll_ready(&mut self, _cx: &mut task::Context<'_>) -> task::Poll<Result<(), Self::Error>> {
        task::Poll::Ready(Ok(()))
    }

    fn call(&mut self, req: RequestPacket) -> Self::Future {
        let transport = self.clone();
        Box::pin(async move { transport.send_json_rpc(req).await })
    }
}

pub(crate) fn contract_backed_provider(
    url: Url,
    egress_contract: &HttpEgressContract,
) -> Result<impl Provider, PriceOracleError> {
    let is_local = rpc_url_is_local(&url);
    let transport = ContractJsonRpcTransport::new(url, egress_contract)?;
    let client = AlloyClientBuilder::default().transport(transport, is_local);
    Ok(ProviderBuilder::new().connect_client(client))
}

fn rpc_url_is_local(url: &Url) -> bool {
    matches!(
        url.host_str(),
        Some("localhost" | "localhost.localdomain" | "127.0.0.1" | "::1")
    )
}

#[derive(Debug)]
pub struct ChainlinkFeedReader {
    networks: Vec<ChainlinkNetworkConfig>,
    egress_contract: HttpEgressContract,
}

impl ChainlinkFeedReader {
    /// Construct a [`ChainlinkFeedReader`] that enforces the supplied
    /// [`HttpEgressContract`] on every RPC endpoint URL before any HTTP
    /// connect through `alloy`. The contract is required: the typed
    /// egress gate is the only thing standing between substrate
    /// dispatches and unconstrained RPC URLs.
    #[must_use]
    pub fn new(networks: Vec<ChainlinkNetworkConfig>, egress_contract: HttpEgressContract) -> Self {
        Self {
            networks,
            egress_contract,
        }
    }

    pub fn try_new(
        networks: Vec<ChainlinkNetworkConfig>,
        egress_contract: HttpEgressContract,
    ) -> Result<Self, PriceOracleError> {
        egress_contract
            .validate_dispatchable_with_pinned_dns()
            .map_err(|err| {
                PriceOracleError::InvalidConfiguration(format!(
                    "Chainlink HttpEgressContract is not dispatchable with pinned DNS: {err}"
                ))
            })?;
        Ok(Self::new(networks, egress_contract))
    }

    /// Alias for [`ChainlinkFeedReader::new`].
    #[must_use]
    pub fn with_contract(
        networks: Vec<ChainlinkNetworkConfig>,
        egress_contract: HttpEgressContract,
    ) -> Self {
        Self::new(networks, egress_contract)
    }

    fn network_for_pair(
        &self,
        pair: &PairConfig,
    ) -> Result<&ChainlinkNetworkConfig, PriceOracleError> {
        self.networks
            .iter()
            .find(|network| network.chain_id == pair.chain_id)
            .ok_or_else(|| {
                PriceOracleError::InvalidConfiguration(format!(
                    "no Chainlink network is configured for {} chain_id {}",
                    pair.pair(),
                    pair.chain_id
                ))
            })
    }
}

impl OracleBackend for ChainlinkFeedReader {
    fn kind(&self) -> OracleBackendKind {
        OracleBackendKind::Chainlink
    }

    fn read_rate<'a>(&'a self, pair: &'a PairConfig, now: u64) -> OracleFuture<'a> {
        Box::pin(async move {
            let feed =
                pair.chainlink
                    .as_ref()
                    .ok_or_else(|| PriceOracleError::NoPairAvailable {
                        base: pair.base.clone(),
                        quote: pair.quote.clone(),
                    })?;
            let network = self.network_for_pair(pair)?;
            // Policy check only (scheme/authority + IP-literal class). The pinned
            // ContractDnsResolver on the contract-backed transport enforces
            // hostname address-class at connect, so this does not resolve DNS
            // here (a config-time lookup would be redundant + offline-fragile).
            // The contract is non-optional in production paths; bypass is not
            // possible without recompiling.
            self.egress_contract
                .enforce_url(&network.rpc_endpoint, 0)
                .map_err(|err| {
                    PriceOracleError::InvalidConfiguration(format!(
                        "HttpEgressContract rejects Chainlink RPC endpoint: {err}"
                    ))
                })?;
            read_chainlink_rate(
                &network.rpc_endpoint,
                pair,
                feed,
                now,
                &self.egress_contract,
            )
            .await
        })
    }
}

async fn read_chainlink_rate(
    rpc_endpoint: &str,
    pair: &PairConfig,
    feed: &ChainlinkFeedConfig,
    now: u64,
    egress_contract: &HttpEgressContract,
) -> Result<ExchangeRate, PriceOracleError> {
    let url = rpc_endpoint.parse::<Url>().map_err(|err| {
        PriceOracleError::InvalidConfiguration(format!(
            "invalid Chainlink RPC endpoint {rpc_endpoint}: {err}"
        ))
    })?;
    let address = feed.address.parse::<Address>().map_err(|err| {
        PriceOracleError::InvalidConfiguration(format!(
            "invalid Chainlink feed address {} for {}: {err}",
            feed.address,
            pair.pair()
        ))
    })?;
    let provider = contract_backed_provider(url, egress_contract)?;
    let contract = AggregatorV3Interface::new(address, &provider);
    let latest = contract.latestRoundData().call().await.map_err(|err| {
        PriceOracleError::Unavailable(format!(
            "Chainlink latestRoundData failed for {} at {}: {err}",
            pair.pair(),
            feed.address
        ))
    })?;
    let decimals = contract.decimals().call().await.map_err(|err| {
        PriceOracleError::Unavailable(format!(
            "Chainlink decimals failed for {} at {}: {err}",
            pair.pair(),
            feed.address
        ))
    })?;
    if decimals != feed.decimals {
        return Err(PriceOracleError::InvalidFeed(format!(
            "Chainlink decimals mismatch for {} at {}: configured {}, contract returned {}",
            pair.pair(),
            feed.address,
            feed.decimals,
            decimals
        )));
    }
    let answer = u128::try_from(latest.answer).map_err(|_| {
        PriceOracleError::InvalidFeed(format!(
            "Chainlink returned a negative or oversized answer for {} at {}",
            pair.pair(),
            feed.address
        ))
    })?;
    if answer == 0 {
        return Err(PriceOracleError::InvalidFeed(format!(
            "Chainlink returned zero for {} at {}",
            pair.pair(),
            feed.address
        )));
    }
    let updated_at = u64::try_from(latest.updatedAt).map_err(|_| {
        PriceOracleError::InvalidFeed(format!(
            "Chainlink updatedAt overflowed u64 for {} at {}",
            pair.pair(),
            feed.address
        ))
    })?;
    if updated_at == 0 {
        return Err(PriceOracleError::InvalidFeed(format!(
            "Chainlink updatedAt was zero for {} at {}",
            pair.pair(),
            feed.address
        )));
    }
    let denominator = 10_u128
        .checked_pow(u32::from(feed.decimals))
        .ok_or_else(|| {
            PriceOracleError::ArithmeticOverflow(format!(
                "decimal normalization overflowed for {} at {}",
                pair.pair(),
                feed.address
            ))
        })?;
    let max_age_seconds = pair.policy.max_age_seconds.min(feed.heartbeat_seconds);
    let rate = ExchangeRate {
        base: pair.base.clone(),
        quote: pair.quote.clone(),
        rate_numerator: answer,
        rate_denominator: denominator,
        updated_at,
        fetched_at: now,
        source: "chainlink".to_string(),
        feed_reference: feed.address.clone(),
        max_age_seconds,
        conversion_margin_bps: pair.policy.exchange_rate_margin_bps,
        confidence_numerator: None,
        confidence_denominator: None,
    };
    rate.ensure_fresh(now)?;
    Ok(rate)
}

#[cfg(test)]
mod tests {
    use std::io::{Read, Write};
    use std::net::{SocketAddr, TcpListener, TcpStream};
    use std::sync::mpsc::{self, Receiver};
    use std::thread::{self, JoinHandle};

    use crate::config::{
        ChainlinkFeedConfig, ChainlinkNetworkConfig, PairConfig, PairPolicy, BASE_MAINNET_CAIP2,
        BASE_MAINNET_CHAIN_ID,
    };
    use crate::test_support::{TestUnwrap, TestUnwrapErr};
    use crate::OracleBackend;

    use super::{read_chainlink_rate, ChainlinkFeedReader};

    fn authority(addr: SocketAddr) -> String {
        format!("{}:{}", addr.ip(), addr.port())
    }

    fn read_http_request(stream: &mut TcpStream) -> String {
        let mut request = Vec::new();
        let mut buffer = [0_u8; 1024];
        loop {
            let read = stream
                .read(&mut buffer)
                .unwrap_or_else(|err| panic!("read request: {err}"));
            if read == 0 {
                break;
            }
            request.extend_from_slice(&buffer[..read]);
            if request.windows(4).any(|window| window == b"\r\n\r\n") {
                break;
            }
        }
        String::from_utf8_lossy(&request).into_owned()
    }

    fn spawn_single_response_server<F>(
        response_for_request: F,
    ) -> (SocketAddr, Receiver<String>, JoinHandle<()>)
    where
        F: FnOnce(String) -> String + Send + 'static,
    {
        let listener =
            TcpListener::bind("127.0.0.1:0").unwrap_or_else(|err| panic!("bind server: {err}"));
        let addr = listener
            .local_addr()
            .unwrap_or_else(|err| panic!("read server addr: {err}"));
        let (tx, rx) = mpsc::channel();
        let handle = thread::spawn(move || {
            let (mut stream, _) = listener
                .accept()
                .unwrap_or_else(|err| panic!("accept request: {err}"));
            let request = read_http_request(&mut stream);
            tx.send(request.clone())
                .unwrap_or_else(|err| panic!("send captured request: {err}"));
            let response = response_for_request(request);
            stream
                .write_all(response.as_bytes())
                .unwrap_or_else(|err| panic!("write response: {err}"));
        });
        (addr, rx, handle)
    }

    fn pair_with_chainlink(address: &str) -> PairConfig {
        PairConfig {
            base: "ETH".to_string(),
            quote: "USD".to_string(),
            chain_id: BASE_MAINNET_CHAIN_ID,
            chainlink: Some(ChainlinkFeedConfig {
                address: address.to_string(),
                decimals: 8,
                heartbeat_seconds: 300,
            }),
            pyth: None,
            policy: PairPolicy::volatile_default(),
        }
    }

    fn base_network(rpc_endpoint: &str) -> ChainlinkNetworkConfig {
        ChainlinkNetworkConfig {
            chain_id: BASE_MAINNET_CHAIN_ID,
            label: "base-mainnet".to_string(),
            caip2: BASE_MAINNET_CAIP2.to_string(),
            rpc_endpoint: rpc_endpoint.to_string(),
            enabled: true,
            sequencer_uptime_feed: None,
            sequencer_grace_period_seconds: 300,
        }
    }

    #[tokio::test]
    async fn rejects_invalid_rpc_endpoints() {
        let pair = pair_with_chainlink("0x71041dddad3595F9CEd3DcCFBe3D1F4b0a16Bb70");
        let error = read_chainlink_rate(
            "not a url",
            &pair,
            pair.chainlink.as_ref().test_unwrap("feed"),
            1_743_292_780,
            &chio_egress_contract::HttpEgressContract::permissive_for_tests("rpc.example"),
        )
        .await
        .test_unwrap_err("invalid endpoint");
        assert!(matches!(
            error,
            crate::PriceOracleError::InvalidConfiguration(_)
        ));
    }

    #[test]
    fn rejects_pairs_without_a_configured_network() {
        let reader = ChainlinkFeedReader::new(
            vec![base_network("https://rpc.example")],
            chio_egress_contract::HttpEgressContract::permissive_for_tests("rpc.example"),
        );
        let mut pair = pair_with_chainlink("0x71041dddad3595F9CEd3DcCFBe3D1F4b0a16Bb70");
        pair.chain_id = 1;

        let error = reader
            .network_for_pair(&pair)
            .test_unwrap_err("missing network");

        assert!(matches!(
            error,
            crate::PriceOracleError::InvalidConfiguration(_)
        ));
    }

    #[test]
    fn try_new_accepts_hostname_contract_with_pinned_dns() {
        let reader = ChainlinkFeedReader::try_new(
            vec![base_network("https://rpc.example")],
            chio_egress_contract::HttpEgressContract::permissive_for_tests("rpc.example"),
        )
        .test_unwrap("hostname contract is resolver-enforced at dispatch");
        assert_eq!(reader.networks.len(), 1);
    }

    #[tokio::test]
    async fn backend_accepts_hostname_rpc_for_contract_backed_dispatch() {
        let reader = ChainlinkFeedReader::new(
            vec![base_network("https://rpc.example")],
            chio_egress_contract::HttpEgressContract::permissive_for_tests("rpc.example"),
        );
        let pair = pair_with_chainlink("0x71041dddad3595F9CEd3DcCFBe3D1F4b0a16Bb70");

        let error = reader
            .read_rate(&pair, 1_743_292_780)
            .await
            .test_unwrap_err("unreachable hostname RPC should fail during dispatch");
        let message = error.to_string();
        assert!(
            message.contains("rpc.example") && message.contains("oracle backend unavailable"),
            "unexpected Chainlink hostname dispatch error: {message}"
        );
    }

    #[tokio::test]
    async fn rpc_transport_rejects_redirects_outside_contract() {
        let denied_target = "http://127.0.0.1:9/final";
        let (addr, _rx, handle) = spawn_single_response_server({
            let denied_target = denied_target.to_string();
            move |_| {
                format!(
                    "HTTP/1.1 302 Found\r\nLocation: {denied_target}\r\nContent-Length: 0\r\nConnection: close\r\n\r\n"
                )
            }
        });
        let endpoint = format!("http://{}/rpc", authority(addr));
        let contract =
            chio_egress_contract::HttpEgressContract::permissive_for_tests(&authority(addr));
        let pair = pair_with_chainlink("0x71041dddad3595F9CEd3DcCFBe3D1F4b0a16Bb70");

        let error = read_chainlink_rate(
            &endpoint,
            &pair,
            pair.chainlink.as_ref().test_unwrap("feed"),
            1_743_292_780,
            &contract,
        )
        .await
        .test_unwrap_err("redirect target should be denied");
        let message = error.to_string();
        assert!(
            message.contains("Chainlink latestRoundData failed")
                && message.contains("authority")
                && message.contains("not allowed"),
            "unexpected Chainlink redirect denial: {message}"
        );
        handle
            .join()
            .unwrap_or_else(|_| panic!("join redirect server"));
    }

    #[tokio::test]
    async fn rpc_transport_rejects_oversized_responses() {
        let (addr, _rx, handle) = spawn_single_response_server(|_| {
            "HTTP/1.1 200 OK\r\nContent-Length: 6\r\nConnection: close\r\n\r\nabcdef".to_string()
        });
        let endpoint = format!("http://{}/rpc", authority(addr));
        let mut contract =
            chio_egress_contract::HttpEgressContract::permissive_for_tests(&authority(addr));
        contract.max_response_bytes = 5;
        let pair = pair_with_chainlink("0x71041dddad3595F9CEd3DcCFBe3D1F4b0a16Bb70");

        let error = read_chainlink_rate(
            &endpoint,
            &pair,
            pair.chainlink.as_ref().test_unwrap("feed"),
            1_743_292_780,
            &contract,
        )
        .await
        .test_unwrap_err("oversized response should be denied");
        let message = error.to_string();
        assert!(
            message.contains("Chainlink latestRoundData failed")
                && message.contains("response size 6 exceeds maximum 5"),
            "unexpected Chainlink response-size denial: {message}"
        );
        handle.join().unwrap_or_else(|_| panic!("join body server"));
    }

    #[tokio::test]
    async fn rejects_invalid_feed_addresses() {
        let pair = pair_with_chainlink("not-an-address");

        let error = read_chainlink_rate(
            "https://rpc.example",
            &pair,
            pair.chainlink.as_ref().test_unwrap("feed"),
            1_743_292_780,
            &chio_egress_contract::HttpEgressContract::permissive_for_tests("rpc.example"),
        )
        .await
        .test_unwrap_err("invalid feed address");

        assert!(matches!(
            error,
            crate::PriceOracleError::InvalidConfiguration(_)
        ));
    }

    #[tokio::test]
    async fn backend_rejects_pairs_without_chainlink_feeds() {
        let reader = ChainlinkFeedReader::new(
            vec![base_network("https://rpc.example")],
            chio_egress_contract::HttpEgressContract::permissive_for_tests("rpc.example"),
        );
        let pair = PairConfig {
            base: "ETH".to_string(),
            quote: "USD".to_string(),
            chain_id: BASE_MAINNET_CHAIN_ID,
            chainlink: None,
            pyth: None,
            policy: PairPolicy::volatile_default(),
        };

        let error = reader
            .read_rate(&pair, 1_743_292_780)
            .await
            .test_unwrap_err("missing feed");

        assert!(matches!(
            error,
            crate::PriceOracleError::NoPairAvailable { .. }
        ));
    }
}