rrelayer 0.1.0

The official Rust SDK for interacting with rrelayer services - a powerful blockchain transaction relay service
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
//! Alloy integration for rrelayer SDK
//!
//! This module provides seamless integration between Alloy and the rrelayer service.
//!
//! # Usage
//!
//! ```rust,no_run
//! use alloy::signers::Signer;
//! use rrelayer::{RelayerClient, RelayerClientConfig, RelayerClientAuth, RelayerId};
//! use rrelayer::alloy_integration::{RelayerSigner, with_relayer};
//! use alloy::primitives::Address;
//! use std::{sync::Arc, str::FromStr};
//!
//! # async fn example() -> anyhow::Result<()> {
//! // Create RelayerClient
//! let relayer_id = RelayerId::from_str("94afb207-bb47-4392-9229-ba87e4d783cb")?;
//! let config = RelayerClientConfig {
//!     server_url: "http://localhost:8000".to_string(),
//!     relayer_id: relayer_id.clone(),
//!     auth: RelayerClientAuth::ApiKey { api_key: "your-key".to_string() },
//!     speed: None,
//! };
//! let relayer_client = Arc::new(RelayerClient::new(config));
//!
//! // Create RelayerSigner from RelayerClient
//! let address = Address::from_str("0x742d35cc6634c0532925a3b8d67e8000c942b1b5")?;
//! let signer = RelayerSigner::from_relayer_client(relayer_client, address, Some(1));
//!
//! // Use exactly like any other Alloy signer
//! let signature = signer.sign_message(b"hello world").await?;
//!
//! // Wrap provider for transaction hijacking
//! let http_provider = (); // In practice: real HTTP provider
//! let provider = with_relayer(http_provider, signer);
//! # Ok(())
//! # }
//! ```

use alloy::{
    dyn_abi::TypedData,
    network::TransactionBuilder,
    primitives::{Address, B256, ChainId, Signature, U256},
    rpc::types::TransactionRequest,
    signers::Signer,
};
use async_trait::async_trait;
use std::sync::Arc;
use thiserror::Error;

use crate::{AdminRelayerClient, ApiSdkError, RelayerClient};
use rrelayer_core::{
    common_types::EvmAddress,
    relayer::RelayerId,
    transaction::api::RelayTransactionRequest,
    transaction::types::{TransactionData, TransactionValue},
};
use std::str::FromStr;

#[derive(Error, Debug)]
pub enum RelayerSignerError {
    #[error("Relayer API error: {0}")]
    ApiError(#[from] ApiSdkError),
    #[error("Invalid signature format")]
    InvalidSignature,
    #[error("Address conversion error")]
    AddressConversion,
}

/// A signer that routes all signing through your relayer service.
///
/// This is a drop-in replacement for Alloy signers like `PrivateKeySigner` that works
/// with existing Alloy code but routes all operations through your relayer infrastructure.
///
/// # Examples
///
/// ```rust,no_run
/// use alloy::signers::Signer;
/// use alloy::primitives::Address;
/// use alloy::dyn_abi::TypedData;
/// use rrelayer::{RelayerSigner, RelayerClient, RelayerClientConfig, RelayerClientAuth, RelayerId};
/// use std::{sync::Arc, str::FromStr};
///
/// # async fn example() -> anyhow::Result<()> {
/// // Create RelayerClient
/// let relayer_id = RelayerId::from_str("94afb207-bb47-4392-9229-ba87e4d783cb")?;
/// let config = RelayerClientConfig {
///     server_url: "http://localhost:8000".to_string(),
///     relayer_id: relayer_id.clone(),
///     auth: RelayerClientAuth::ApiKey { api_key: "your-key".to_string() },
///     speed: None,
/// };
/// let relayer_client = Arc::new(RelayerClient::new(config));
/// let address = Address::from_str("0x742d35cc6634c0532925a3b8d67e8000c942b1b5")?;
///
/// // Create from RelayerClient
/// let signer = RelayerSigner::from_relayer_client(
///     relayer_client,
///     address,
///     Some(1), // mainnet
/// );
///
/// // Sign messages (routes through relayer.sign().text())
/// let signature = signer.sign_message(b"hello").await?;
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
pub struct RelayerSigner {
    client_type: RelayerClientType,
    address: Address,
    chain_id: Option<ChainId>,
}

#[derive(Debug, Clone)]
pub enum RelayerClientType {
    Relayer(Arc<RelayerClient>),
    Admin(Arc<AdminRelayerClient>),
}

impl RelayerSigner {
    /// Create a RelayerSigner from a RelayerClient.
    ///
    /// # Arguments
    ///
    /// * `client` - The RelayerClient to use for signing operations
    /// * `address` - The Ethereum address this signer represents
    /// * `chain_id` - Optional chain ID for EIP-155 replay protection
    pub fn from_relayer_client(
        client: Arc<RelayerClient>,
        address: Address,
        chain_id: Option<ChainId>,
    ) -> Self {
        Self { client_type: RelayerClientType::Relayer(client), address, chain_id }
    }

