@circle-fin/adapter-ethers-v6 1.4.0 → 1.6.0
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 +44 -0
- package/README.md +3 -3
- package/index.cjs +3004 -277
- package/index.d.ts +957 -34
- package/index.mjs +3004 -277
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,49 @@
|
|
|
1
1
|
# @circle-fin/adapter-ethers-v6
|
|
2
2
|
|
|
3
|
+
## 1.6.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- More accurate gas fee estimates for cross-chain transfers. Added automatic transaction simulation with retry logic before execution to catch errors early. Gas estimation now accepts an optional fallback value for chains with unreliable fee oracles. Updated default Polygon RPC endpoints.
|
|
8
|
+
|
|
9
|
+
## 1.5.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
Add Circle Forwarder support for CCTP v2 bridging.
|
|
14
|
+
|
|
15
|
+
Forwarding is a relay-assisted mode where Circle observes the burn transaction,
|
|
16
|
+
retrieves attestation data, and submits the destination mint on the user's
|
|
17
|
+
behalf. This removes most destination-side orchestration from client code.
|
|
18
|
+
|
|
19
|
+
What this enables:
|
|
20
|
+
|
|
21
|
+
- Opt-in forwarding with `useForwarder: true` so Circle handles destination mint
|
|
22
|
+
submission.
|
|
23
|
+
- Forwarder-only destinations (no destination adapter required) using
|
|
24
|
+
`{ recipientAddress, chain, useForwarder: true }`.
|
|
25
|
+
- Forwarding-fee-aware estimation and max-fee calculation when `maxFee` is
|
|
26
|
+
auto-derived.
|
|
27
|
+
- New hook-based burn actions: `cctp.v2.depositForBurnWithHook` and
|
|
28
|
+
`cctp.v2.customBurnWithHook`.
|
|
29
|
+
- New forwarding helpers: `buildForwardingHookData` and
|
|
30
|
+
`buildForwardingHookDataBuffer`.
|
|
31
|
+
- Chain-level forwarding metadata via `cctp.forwarderSupported` for route
|
|
32
|
+
capability checks.
|
|
33
|
+
|
|
34
|
+
Compatibility:
|
|
35
|
+
|
|
36
|
+
- Existing non-forwarded bridge flows remain unchanged.
|
|
37
|
+
- If you set `config.maxFee` manually, include any expected forwarding fee.
|
|
38
|
+
|
|
39
|
+
### Patch Changes
|
|
40
|
+
|
|
41
|
+
- Fix RPC state propagation race condition in pre-flight simulation.
|
|
42
|
+
|
|
43
|
+
Added retry logic with exponential backoff when simulation fails with allowance errors ("exceeds allowance" or "insufficient allowance"). The adapter now retries up to 3 times with 1s, 2s delays to allow RPC nodes time to reflect recently confirmed transactions in their 'latest' block view.
|
|
44
|
+
|
|
45
|
+
This fixes an intermittent issue where bridging would fail during the burn step even though the approve transaction succeeded, particularly on chains with fast finality.
|
|
46
|
+
|
|
3
47
|
## 1.4.0
|
|
4
48
|
|
|
5
49
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -57,7 +57,7 @@ _Seamlessly interact with 16+ EVM networks using a single, strongly-typed interf
|
|
|
57
57
|
|
|
58
58
|
## Overview
|
|
59
59
|
|
|
60
|
-
The Ethers v6 Adapter is a strongly-typed implementation of the `Adapter` interface for **EVM-compatible blockchains**. Built on top of the popular [Ethers v6](https://docs.ethers.org/v6/) library, it provides type-safe blockchain interactions through a unified interface that's designed to work seamlessly with the [Bridge Kit](https://www.npmjs.com/package/@circle-fin/bridge-kit) for cross-chain USDC transfers between Solana and EVM networks, as well as any future kits for additional stablecoin operations. It can be used by any Kit built using the
|
|
60
|
+
The Ethers v6 Adapter is a strongly-typed implementation of the `Adapter` interface for **EVM-compatible blockchains**. Built on top of the popular [Ethers v6](https://docs.ethers.org/v6/) library, it provides type-safe blockchain interactions through a unified interface that's designed to work seamlessly with the [Bridge Kit](https://www.npmjs.com/package/@circle-fin/bridge-kit) for cross-chain USDC transfers between Solana and EVM networks, as well as any future kits for additional stablecoin operations. It can be used by any Kit built using the App Kits architecture and/or any providers plugged into those kits.
|
|
61
61
|
|
|
62
62
|
### Why Ethers v6 Adapter?
|
|
63
63
|
|
|
@@ -72,7 +72,7 @@ The Ethers v6 Adapter is a strongly-typed implementation of the `Adapter` interf
|
|
|
72
72
|
|
|
73
73
|
#### For Kit Users
|
|
74
74
|
|
|
75
|
-
If you're using the Bridge Kit or other
|
|
75
|
+
If you're using the Bridge Kit or other App Kits for cross-chain operations, you only need to instantiate one adapter and pass it to the kit. The same adapter works across all supported chains.
|
|
76
76
|
|
|
77
77
|
```typescript
|
|
78
78
|
// Single adapter instance for multi-chain operations
|
|
@@ -626,7 +626,7 @@ The Ethers v6 adapter supports **34 EVM-compatible chains** across mainnet and t
|
|
|
626
626
|
|
|
627
627
|
## Development
|
|
628
628
|
|
|
629
|
-
This package is part of the
|
|
629
|
+
This package is part of the App Kits monorepo.
|
|
630
630
|
|
|
631
631
|
```bash
|
|
632
632
|
# Build
|