@circle-fin/adapter-ethers-v6 1.1.0 → 1.1.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 +16 -0
- package/README.md +41 -29
- package/index.cjs +728 -57
- package/index.d.ts +13 -14
- package/index.mjs +728 -57
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @circle-fin/adapter-ethers-v6
|
|
2
2
|
|
|
3
|
+
## 1.1.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Fixed adapter `getAddress()` types to match function logic by requiring a `chain` parameter, and updated documentation accordingly.
|
|
8
|
+
- Improved error handling with more informative and consistent error messages.
|
|
9
|
+
|
|
10
|
+
Errors now include:
|
|
11
|
+
- Specific error codes for programmatic handling
|
|
12
|
+
- Error type categorization (BALANCE, ONCHAIN, RPC, NETWORK)
|
|
13
|
+
- Recoverability information (FATAL vs RETRYABLE)
|
|
14
|
+
- Clearer error messages with chain context
|
|
15
|
+
- Original error details preserved for debugging
|
|
16
|
+
|
|
17
|
+
- Fixed bug where tokens could be burned when bridging to unsupported chains. Bridge operations now fail immediately if the adapter doesn't support the source or destination chain, before any tokens are approved or burned. Error messages now clearly list all supported chains when an unsupported chain is used, and chain validation errors use the correct `INVALID_CHAIN` error code instead of `UNSUPPORTED_ROUTE`.
|
|
18
|
+
|
|
3
19
|
## 1.1.0
|
|
4
20
|
|
|
5
21
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -14,34 +14,46 @@ _Seamlessly interact with 16+ EVM networks using a single, strongly-typed interf
|
|
|
14
14
|
|
|
15
15
|
## Table of Contents
|
|
16
16
|
|
|
17
|
-
- [
|
|
18
|
-
- [
|
|
19
|
-
- [
|
|
20
|
-
- [
|
|
21
|
-
- [
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
- [
|
|
25
|
-
- [
|
|
26
|
-
|
|
27
|
-
- [
|
|
28
|
-
|
|
29
|
-
- [
|
|
30
|
-
|
|
31
|
-
- [
|
|
32
|
-
|
|
33
|
-
- [Usage
|
|
34
|
-
|
|
35
|
-
- [
|
|
36
|
-
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
- [
|
|
42
|
-
- [
|
|
43
|
-
- [
|
|
44
|
-
- [
|
|
17
|
+
- [Ethers v6 Adapter](#ethers-v6-adapter)
|
|
18
|
+
- [Table of Contents](#table-of-contents)
|
|
19
|
+
- [Overview](#overview)
|
|
20
|
+
- [Why Ethers v6 Adapter?](#why-ethers-v6-adapter)
|
|
21
|
+
- [When to Use This Adapter](#when-to-use-this-adapter)
|
|
22
|
+
- [For Kit Users](#for-kit-users)
|
|
23
|
+
- [For Kit Provider Developers](#for-kit-provider-developers)
|
|
24
|
+
- [Installation](#installation)
|
|
25
|
+
- [Peer Dependencies](#peer-dependencies)
|
|
26
|
+
- [Troubleshooting Version Conflicts](#troubleshooting-version-conflicts)
|
|
27
|
+
- [Quick Start](#quick-start)
|
|
28
|
+
- [Zero-Config Setup (Recommended)](#zero-config-setup-recommended)
|
|
29
|
+
- [Production Setup](#production-setup)
|
|
30
|
+
- [Browser Wallet Setup](#browser-wallet-setup)
|
|
31
|
+
- [OperationContext Pattern](#operationcontext-pattern)
|
|
32
|
+
- [Why OperationContext?](#why-operationcontext)
|
|
33
|
+
- [Basic Usage](#basic-usage)
|
|
34
|
+
- [Multi-Chain Operations](#multi-chain-operations)
|
|
35
|
+
- [Address Context Guide](#address-context-guide)
|
|
36
|
+
- [User-Controlled (Recommended)](#user-controlled-recommended)
|
|
37
|
+
- [Developer-Controlled (Advanced)](#developer-controlled-advanced)
|
|
38
|
+
- [Usage Examples](#usage-examples)
|
|
39
|
+
- [Contract Interactions](#contract-interactions)
|
|
40
|
+
- [EIP-712 Signatures](#eip-712-signatures)
|
|
41
|
+
- [Cross-Chain Bridging](#cross-chain-bridging)
|
|
42
|
+
- [API Reference](#api-reference)
|
|
43
|
+
- [Factory Functions](#factory-functions)
|
|
44
|
+
- [`createAdapterFromPrivateKey(params)`](#createadapterfromprivatekeyparams)
|
|
45
|
+
- [`createAdapterFromProvider(params)`](#createadapterfromproviderparams)
|
|
46
|
+
- [Core Methods](#core-methods)
|
|
47
|
+
- [`prepare(params, ctx)`](#prepareparams-ctx)
|
|
48
|
+
- [`signTypedData(typedData, ctx)`](#signtypeddatatypeddata-ctx)
|
|
49
|
+
- [`waitForTransaction(txHash, config?)`](#waitfortransactiontxhash-config)
|
|
50
|
+
- [`getAddress(chain)`](#getaddresschain)
|
|
51
|
+
- [Token Operations](#token-operations)
|
|
52
|
+
- [Supported Chains \& Routes](#supported-chains--routes)
|
|
53
|
+
- [Mainnet Chains (17 chains)](#mainnet-chains-17-chains)
|
|
54
|
+
- [Testnet Chains (17 chains)](#testnet-chains-17-chains)
|
|
55
|
+
- [Development](#development)
|
|
56
|
+
- [License](#license)
|
|
45
57
|
|
|
46
58
|
## Overview
|
|
47
59
|
|
|
@@ -574,7 +586,7 @@ Waits for transaction confirmation.
|
|
|
574
586
|
const receipt = await adapter.waitForTransaction('0x...')
|
|
575
587
|
```
|
|
576
588
|
|
|
577
|
-
#### `getAddress(chain
|
|
589
|
+
#### `getAddress(chain)`
|
|
578
590
|
|
|
579
591
|
Gets the connected wallet address. Chain parameter is provided automatically by OperationContext resolution.
|
|
580
592
|
|