    /// Create a RelayerSigner from an AdminRelayerClient.
    ///
    /// # Arguments
    ///
    /// * `client` - The AdminRelayerClient to use for signing operations
    /// * `address` - The Ethereum address this signer represents  
    /// * `chain_id` - Optional chain ID for EIP-155 replay protection
    pub fn from_admin_client(
        client: Arc<AdminRelayerClient>,
        address: Address,
        chain_id: Option<ChainId>,
    ) -> Self {
        Self { client_type: RelayerClientType::Admin(client), address, chain_id }
    }

    /// Convenience constructor that automatically fetches the address from the relayer.
    ///
    /// # Arguments
    ///
    /// * `client` - The RelayerClient to use
    /// * `chain_id` - Optional chain ID for EIP-155 replay protection
    pub async fn from_relayer_client_auto_address(
        client: Arc<RelayerClient>,
        chain_id: Option<ChainId>,
    ) -> Result<Self, RelayerSignerError> {
        let relayer_address = client.address().await?;
        let address = relayer_address.into_address();

        Ok(Self::from_relayer_client(client, address, chain_id))
    }

    /// Convenience constructor that automatically fetches the address from the admin client.
    ///
    /// # Arguments
    ///
    /// * `client` - The AdminRelayerClient to use
    /// * `chain_id` - Optional chain ID for EIP-155 replay protection
    pub async fn from_admin_client_auto_address(
        client: Arc<AdminRelayerClient>,
        chain_id: Option<ChainId>,
    ) -> Result<Self, RelayerSignerError> {
        let relayer_address = client.address().await?;
        let address = relayer_address.into_address();

        Ok(Self::from_admin_client(client, address, chain_id))
    }

    /// Get the relayer ID associated with this signer.
    pub fn relayer_id(&self) -> &RelayerId {
        match &self.client_type {
            RelayerClientType::Relayer(client) => client.id(),
            RelayerClientType::Admin(client) => client.id(),
        }
    }

    /// Get access to the underlying client for advanced operations.
    pub fn client(&self) -> &RelayerClientType {
        &self.client_type
    }

    /// Get address of relayer
    pub fn address(&self) -> &Address {
        &self.address
    }
}

#[async_trait]
impl Signer for RelayerSigner {
    /// Get the signer's Ethereum address.
    fn address(&self) -> Address {
        self.address
    }

    /// Get the chain ID for EIP-155 replay protection.
    fn chain_id(&self) -> Option<ChainId> {
        self.chain_id
    }

    /// Set the chain ID for EIP-155 replay protection.
    fn set_chain_id(&mut self, chain_id: Option<ChainId>) {
        self.chain_id = chain_id;
    }

    /// Sign a hash using the relayer service.
    ///
    /// This routes the signing request through `relayer.sign().text()`.
    async fn sign_hash(&self, hash: &B256) -> alloy::signers::Result<Signature> {
        let hash_hex = format!("0x{}", hex::encode(hash));

        let sign_result = match &self.client_type {
            RelayerClientType::Relayer(client) => client.sign().text(&hash_hex, None).await,
            RelayerClientType::Admin(client) => client.sign().text(&hash_hex, None).await,
        }
        .map_err(alloy::signers::Error::other)?;

        Ok(sign_result.signature)
    }

