feat: refactor bridge function split

.github/workflows/pr-review.yml

@@ -1,12 +1,12 @@
 name: PR Review
 
 on:
-  workflow_dispatch:
-#  pull_request:
-#    types: [opened, synchronize, ready_for_review, reopened]
+  pull_request:
+    types: [opened, synchronize, ready_for_review, reopened]
 
 jobs:
   review-with-tracking:
+    if: contains(github.event.pull_request.labels.*.name, 'jobtaker')
     runs-on: ${{ vars.RUNNER }}
     permissions:
       contents: read

Cargo.toml

@@ -28,7 +28,6 @@ alloy-provider = { version = "1", default-features = false, features = [
 alloy-rpc-types = "1"
 alloy-sol-types = { version = "1", features = ["json"] }
 alloy-transport = { version = "1", default-features = false }
-bincode = "1"
 nitrogen-circle-message-transmitter-v2-encoder = { git = "https://github.com/CarteraMesh/nitrogen.git", branch = "main" }
 nitrogen-circle-token-messenger-minter-v2-encoder = { git = "https://github.com/CarteraMesh/nitrogen.git", branch = "main" }
 nitrogen-instruction-builder = { git = "https://github.com/CarteraMesh/nitrogen.git", branch = "main" }
@@ -42,6 +41,7 @@ solana-signature = "2"
 solana-signer = "2"
 spl-associated-token-account = { version = "7.0.0", features = ["no-entrypoint"] }
 thiserror = "2"
+tokio = { version = "1", default-features = false, features = ["time"] }
 tracing = "0.1"
 
 [dev-dependencies]

README.md

@@ -5,14 +5,62 @@
 [![CI](https://github.com/CarteraMesh/cctp-bridge/workflows/test/badge.svg)](https://github.com/CarteraMesh/cctp-bridge/actions)
 [![Cov](https://codecov.io/github/CarteraMesh/cctp-bridge/graph/badge.svg?token=dILa1k9tlW)](https://codecov.io/github/CarteraMesh/cctp-bridge)
 
-## Installation
-
-### Cargo
-
-* Install the rust toolchain in order to have cargo installed by following
-  [this](https://www.rust-lang.org/tools/install) guide.
-* run `cargo install cctp-bridge`
-
+## About
+
+cctp-bridge is a Rust-based helper library for the Cross-Chain Token Protocol [CCTP](https://developers.circle.com/cctp). It facilitates the transfer of USDC between different blockchain networks.
+This crates provides flexible control over the transfer process, allowing users to customize various aspects of the transfer.
+
+This project is a fork of the [cctp-rs](https://github.com/semiotic-ai/cctp-rs) [crate](https://crates.io/crates/cctp-rs)
+
+## Example
+
+```rust
+
+mod common;
+
+use {
+    alloy_chains::NamedChain,
+    alloy_provider::WalletProvider,
+    cctp_bridge::{Cctp, SolanSigners},
+    common::*,
+    solana_signer::Signer,
+    tracing::info,
+};
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    dotenvy::dotenv().ok();
+    tracing_subscriber::fmt::init();
+    // Setup wallets
+    let base_sepolia_wallet_provider = evm_base_setup()?;
+    let (solana_keypair, rpc) = solana_setup()?;
+    info!(
+        "solana address {} sends to base address {}",
+        solana_keypair.pubkey(),
+        base_sepolia_wallet_provider.default_signer_address()
+    );
+
+    // Convenience wrapper for cctp_bridge::SolanaProvider trait
+    let rpc_wrapper: cctp_bridge::SolanaWrapper = rpc.into();
+    // Convenience wrapper for solana_signer::Signer for use of CCTP operations
+    let signers = SolanSigners::new(solana_keypair);
+
+    let bridge = Cctp::new_solana_evm(
+        rpc_wrapper,
+        base_sepolia_wallet_provider,
+        cctp_bridge::SOLANA_DEVNET, // source chain
+        NamedChain::BaseSepolia, // destination chain
+    );
+    // 0.000010 USDC to base sepolia
+    let result = bridge.bridge_sol_evm(10, signers, None, None, None).await?;
+    println!("Solana burn txHash {}", result.burn);
+    println!(
+        "Base Receive txHash {}",
+        alloy_primitives::hex::encode(result.recv)
+    );
+    Ok(())
+}
+```
 
 ## Development
 

examples/common/mod.rs

@@ -10,7 +10,7 @@ use {
 };
 
 #[allow(dead_code)]
-pub fn evm_setup() -> anyhow::Result<impl WalletProvider + Provider + Clone> {
+pub fn evm_base_setup() -> anyhow::Result<impl WalletProvider + Provider + Clone> {
     let secret_key = env::var("EVM_SECRET_KEY").expect("EVM_SECRET_KEY not set");
     let wallet = PrivateKeySigner::from_str(&secret_key).expect("Invalid private key");
     let api_key = env::var("ALCHEMY_API_KEY").expect("ALCHEMY_API_KEY not set");

examples/evm_sol.rs

@@ -13,7 +13,7 @@ use {
 async fn main() -> anyhow::Result<()> {
     dotenvy::dotenv().ok();
     tracing_subscriber::fmt::init();
-    let base_provider = common::evm_setup()?;
+    let base_provider = common::evm_base_setup()?;
     let (owner, rpc) = common::solana_setup()?;
     info!(
         "solana address {} sends to base address {}",

examples/sol_evm.rs

@@ -3,7 +3,8 @@ mod common;
 use {
     alloy_chains::NamedChain,
     alloy_provider::WalletProvider,
-    cctp_bridge::{Cctp, SolanSigners, SolanaWrapper},
+    cctp_bridge::{Cctp, SolanSigners},
+    common::*,
     solana_signer::Signer,
     tracing::info,
 };
@@ -12,25 +13,32 @@ use {
 async fn main() -> anyhow::Result<()> {
     dotenvy::dotenv().ok();
     tracing_subscriber::fmt::init();
-    let base_provider = common::evm_setup()?;
-    let (owner, rpc) = common::solana_setup()?;
+    // Setup wallets
+    let base_sepolia_wallet_provider = evm_base_setup()?;
+    let (solana_keypair, rpc) = solana_setup()?;
     info!(
         "solana address {} sends to base address {}",
-        owner.pubkey(),
-        base_provider.default_signer_address()
+        solana_keypair.pubkey(),
+        base_sepolia_wallet_provider.default_signer_address()
     );
 
-    let rpc: SolanaWrapper = rpc.into();
+    // Convenience wrapper for cctp_bridge::SolanaProvider trait
+    let rpc_wrapper: cctp_bridge::SolanaWrapper = rpc.into();
+    // Convenience wrapper for solana_signer::Signer for use of CCTP operations
+    let signers = SolanSigners::new(solana_keypair);
 
     let bridge = Cctp::new_solana_evm(
-        rpc,
-        base_provider,
+        rpc_wrapper,
+        base_sepolia_wallet_provider,
         cctp_bridge::SOLANA_DEVNET,
         NamedChain::BaseSepolia,
     );
-    let result = bridge
-        .bridge_sol_evm(10, SolanSigners::new(owner), None, None, None)
-        .await?;
-    println!("success {result}");
+    // 0.000010 USDC to base sepolia
+    let result = bridge.bridge_sol_evm(10, signers, None, None, None).await?;
+    println!("Solana burn txHash {}", result.burn);
+    println!(
+        "Base Receive txHash {}",
+        alloy_primitives::hex::encode(result.recv)
+    );
     Ok(())
 }

src/attestation.rs

@@ -5,7 +5,7 @@ use {
 };
 
 /// To be passed to message transmitter to claim/mint
-#[derive(Clone)]
+#[derive(Clone, Eq, PartialEq)]
 pub struct Attestation {
     pub attestation: Vec<u8>,
     pub message: Vec<u8>,

src/bridge.rs

@@ -8,18 +8,22 @@ use {
         CctpChain,
         error::{Error, Result},
     },
-    alloy_chains::{Chain, NamedChain},
+    alloy_chains::{Chain, ChainKind, NamedChain},
     alloy_network::Ethereum,
-    alloy_primitives::{FixedBytes, TxHash, hex},
+    alloy_primitives::{
+        FixedBytes,
+        TxHash,
+        hex::{self, encode},
+    },
     alloy_provider::Provider,
     alloy_sol_types::SolEvent,
     reqwest::{Client, Response},
     solana_signature::Signature as SolanaSignature,
     std::{
         fmt::{Debug, Display},
-        thread::sleep,
         time::Duration,
     },
+    tokio::time::sleep,
     tracing::{Level, debug, error, info, instrument, trace},
 };
 
@@ -51,12 +55,15 @@ pub const CHAIN_CONFIRMATION_CONFIG: &[(NamedChain, u64, Duration)] = &[
 ];
 
 /// Gets the chain-specific confirmation configuration
-pub fn get_chain_confirmation_config(chain: &NamedChain) -> (u64, Duration) {
-    CHAIN_CONFIRMATION_CONFIG
-        .iter()
-        .find(|(ch, _, _)| ch == chain)
-        .map(|(_, confirmations, timeout)| (*confirmations, *timeout))
-        .unwrap_or((1, DEFAULT_CONFIRMATION_TIMEOUT))
+pub fn get_chain_confirmation_config(chain: &Chain) -> (u64, Duration) {
+    match chain.kind() {
+        ChainKind::Named(n) => CHAIN_CONFIRMATION_CONFIG
+            .iter()
+            .find(|(ch, _, _)| ch == n)
+            .map(|(_, confirmations, timeout)| (*confirmations, *timeout))
+            .unwrap_or((1, DEFAULT_CONFIRMATION_TIMEOUT)),
+        ChainKind::Id(_) => (2, Duration::from_secs(4)), // TODO add specific timeout for id chain
+    }
 }
 
 /// For solana reclaim accounts
@@ -114,7 +121,7 @@ impl Display for EvmBridgeResult {
     }
 }
 
-#[derive(Clone, Debug)]
+#[derive(Clone)]
 pub struct Cctp<SrcProvider, DstProvider> {
     source_provider: SrcProvider,
     destination_provider: DstProvider,
@@ -124,6 +131,18 @@ pub struct Cctp<SrcProvider, DstProvider> {
     client: Client,
 }
 
+impl<SrcProvider, DstProvider> Debug for Cctp<SrcProvider, DstProvider> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let src_domain = self.source_chain.cctp_domain_id().unwrap_or(u32::MAX);
+        let dst_domain = self.destination_chain.cctp_domain_id().unwrap_or(u32::MAX);
+        write!(
+            f,
+            "CCTP[{}({})->{}({})]",
+            self.source_chain, src_domain, self.destination_chain, dst_domain
+        )
+    }
+}
+
 impl<SrcProvider, DstProvider> Cctp<SrcProvider, DstProvider> {
     /// Returns the CCTP API URL for the current environment
     pub fn api_url(&self) -> &'static str {
@@ -196,6 +215,21 @@ impl<SrcProvider, DstProvider> Cctp<SrcProvider, DstProvider> {
         )
     }
 
+    /// Wrapper call to [`get_attestation_with_retry`] for evm [`TxHash`]
+    pub async fn get_attestation_evm(
+        &self,
+        message_hash: TxHash,
+        max_attempts: Option<u32>,
+        poll_interval: Option<u64>,
+    ) -> Result<Attestation> {
+        self.get_attestation_with_retry(
+            format!("0x{}", encode(message_hash)),
+            max_attempts,
+            poll_interval,
+        )
+        .await
+    }
+
     /// Gets the attestation for a message hash from the CCTP API
     ///
     /// # Arguments
@@ -238,7 +272,7 @@ impl<SrcProvider, DstProvider> Cctp<SrcProvider, DstProvider> {
             if response.status() == reqwest::StatusCode::TOO_MANY_REQUESTS {
                 let secs = 5 * 60;
                 debug!(sleep_secs = ?secs, "Rate limit exceeded, waiting before retrying");
-                sleep(Duration::from_secs(secs));
+                sleep(Duration::from_secs(secs)).await;
                 continue;
             }
 
@@ -251,7 +285,7 @@ impl<SrcProvider, DstProvider> Cctp<SrcProvider, DstProvider> {
                     poll_interval = ?poll_interval,
                     "Attestation not found (404), waiting before retrying"
                 );
-                sleep(Duration::from_secs(poll_interval));
+                sleep(Duration::from_secs(poll_interval)).await;
                 continue;
             }
 
@@ -322,7 +356,7 @@ impl<SrcProvider, DstProvider> Cctp<SrcProvider, DstProvider> {
                         poll_interval = ?poll_interval,
                         "Attestation pending, waiting before retrying"
                     );
-                    sleep(Duration::from_secs(poll_interval));
+                    sleep(Duration::from_secs(poll_interval)).await;
                 }
             }
         }