@circle-fin/bridge-kit 1.6.0 → 1.6.1
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.
- package/CHANGELOG.md +6 -0
- package/QUICKSTART.md +6 -6
- package/README.md +3 -3
- package/chains.cjs +369 -1
- package/chains.d.ts +54 -1
- package/chains.mjs +369 -1
- package/index.cjs +3762 -2613
- package/index.d.ts +892 -43
- package/index.mjs +3722 -2614
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# @circle-fin/bridge-kit
|
|
2
2
|
|
|
3
|
+
## 1.6.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- New error handling utilities for detecting rate-limit and service errors (`isRateLimitError`, `isServiceError`). Chain definitions now available via `@circle-fin/bridge-kit/chains` subpath import.
|
|
8
|
+
|
|
3
9
|
## 1.6.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
package/QUICKSTART.md
CHANGED
|
@@ -4,7 +4,7 @@ Welcome to the Bridge Kit! This guide will help you understand the ecosystem and
|
|
|
4
4
|
|
|
5
5
|
## Table of Contents
|
|
6
6
|
|
|
7
|
-
- [What is the
|
|
7
|
+
- [What is the App Kit Ecosystem?](#what-is-the-app-kit-ecosystem)
|
|
8
8
|
- [Bring Your Own Infrastructure](#bring-your-own-infrastructure)
|
|
9
9
|
- [Architecture Overview](#architecture-overview)
|
|
10
10
|
- [Quick Setup](#quick-setup)
|
|
@@ -18,9 +18,9 @@ Welcome to the Bridge Kit! This guide will help you understand the ecosystem and
|
|
|
18
18
|
- [Best Practices](#best-practices)
|
|
19
19
|
- [Next Steps](#next-steps)
|
|
20
20
|
|
|
21
|
-
## What is the
|
|
21
|
+
## What is the App Kit Ecosystem?
|
|
22
22
|
|
|
23
|
-
The
|
|
23
|
+
The App Kit ecosystem is Circle's open-source initiative to streamline stablecoin development. Our SDKs are designed to be easy to use correctly and hard to misuse, with cross-framework compatibility (viem, ethers, solana-web3 etc.) that integrates cleanly into any stack. While opinionated with sensible defaults, they provide escape hatches when you need full control. The pluggable architecture ensures flexible implementation, and all kits are interoperable—allowing you to compose them together for a wide range of use cases.
|
|
24
24
|
|
|
25
25
|
**This Bridge Kit specifically focuses on cross-chain stablecoin bridging.** Its goal is to abstract away the complexity of cross-chain bridging while maintaining security, type safety, and developer experience.
|
|
26
26
|
|
|
@@ -876,7 +876,7 @@ kit.on('mint', (event) => {
|
|
|
876
876
|
|
|
877
877
|
## Supported Chains
|
|
878
878
|
|
|
879
|
-
The Bridge Kit supports chains through Circle's Cross-Chain Transfer Protocol v2 (CCTPv2), enabling **
|
|
879
|
+
The Bridge Kit supports chains through Circle's Cross-Chain Transfer Protocol v2 (CCTPv2), enabling **578 total bridge routes** across networks:
|
|
880
880
|
|
|
881
881
|
### Mainnet Chains (17 chains = 272 routes)
|
|
882
882
|
|
|
@@ -884,9 +884,9 @@ The Bridge Kit supports chains through Circle's Cross-Chain Transfer Protocol v2
|
|
|
884
884
|
|
|
885
885
|
**Arbitrum**, **Avalanche**, **Base**, **Codex**, **Ethereum**, **HyperEVM**, **Ink**, **Linea**, **OP Mainnet**, **Plume**, **Polygon PoS**, **Sei**, **Solana**, **Sonic**, **Unichain**, **World Chain**, **XDC**
|
|
886
886
|
|
|
887
|
-
### Testnet Chains (
|
|
887
|
+
### Testnet Chains (18 chains = 306 routes)
|
|
888
888
|
|
|
889
|
-
**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**
|
|
889
|
+
**Arc Testnet**, **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**
|
|
890
890
|
|
|
891
891
|
## Error Handling
|
|
892
892
|
|
package/README.md
CHANGED
|
@@ -62,7 +62,7 @@ _Making cross-chain stablecoin (USDC, and soon more tokens) transfers as simple
|
|
|
62
62
|
|
|
63
63
|
## Overview
|
|
64
64
|
|
|
65
|
-
The
|
|
65
|
+
The App Kit ecosystem is Circle’s open-source effort to streamline stablecoin development with SDKs that are easy to use correctly and hard to misuse. Kits are cross-framework (viem, ethers, @solana/web3) and integrate cleanly into any stack. They’re opinionated with sensible defaults, but offer escape hatches for full control. A pluggable architecture makes implementation flexible, and all kits are interoperable, so they can be composed to suit a wide range of use cases.
|
|
66
66
|
|
|
67
67
|
The Bridge Kit enables cross-chain stablecoin transfers via a type-safe, developer-friendly interface with robust runtime validation. The Kit can have any bridging provider plugged in, by implementing your own BridgingProvider, but comes by default with full CCTPv2 support
|
|
68
68
|
|
|
@@ -125,9 +125,9 @@ npm install @circle-fin/adapter-ethers-v6
|
|
|
125
125
|
yarn add @circle-fin/adapter-ethers-v6
|
|
126
126
|
|
|
127
127
|
# For Solana
|
|
128
|
-
npm install @circle-fin/adapter-solana @solana/web3.js
|
|
128
|
+
npm install @circle-fin/adapter-solana @solana/web3.js
|
|
129
129
|
# or
|
|
130
|
-
yarn add @circle-fin/adapter-solana @solana/web3.js
|
|
130
|
+
yarn add @circle-fin/adapter-solana @solana/web3.js
|
|
131
131
|
```
|
|
132
132
|
|
|
133
133
|
## Quick Start
|