    /// Sign dynamic typed data using the relayer service.
    ///
    /// This routes the signing request through `relayer.sign().typed_data()`.
    async fn sign_dynamic_typed_data(
        &self,
        payload: &TypedData,
    ) -> alloy::signers::Result<Signature> {
        let sign_result = match &self.client_type {
            RelayerClientType::Relayer(client) => client.sign().typed_data(payload, None).await,
            RelayerClientType::Admin(client) => client.sign().typed_data(payload, None).await,
        }
        .map_err(alloy::signers::Error::other)?;

        Ok(sign_result.signature)
    }
}

/// A provider wrapper that hijacks transaction sending to route through the relayer.
///
/// This allows you to use standard Alloy provider patterns while transparently routing
/// all transaction sending through your relayer infrastructure.
///
/// # Examples
///
/// ```rust,no_run
/// use alloy::primitives::Address;
/// use alloy::providers::{ProviderBuilder, Provider};
/// use rrelayer::{RelayerProvider, with_relayer, RelayerSigner};
/// use std::str::FromStr;
///
/// # async fn example() -> anyhow::Result<()> {
/// # let relayer_signer: RelayerSigner = todo!(); // Created elsewhere
/// // Wrap any provider with relayer functionality
/// let rpc_url = "https://eth.llamarpc.com".parse()?;
/// let http_provider = ProviderBuilder::new().on_http(rpc_url);
/// let provider = with_relayer(http_provider, relayer_signer);
///
/// // Send transactions via relayer
/// let to_address = Address::from_str("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045")?;
/// let tx_id = provider.send_transaction_via_relayer(to_address, 1000000).await?;
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
pub struct RelayerProvider<P> {
    inner: P,
    relayer_signer: RelayerSigner,
}

impl<P> RelayerProvider<P> {
    /// Create a new RelayerProvider wrapping the given provider.
    ///
    /// # Arguments
    ///
    /// * `provider` - The underlying provider to wrap
    /// * `relayer_signer` - The RelayerSigner to use for transaction operations
    pub fn new(provider: P, relayer_signer: RelayerSigner) -> Self {
        Self { inner: provider, relayer_signer }
    }

    /// Get access to the underlying provider.
    pub fn inner(&self) -> &P {
        &self.inner
    }

    /// Get access to the relayer signer.
    pub fn relayer_signer(&self) -> &RelayerSigner {
        &self.relayer_signer
    }

    /// Send a transaction via the relayer service.
    ///
    /// This is a demonstration method showing how standard Alloy transaction
    /// patterns can be hijacked to route through the relayer.
    ///
    /// # Arguments
    ///
    /// * `to` - The recipient address
    /// * `value` - The value to send in wei
    ///
    /// # Returns
    ///
    /// The transaction ID from the relayer service
    /// Send a transaction using standard Alloy TransactionRequest.
    ///
    /// This accepts a standard Alloy `TransactionRequest` and automatically
    /// converts it to the relayer format, allowing seamless integration.
    ///
    /// # Arguments
    ///
    /// * `tx_request` - Standard Alloy TransactionRequest
    ///
    /// # Returns
    ///
    /// The transaction ID from the relayer service
    pub async fn send_transaction(
        &self,
        tx_request: &TransactionRequest,
    ) -> Result<String, RelayerSignerError> {
        println!("🔄 Sending transaction via relayer!");

        // Convert Alloy TransactionRequest to RelayTransactionRequest
        let relay_request = self.convert_transaction_request(tx_request)?;

        // Send through relayer
        let result = match &self.relayer_signer.client_type {
            RelayerClientType::Relayer(client) => {
                client.transaction().send(&relay_request, None).await
            }
            RelayerClientType::Admin(client) => {
                client.transaction().send(&relay_request, None).await
            }
        }?;

        Ok(result.id.to_string())
    }

