@circle-fin/provider-cctp-v2 0.0.2-alpha.7 → 1.0.1

package/README.md

@@ -5,8 +5,9 @@
 [![npm version](https://badge.fury.io/js/@circle-fin%2Fprovider-cctp-v2.svg)](https://badge.fury.io/js/@circle-fin%2Fprovider-cctp-v2)
 [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue.svg)](https://www.typescriptlang.org/)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Discord](https://img.shields.io/discord/473781666251538452?label=Discord&logo=discord)](https://discord.com/invite/buildoncircle)
 
-**Circle's Cross-Chain Transfer Protocol v2 provider for Stablecoin Kits**
+**Circle's Cross-Chain Transfer Protocol v2 provider for Bridge Kit**
 
 _Native USDC bridging across 34 chains using Circle's battle-tested protocols._
 
@@ -20,19 +21,19 @@ _Native USDC bridging across 34 chains using Circle's battle-tested protocols._
     - [Why CCTPv2 Provider?](#why-cctpv2-provider)
   - [Installation](#installation)
   - [Quick Start](#quick-start)
-    - [Option 1: With Bridging Kit (Recommended)](#option-1-with-bridging-kit-recommended)
+    - [Option 1: With Bridge Kit (Recommended)](#option-1-with-bridge-kit-recommended)
     - [Option 2: Direct Provider Usage](#option-2-direct-provider-usage)
   - [Features](#features)
   - [Supported Chains \& Routes](#supported-chains--routes)
-    - [Mainnet Chains (12 chains)](#mainnet-chains-12-chains)
-    - [Testnet Chains (12 chains)](#testnet-chains-12-chains)
+    - [Mainnet Chains](#mainnet-chains)
+    - [Testnet Chains](#testnet-chains)
   - [Usage Examples](#usage-examples)
     - [Basic Bridge Operation](#basic-bridge-operation)
     - [Route Validation](#route-validation)
     - [Bridge Configurations](#bridge-configurations)
   - [Error Handling](#error-handling)
   - [Bridge Process](#bridge-process)
-  - [Integration with Bridging Kit](#integration-with-bridging-kit)
+  - [Integration with Bridge Kit](#integration-with-bridge-kit)
   - [API Reference](#api-reference)
     - [Core Methods](#core-methods)
     - [Transfer Parameters](#transfer-parameters)
@@ -42,9 +43,9 @@ _Native USDC bridging across 34 chains using Circle's battle-tested protocols._
 
 ## Overview
 
-The CCTPv2 Bridging Provider is a strongly-typed implementation of Circle's Cross-Chain Transfer Protocol (CCTP) version 2 that enables **native USDC bridging** between 24+ supported blockchain networks.
+The CCTPv2 Bridging Provider is a strongly-typed implementation of Circle's Cross-Chain Transfer Protocol (CCTP) version 2 that enables **native USDC bridging** between 34+ supported blockchain networks.
 
-While primarily designed to power the [Bridging Kit](https://www.npmjs.com/package/@circle-fin/bridging-kit), this provider can also be used **directly in applications** that need fine-grained control over the CCTP transfer process or want to integrate CCTP without the full Stablecoin Kits framework.
+While primarily designed to power the [Bridge Kit](https://www.npmjs.com/package/@circle-fin/bridge-kit), this provider can also be used **directly in applications** that need fine-grained control over the CCTP transfer process or want to integrate CCTP without the full Stablecoin Kits framework.
 
 ### Why CCTPv2 Provider?
 
@@ -62,21 +63,21 @@ npm install @circle-fin/provider-cctp-v2
 yarn add @circle-fin/provider-cctp-v2
 ```
 
-> **Note**: This provider is included by default with the [Bridging Kit](https://www.npmjs.com/package/@circle-fin/bridging-kit). You can import this provider if you need to do a custom CCTP integration.
+> **Note**: This provider is included by default with the [Bridge Kit](https://www.npmjs.com/package/@circle-fin/bridge-kit). You can import this provider if you need to do a custom CCTP integration.
 
 ## Quick Start
 
-### Option 1: With Bridging Kit (Recommended)
+### Option 1: With Bridge Kit (Recommended)
 
 ```typescript
-import { BridgingKit } from '@circle-fin/bridging-kit'
+import { BridgeKit } from '@circle-fin/bridge-kit'
 
 // Provider included by default
-const kit = new BridgingKit()
+const kit = new BridgeKit()
 
 const result = await kit.bridge({
-  source: { adapter: sourceAdapter },
-  destination: { adapter: destAdapter },
+  from: { adapter: sourceAdapter, chain: 'Ethereum' },
+  to: { adapter: destAdapter, chain: 'Base' },
   amount: '100.50',
 })
 ```
@@ -113,16 +114,16 @@ const isSupported = provider.supportsRoute('Ethereum', 'Base', 'USDC')
 
 // Get bridge estimate
 const estimate = await provider.estimate({
-  source: { adapter: sourceAdapter },
-  destination: { adapter: destAdapter },
+  from: { adapter: sourceAdapter, chain: 'Ethereum' },
+  to: { adapter: destAdapter, chain: 'Base' },
   amount: '100.50',
   config: { transferSpeed: 'FAST' },
 })
 
 // Execute bridge operation with custom logic
 const result = await provider.bridge({
-  source: { adapter: sourceAdapter },
-  destination: { adapter: destAdapter },
+  from: { adapter: sourceAdapter, chain: 'Ethereum' },
+  to: { adapter: destAdapter, chain: 'Base' },
   amount: '100.50',
   config: { transferSpeed: 'FAST' },
 })
@@ -141,92 +142,14 @@ const result = await provider.bridge({
 
 The provider supports **544 total bridge routes** across these chains:
 
-### Mainnet Chains (17 chains)
+### Mainnet Chains
 
 **Arbitrum**, **Avalanche**, **Base**, **Codex**, **Ethereum**, **HyperEVM**, **Ink**, **Linea**, **OP Mainnet**, **Plume**, **Polygon PoS**, **Sei**, **Solana**, **Sonic**, **Unichain**, **World Chain**, **XDC**
 
-### Testnet Chains (17 chains)
+### Testnet Chains
 
 **Arbitrum Sepolia**, **Avalanche Fuji**, **Base Sepolia**, **Codex Testnet**, **Ethereum Sepolia**, **HyperEVM Testnet**, **Ink Testnet**, **Linea Sepolia**, **OP Sepolia**, **Plume Testnet**, **Polygon PoS Amoy**, **Sei Testnet**, **Solana Devnet**, **Sonic Testnet**, **Unichain Sepolia**, **World Chain Sepolia**, **XDC Apothem**
 
-## Usage Examples
-
-### Basic Bridge Operation
-
-```typescript
-import { BridgingKit } from '@circle-fin/bridging-kit'
-import { ViemAdapter } from '@circle-fin/adapter-viem-v2'
-import { createPublicClient, createWalletClient, http } from 'viem'
-import { mainnet, base } from 'viem/chains'
-import { privateKeyToAccount } from 'viem/accounts'
-
-const account = privateKeyToAccount(process.env.PRIVATE_KEY)
-const kit = new BridgingKit() // CCTPv2 provider included by default
-
-const ethereumAdapter = new ViemAdapter({
-  publicClient: createPublicClient({ chain: mainnet, transport: http() }),
-  walletClient: createWalletClient({
-    account,
-    chain: mainnet,
-    transport: http(),
-  }),
-})
-
-const baseAdapter = new ViemAdapter({
-  publicClient: createPublicClient({ chain: base, transport: http() }),
-  walletClient: createWalletClient({ account, chain: base, transport: http() }),
-})
-
-const result = await kit.bridge({
-  source: { adapter: ethereumAdapter },
-  destination: { adapter: baseAdapter },
-  amount: '100.50',
-  config: { transferSpeed: 'FAST' },
-})
-```
-
-### Route Validation
-
-```typescript
-import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
-import { BridgingKit } from '@circle-fin/bridging-kit'
-
-const provider = new CCTPV2BridgingProvider()
-const kit = new BridgingKit()
-
-// Check if a route is supported
-const isSupported = provider.supportsRoute('Ethereum', 'Base', 'USDC')
-console.log('Ethereum → Base:', isSupported ? '✅' : '❌')
-
-// Validate before bridging
-const sourceChain = 'Ethereum'
-const destChain = 'Base'
-if (!kit.supportsRoute(sourceChain, destChain, 'USDC')) {
-  throw new Error('Route not supported')
-}
-```
-
-### Bridge Configurations
-
-```typescript
-// Using the same kit and adapters from the examples above
-// Fast bridge (higher fees, faster processing)
-const fastResult = await kit.bridge({
-  source: { adapter: ethereumAdapter },
-  destination: { adapter: baseAdapter },
-  amount: '50.0',
-  config: { transferSpeed: 'FAST' },
-})
-
-// Slow bridge (lower fees, longer processing)
-const slowResult = await kit.bridge({
-  source: { adapter: ethereumAdapter },
-  destination: { adapter: baseAdapter },
-  amount: '50.0',
-  config: { transferSpeed: 'SLOW' },
-})
-```
-
 ## Error Handling
 
 The provider implements thoughtful error handling for different scenarios:
@@ -234,8 +157,8 @@ The provider implements thoughtful error handling for different scenarios:
 ```typescript
 // Using the same kit and adapters from the examples above
 const params = {
-  source: { adapter: ethereumAdapter },
-  destination: { adapter: baseAdapter },
+  from: { adapter: sourceAdapter, chain: 'Ethereum' },
+  to: { adapter: destAdapter, chain: 'Base' },
   amount: '100.50',
 }
 
@@ -276,12 +199,12 @@ The CCTPv2 provider handles the complete cross-chain bridging flow:
 
 Each step is tracked and can be monitored through the Provider's event system. Transaction details for each step include explorer URLs for easy verification on block explorers.
 
-## Integration with Bridging Kit
+## Integration with Bridge Kit
 
-This provider is designed specifically for the [Bridging Kit](https://www.npmjs.com/package/@circle-fin/bridging-kit):
+This provider is designed specifically for the [Bridge Kit](https://www.npmjs.com/package/@circle-fin/bridge-kit):
 
 ```typescript
-import { BridgingKit } from '@circle-fin/bridging-kit'
+import { BridgeKit } from '@circle-fin/bridge-kit'
 import { ViemAdapter } from '@circle-fin/adapter-viem-v2'
 import { createPublicClient, createWalletClient, http } from 'viem'
 import { mainnet, base } from 'viem/chains'
@@ -290,7 +213,7 @@ import { privateKeyToAccount } from 'viem/accounts'
 const account = privateKeyToAccount(process.env.PRIVATE_KEY)
 
 // Provider is included by default
-const kit = new BridgingKit()
+const kit = new BridgeKit()
 
 const sourceAdapter = new ViemAdapter({
   publicClient: createPublicClient({ chain: mainnet, transport: http() }),
@@ -309,37 +232,20 @@ const destAdapter = new ViemAdapter({
 // Monitor transfer events
 kit.on('*', (event) => console.log('Event:', event)) // subscribe to all events
 kit.on('approve', (event) => console.log('Approval:', event.values.txHash))
-kit.on('depositForBurn', (event) => console.log('Burn:', event.values.txHash))
-kit.on('attestation', (event) => console.log('Burn:', event.attestation))
+kit.on('burn', (event) => console.log('Burn:', event.values.txHash))
+kit.on('fetchAttestation', (event) =>
+  console.log('Attestation:', event.values.data),
+)
 kit.on('mint', (event) => console.log('Mint:', event.values.txHash))
 
 // Execute transfer
 const result = await kit.bridge({
-  source: { adapter: sourceAdapter },
-  destination: { adapter: destAdapter },
+  from: { adapter: sourceAdapter, chain: 'Ethereum' },
+  to: { adapter: destAdapter, chain: 'Base' },
   amount: '25.0',
 })
 ```
 
-## API Reference
-
-### Core Methods
-
-- `supportsRoute(source, destination, token)` - Check if transfer route is supported
-- `bridge(params)` - Execute cross-chain bridge operation
-- `estimate(params)` - Get cost estimates for transfer
-
-### Transfer Parameters
-
-```typescript
-interface BridgeParams {
-  source: WalletContextWithFlexibleChain
-  destination: WalletContextWithFlexibleChain
-  amount: string
-  config?: BridgeConfig
-}
-```
-
 ## Development
 
 This package is part of the Stablecoin Kits monorepo.