From 79f95d6b5e99f10a4afa5e270a955c8c34268266 Mon Sep 17 00:00:00 2001 From: dougefresh Date: Fri, 17 Oct 2025 14:54:04 +0000 Subject: [PATCH] feat: rename to circle-client --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- .github/workflows/check.yml | 2 +- .github/workflows/test.yml | 2 +- CONTRIBUTING.md | 10 +++++----- Cargo.toml | 8 ++++---- README.md | 24 ++++++++++++------------ examples/evm_sol.rs | 4 ++-- examples/reclaim.rs | 4 ++-- examples/recv_message.rs | 4 ++-- examples/sol_evm.rs | 8 ++++---- release.toml | 2 +- tests/integration.rs | 10 +++++----- 13 files changed, 42 insertions(+), 42 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0ce4842..5de3f18 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -37,7 +37,7 @@ Steps to reproduce the behavior: - OS: [e.g. Ubuntu 20.04] -- cctp-bridge version: [e.g. 0.1.0] +- cctp-client version: [e.g. 0.1.0] ## Additional context diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 29e6483..0de3a87 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,10 +3,10 @@ diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index d96f844..2a4e72d 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -211,7 +211,7 @@ jobs: - name: Run examples env: RUST_BACKTRACE: 1 - RUST_LOG: info,cctp_bridge=debug + RUST_LOG: info,cctp_client=debug ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }} EVM_SECRET_KEY: ${{ secrets.EVM_SECRET_KEY }} TEST_PRIVATE_KEY: ${{ secrets.TEST_PRIVATE_KEY }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 1d41ff7..de843f1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -47,7 +47,7 @@ jobs: name: ubuntu / stable / coverage / ${{ matrix.features }} env: RUST_BACKTRACE: 1 - RUST_LOG: info,cctp_bridge=debug + RUST_LOG: info,cctp_client=debug ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }} EVM_SECRET_KEY: ${{ secrets.EVM_SECRET_KEY }} TEST_PRIVATE_KEY: ${{ secrets.TEST_PRIVATE_KEY }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f8ea13..553e6ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contribution guidelines -First off, thank you for considering contributing to cctp-bridge. +First off, thank you for considering contributing to cctp-client. If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change. @@ -8,7 +8,7 @@ wish to make by creating a new issue before making the change. ## Reporting issues Before reporting an issue on the -[issue tracker](https://github.com/CarteraMesh/cctp-bridge/issues), +[issue tracker](https://github.com/CarteraMesh/cctp-client/issues), please check that it has not already been reported by searching for some related keywords. @@ -19,7 +19,7 @@ Try to do one pull request per change. ### Updating the changelog Update the changes you have made in -[CHANGELOG](https://github.com/CarteraMesh/cctp-bridge/blob/main/CHANGELOG.md) +[CHANGELOG](https://github.com/CarteraMesh/cctp-client/blob/main/CHANGELOG.md) file under the **Unreleased** section. Add the changes of your pull request to one of the following subsections, @@ -42,8 +42,8 @@ If the required subsection does not exist yet under **Unreleased**, create it! This is no different than other Rust projects. ```shell -git clone https://github.com/CarteraMesh/cctp-bridge -cd cctp-bridge +git clone https://github.com/CarteraMesh/cctp-client +cd cctp-client cargo test ``` diff --git a/Cargo.toml b/Cargo.toml index 2b35240..1a5537d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,12 @@ [package] -name = "cctp-bridge" +name = "cctp-client" version = "0.1.0" edition = "2024" description = "Multi chain bridge for USDC" -repository = "https://github.com/CarteraMesh/cctp-bridge" +repository = "https://github.com/CarteraMesh/cctp-client" authors = ["gh@cartera-mesh.com"] -documentation = "https://docs.rs/cctp-bridge" -homepage = "https://github.com/CarteraMesh/cctp-bridge" +documentation = "https://docs.rs/cctp-client" +homepage = "https://github.com/CarteraMesh/cctp-client" categories = ["finance", "api-bindings"] keywords = ["defi", "solana", "ethereum", "web3", "blockchain", "sdk"] license = "Apache-2.0" diff --git a/README.md b/README.md index 6dce50c..052fd2d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# cctp-bridge +# cctp-client -[![Crates.io](https://img.shields.io/crates/v/cctp-bridge.svg)](https://crates.io/crates/cctp-bridge) -[![Docs.rs](https://docs.rs/cctp-bridge/badge.svg)](https://docs.rs/cctp-bridge) -[![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) +[![Crates.io](https://img.shields.io/crates/v/cctp-client.svg)](https://crates.io/crates/cctp-client) +[![Docs.rs](https://docs.rs/cctp-client/badge.svg)](https://docs.rs/cctp-client) +[![CI](https://github.com/CarteraMesh/cctp-client/workflows/test/badge.svg)](https://github.com/CarteraMesh/cctp-client/actions) +[![Cov](https://codecov.io/github/CarteraMesh/cctp-client/graph/badge.svg?token=dILa1k9tlW)](https://codecov.io/github/CarteraMesh/cctp-client) ## 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. +cctp-client 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) @@ -21,7 +21,7 @@ mod common; use { alloy_chains::NamedChain, alloy_provider::WalletProvider, - cctp_bridge::{Cctp, SolanSigners}, + cctp_client::{Cctp, SolanSigners}, common::*, solana_signer::Signer, tracing::info, @@ -40,15 +40,15 @@ async fn main() -> anyhow::Result<()> { 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 cctp_client::SolanaProvider trait + let rpc_wrapper: cctp_client::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 + cctp_client::SOLANA_DEVNET, // source chain NamedChain::BaseSepolia, // destination chain ); // 0.000010 USDC to base sepolia @@ -75,8 +75,8 @@ async fn main() -> anyhow::Result<()> { 1. **Clone the repository** ```bash - git clone https://github.com/CarteraMesh/cctp-bridge.git - cd cctp-bridge + git clone https://github.com/CarteraMesh/cctp-client.git + cd cctp-client ``` 2. **Build and test** diff --git a/examples/evm_sol.rs b/examples/evm_sol.rs index eff11f8..fb7647e 100644 --- a/examples/evm_sol.rs +++ b/examples/evm_sol.rs @@ -4,7 +4,7 @@ use { alloy_chains::NamedChain, alloy_primitives::U256, alloy_provider::WalletProvider, - cctp_bridge::{Cctp, SolanaWrapper}, + cctp_client::{Cctp, SolanaWrapper}, solana_signer::Signer, tracing::info, }; @@ -28,7 +28,7 @@ async fn main() -> anyhow::Result<()> { rpc, NamedChain::BaseSepolia, owner.pubkey(), - cctp_bridge::SOLANA_DEVNET, + cctp_client::SOLANA_DEVNET, ); let result = bridge .bridge_evm_sol(&owner, U256::from(10), None, None, None) diff --git a/examples/reclaim.rs b/examples/reclaim.rs index 6a02fe5..aa86ebf 100644 --- a/examples/reclaim.rs +++ b/examples/reclaim.rs @@ -1,7 +1,7 @@ mod common; use { - cctp_bridge::{Cctp, SolanaWrapper}, + cctp_client::{Cctp, SolanaWrapper}, solana_signer::Signer, tracing::info, }; @@ -14,7 +14,7 @@ async fn main() -> anyhow::Result<()> { info!("solana address {}", owner.pubkey(),); let rpc: SolanaWrapper = rpc.into(); - let bridge = Cctp::new_reclaim(rpc.clone(), rpc, cctp_bridge::SOLANA_DEVNET); + let bridge = Cctp::new_reclaim(rpc.clone(), rpc, cctp_client::SOLANA_DEVNET); let result = bridge.reclaim(&owner).await?; println!("reclaimed {} accounts", result.len()); for (sig, addr) in result { diff --git a/examples/recv_message.rs b/examples/recv_message.rs index defa278..bc524d7 100644 --- a/examples/recv_message.rs +++ b/examples/recv_message.rs @@ -2,7 +2,7 @@ mod common; use { alloy_chains::NamedChain, - cctp_bridge::{Cctp, SolanaWrapper}, + cctp_client::{Cctp, SolanaWrapper}, }; #[tokio::main] @@ -15,7 +15,7 @@ async fn main() -> anyhow::Result<()> { rpc.clone(), rpc, NamedChain::BaseSepolia, - cctp_bridge::SOLANA_DEVNET, + cctp_client::SOLANA_DEVNET, ); let result = bridge .recv_message_sol( diff --git a/examples/sol_evm.rs b/examples/sol_evm.rs index 676f6b4..fc992fd 100644 --- a/examples/sol_evm.rs +++ b/examples/sol_evm.rs @@ -3,7 +3,7 @@ mod common; use { alloy_chains::NamedChain, alloy_provider::WalletProvider, - cctp_bridge::{Cctp, SolanSigners}, + cctp_client::{Cctp, SolanSigners}, common::*, solana_signer::Signer, tracing::info, @@ -22,15 +22,15 @@ async fn main() -> anyhow::Result<()> { 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 cctp_client::SolanaProvider trait + let rpc_wrapper: cctp_client::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, + cctp_client::SOLANA_DEVNET, NamedChain::BaseSepolia, ); // 0.000010 USDC to base sepolia diff --git a/release.toml b/release.toml index 6918535..3fac7bb 100644 --- a/release.toml +++ b/release.toml @@ -2,7 +2,7 @@ enable-all-features = false # Pre-release checks -pre-release-commit-message = "chore: release cctp_bridge v" +pre-release-commit-message = "chore: release cctp_client v" # Tag settings tag-message = "chore: release v" diff --git a/tests/integration.rs b/tests/integration.rs index 53f6710..97dc67e 100644 --- a/tests/integration.rs +++ b/tests/integration.rs @@ -4,7 +4,7 @@ use { alloy_provider::{Provider, ProviderBuilder, WalletProvider}, alloy_signer_local::PrivateKeySigner, anyhow::Result, - cctp_bridge::{Cctp, SolanSigners, SolanaWrapper}, + cctp_client::{Cctp, SolanSigners, SolanaWrapper}, solana_commitment_config::CommitmentConfig, solana_keypair::Keypair, solana_rpc_client::nonblocking::rpc_client::RpcClient, @@ -77,7 +77,7 @@ async fn test_reclaim() -> Result<()> { let (owner, rpc) = solana_setup()?; let rpc: SolanaWrapper = rpc.into(); - let bridge = Cctp::new_reclaim(rpc.clone(), rpc, cctp_bridge::SOLANA_DEVNET); + let bridge = Cctp::new_reclaim(rpc.clone(), rpc, cctp_client::SOLANA_DEVNET); let result = bridge.reclaim(&owner).await?; info!("reclaimed {} accounts", result.len()); for (sig, addr) in result { @@ -105,7 +105,7 @@ async fn test_burn_too_much() -> Result<()> { assert!(result.is_err(), "Should fail with insufficient balance"); let e = result.unwrap_err(); - assert!(matches!(e, cctp_bridge::Error::InsufficientBalance(_, _))); + assert!(matches!(e, cctp_client::Error::InsufficientBalance(_, _))); println!("error {e}"); Ok(()) } @@ -155,7 +155,7 @@ async fn test_evm_sol() -> Result<()> { rpc, NamedChain::Sepolia, owner.pubkey(), - cctp_bridge::SOLANA_DEVNET, + cctp_client::SOLANA_DEVNET, ); let result = bridge .bridge_evm_sol(&owner, U256::from(10), None, None, None) @@ -174,7 +174,7 @@ async fn test_sol_evm() -> Result<()> { let bridge = Cctp::new_solana_evm( rpc, base_provider, - cctp_bridge::SOLANA_DEVNET, + cctp_client::SOLANA_DEVNET, NamedChain::BaseSepolia, ); let result = bridge