    pub async fn send_transaction_via_relayer(
        &self,
        to: Address,
        value: u64,
    ) -> Result<String, RelayerSignerError> {
        // Convert to TransactionRequest and use the main method
        let tx_request = TransactionRequest::default().with_to(to).with_value(U256::from(value));

        self.send_transaction(&tx_request).await
    }

    /// Convert Alloy TransactionRequest to RelayTransactionRequest
    fn convert_transaction_request(
        &self,
        tx_request: &TransactionRequest,
    ) -> Result<RelayTransactionRequest, RelayerSignerError> {
        // For now, use a simplified approach - we'll improve this as the API evolves

        // Extract to address - for now require it to be specified
        let to = match &tx_request.to {
            Some(to_addr) => {
                #[allow(irrefutable_let_patterns)]
                if let Ok(addr_str) = format!("{:?}", to_addr)
                    .strip_prefix("0x")
                    .unwrap_or(&format!("{:?}", to_addr))
                    .parse::<String>()
                {
                    EvmAddress::from_str(&addr_str)
                        .map_err(|_| RelayerSignerError::AddressConversion)?
                } else {
                    return Err(RelayerSignerError::AddressConversion);
                }
            }
            None => return Err(RelayerSignerError::InvalidSignature),
        };

        // Extract value (default to 0 if not specified)
        let value =
            tx_request.value.map(TransactionValue::new).unwrap_or_else(TransactionValue::zero);

        // Extract transaction data - simplified for now
        let data = match tx_request.input.input() {
            Some(input_bytes) if !input_bytes.is_empty() => {
                TransactionData::new(input_bytes.clone())
            }
            _ => TransactionData::empty(),
        };

        Ok(RelayTransactionRequest {
            to,
            value,
            data,
            speed: None, // Use relayer's default speed
            external_id: None,
            blobs: None, // EIP-4844 blobs not supported yet
        })
    }
}

/// Convenience function to wrap any provider with relayer functionality.
///
/// # Arguments
///
/// * `provider` - The provider to wrap (can be HTTP, WS, etc.)
/// * `relayer_signer` - The RelayerSigner to use for operations
///
/// # Returns
///
/// A RelayerProvider that transparently routes operations through the relayer
///
/// # Examples
///
/// ```rust,no_run
/// use alloy::providers::{ProviderBuilder, Provider};
/// use alloy::primitives::Address;
/// use rrelayer::{with_relayer, RelayerSigner};
/// use std::str::FromStr;
///
/// # async fn example() -> anyhow::Result<()> {
/// # let relayer_signer: RelayerSigner = todo!(); // Created elsewhere
/// let rpc_url = "https://eth.llamarpc.com".parse()?;
/// let http_provider = ProviderBuilder::new().on_http(rpc_url);
/// let relayer_provider = with_relayer(http_provider, relayer_signer);
///
/// // Now all transactions will be hijacked to use the relayer
/// let to = Address::from_str("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045")?;
/// let tx_id = relayer_provider.send_transaction_via_relayer(to, 1000000).await?;
/// # Ok(())
/// # }
/// ```
pub fn with_relayer<P>(provider: P, relayer_signer: RelayerSigner) -> RelayerProvider<P> {
    RelayerProvider::new(provider, relayer_signer)
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloy::primitives::address;

    #[test]
    fn test_relayer_signer_creation() {
        // This would require actual client setup, so we'll just test the structure
        let test_address = address!("742d35cc6634c0532925a3b8d67e8000c942b1b5");

        // Test that we can create the structure (compilation test)
        let _would_create = |client: Arc<RelayerClient>| {
            RelayerSigner::from_relayer_client(client, test_address, Some(1))
        };
    }

    #[test]
    fn test_provider_wrapper() {
        // Test that the provider wrapper compiles correctly
        let _test_fn = |signer: RelayerSigner| {
            let mock_provider = (); // In real use: HTTP provider
            with_relayer(mock_provider, signer)
        };
    }
}