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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +14 -19
  2. package/index.cjs.js +1856 -171
  3. package/index.d.ts +522 -134
  4. package/index.mjs +1856 -171
  5. package/package.json +2 -2
package/README.md CHANGED
@@ -8,12 +8,10 @@
8
8
 
9
9
  **Circle's Cross-Chain Transfer Protocol v2 provider for Stablecoin Kits**
10
10
 
11
- _Native USDC bridging across 24+ chains using Circle's battle-tested protocols._
11
+ _Native USDC bridging across 34 chains using Circle's battle-tested protocols._
12
12
 
13
13
  </div>
14
14
 
15
- ---
16
-
17
15
  ## Table of Contents
18
16
 
19
17
  - [CCTPv2 Bridging Provider](#cctpv2-bridging-provider)
@@ -46,12 +44,12 @@ _Native USDC bridging across 24+ chains using Circle's battle-tested protocols._
46
44
 
47
45
  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.
48
46
 
49
- While primarily designed to power the [Bridging Kit](https://github.com/circlefin/stablecoin-kits-private/tree/main/kits/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.
47
+ 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.
50
48
 
51
49
  ### Why CCTPv2 Provider?
52
50
 
53
51
  - **🔒 Circle's official protocol**: Uses Circle's native CCTP infrastructure for maximum security
54
- - **⚡ 24+ chain support**: Enables bridging across all CCTPv2-supported networks
52
+ - **⚡ 34 chain support**: Enables bridging across all CCTPv2-supported networks
55
53
  - **🎯 Native USDC**: Bridges actual USDC tokens, not wrapped or synthetic versions
56
54
  - **🔧 Type-safe operations**: Built with TypeScript strict mode and comprehensive validation
57
55
  - **🛠️ Direct integration**: Use standalone or with custom orchestration logic
@@ -64,7 +62,7 @@ npm install @circle-fin/provider-cctp-v2
64
62
  yarn add @circle-fin/provider-cctp-v2
65
63
  ```
66
64
 
67
- > **Note**: This provider is included by default with the [Bridging Kit](https://github.com/circlefin/stablecoin-kits-private/tree/main/kits/bridging-kit). You can import this provider if you need to do a custom CCTP integration.
65
+ > **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.
68
66
 
69
67
  ## Quick Start
70
68
 
@@ -135,21 +133,21 @@ const result = await provider.bridge({
135
133
  - ✅ **Native USDC bridging** - Move real USDC between supported networks
136
134
  - ✅ **CCTP v2 integration** - Direct integration with Circle's CCTP v2 protocol
137
135
  - ✅ **Comprehensive validation** - Route validation and parameter checking
138
- - ✅ **Multi-chain support** - Works across all 24 CCTPv2-supported chains
136
+ - ✅ **Multi-chain support** - Works across all 34 CCTPv2-supported chains
139
137
  - ✅ **Type safety** - Full TypeScript support with detailed error handling
140
138
  - ✅ **Bridge speeds** - Support for both FAST and SLOW bridge configurations
141
139
 
142
140
  ## Supported Chains & Routes
143
141
 
144
- The provider supports **264 total bridge routes** across these networks:
142
+ The provider supports **544 total bridge routes** across these chains:
145
143
 
146
- ### Mainnet Chains (12 chains)
144
+ ### Mainnet Chains (17 chains)
147
145
 
148
- **Arbitrum**, **Avalanche**, **Base**, **Codex**, **Ethereum**, **Linea**, **OP Mainnet**, **Polygon PoS**, **Solana**, **Sonic**, **Unichain**, **World Chain**
146
+ **Arbitrum**, **Avalanche**, **Base**, **Codex**, **Ethereum**, **HyperEVM**, **Ink**, **Linea**, **OP Mainnet**, **Plume**, **Polygon PoS**, **Sei**, **Solana**, **Sonic**, **Unichain**, **World Chain**, **XDC**
149
147
 
150
- ### Testnet Chains (12 chains)
148
+ ### Testnet Chains (17 chains)
151
149
 
152
- **Arbitrum Sepolia**, **Avalanche Fuji**, **Base Sepolia**, **Codex Testnet**, **Ethereum Sepolia**, **Linea Sepolia**, **OP Sepolia**, **Polygon PoS Amoy**, **Solana Devnet**, **Sonic Testnet**, **Unichain Sepolia**, **World Chain Sepolia**
150
+ **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**
153
151
 
154
152
  ## Usage Examples
155
153
 
@@ -280,7 +278,7 @@ Each step is tracked and can be monitored through the Provider's event system. T
280
278
 
281
279
  ## Integration with Bridging Kit
282
280
 
283
- This provider is designed specifically for the [Bridging Kit](https://github.com/circlefin/stablecoin-kits-private/tree/main/kits/bridging-kit):
281
+ This provider is designed specifically for the [Bridging Kit](https://www.npmjs.com/package/@circle-fin/bridging-kit):
284
282
 
285
283
  ```typescript
286
284
  import { BridgingKit } from '@circle-fin/bridging-kit'
@@ -354,13 +352,9 @@ nx build @circle-fin/provider-cctp-v2
354
352
  nx test @circle-fin/provider-cctp-v2
355
353
  ```
356
354
 
357
- ## Contributing
358
-
359
- We welcome contributions! Please see our [Contributing Guide](https://github.com/circlefin/stablecoin-kits-private/blob/main/CONTRIBUTING.md) for details.
360
-
361
355
  ## License
362
356
 
363
- This project is licensed under the Apache 2.0 License - see the [LICENSE](https://github.com/circlefin/stablecoin-kits-private/blob/main/LICENSE) file for details.
357
+ This project is licensed under the Apache 2.0 License. Contact [support](https://help.circle.com/s/submit-ticket) for details.
364
358
 
365
359
  ---
366
360
 
@@ -368,7 +362,8 @@ This project is licensed under the Apache 2.0 License - see the [LICENSE](https:
368
362
 
369
363
  **Ready for cross-chain bridging?**
370
364
 
371
- [View Stablecoin Kits](https://github.com/circlefin/stablecoin-kits-private) • [Join Discord](https://discord.com/invite/buildoncircle) • [Report Issues](https://github.com/circlefin/stablecoin-kits-private/issues)
365
+ [Join Discord](https://discord.com/invite/buildoncircle) •
366
+ [Visit our Help-Desk](https://help.circle.com/s/submit-ticket)
372
367
 
373
368
  _Built with ❤️ by Circle_
374
369