@circle-fin/adapter-ethers-v6 1.0.1 → 1.1.1

package/CHANGELOG.md

@@ -0,0 +1,105 @@
+# @circle-fin/adapter-ethers-v6
+
+## 1.1.1
+
+### Patch Changes
+
+- Fixed adapter `getAddress()` types to match function logic by requiring a `chain` parameter, and updated documentation accordingly.
+- Improved error handling with more informative and consistent error messages.
+
+  Errors now include:
+  - Specific error codes for programmatic handling
+  - Error type categorization (BALANCE, ONCHAIN, RPC, NETWORK)
+  - Recoverability information (FATAL vs RETRYABLE)
+  - Clearer error messages with chain context
+  - Original error details preserved for debugging
+
+- 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`.
+
+## 1.1.0
+
+### Minor Changes
+
+- Improves static gas estimate values for contract calls. Updates adapters' `prepare()` method so that transaction simulation is now performed only during `execute()`, not during `estimate()`. Adds an optional fallback parameter to `estimate()` for cases where gas estimation fails.
+
+### Patch Changes
+
+- Fix CommonJS compatibility by correcting file extensions and package exports. This resolves a "ReferenceError: require is not defined" error that occurred when using packages in CommonJS projects with ts-node.
+
+## 1.0.1
+
+### Patch Changes
+
+- Add support for Arc Testnet chain definition. Arc is Circle's EVM-compatible Layer-1 blockchain designed for stablecoin finance and asset
+  tokenization, featuring USDC as the native gas token and sub-second finality via the Malachite BFT consensus engine.
+- Improve error messages for developer-controlled address contexts. Calling `getAddress()` on an adapter configured with `addressContext: 'developer-controlled'` now throws a clear error explaining that addresses must be provided explicitly in the operation context.
+- Update Sonic Testnet chain definition to canonical network. The `SonicTestnet` chain definition now points to the official Sonic Testnet (chainId: 14601) instead of the deprecated Sonic Blaze Testnet (chainId: 57054). The RPC endpoint has been updated to `https://rpc.testnet.soniclabs.com`, the display name simplified to "Sonic Testnet", and the USDC contract address updated to the new deployment.
+
+  **Breaking Changes:**
+  - **Chain ID:** 57054 → 14601
+  - **RPC Endpoint:** `https://rpc.blaze.soniclabs.com` → `https://rpc.testnet.soniclabs.com`
+  - **USDC Address:** `0xA4879Fed32Ecbef99399e5cbC247E533421C4eC6` → `0x0BA304580ee7c9a980CF72e55f5Ed2E9fd30Bc51`
+
+  **Migration:** If you were using `SonicTestnet`, your application will automatically connect to the new network upon upgrading. Any accounts, contracts, or transactions on the old Blaze testnet (chainId: 57054) will need to be recreated on the new testnet.
+
+## 1.0.0
+
+### Major Changes
+
+- # Ethers v6 Adapter 1.0.0 Release 🎉
+
+  Full-featured EVM blockchain adapter built on ethers.js v6 - providing comprehensive support for Ethereum and EVM-compatible chains with familiar ethers.js APIs.
+
+  ## 🚀 Core EVM Features
+  - **Complete EVM Support**: Full compatibility with Ethereum and EVM-compatible chains
+  - **Ethers.js v6 Integration**: Built on the latest ethers.js with improved performance
+  - **Multi-chain Support**: Seamless switching between different EVM networks
+  - **Wallet Integration**: Support for various wallet types and signing methods
+
+  ## 🔗 Supported Networks
+  - **Ethereum Mainnet & Testnets**: Full support for Ethereum ecosystem
+  - **Layer 2 Solutions**: Optimism, Arbitrum, Polygon, and other L2s
+  - **EVM Sidechains**: Base, Avalanche, and other EVM-compatible networks
+  - **Custom Networks**: Easy configuration for private or custom EVM chains
+
+  ## 💼 Address Management
+
+  **User-Controlled Adapters**
+  - Automatic address resolution from connected wallets
+  - Support for MetaMask, WalletConnect, and other wallet providers
+  - Real-time account switching and network detection
+
+  **Developer-Controlled Adapters**
+  - Private key-based signing for server-side applications
+  - Deterministic address management for automated systems
+  - Secure key handling with ethers.js security practices
+
+  ```typescript
+  // User-controlled adapter (wallet-based)
+  const adapter = createAdapterFromWallet(wallet)
+
+  // Developer-controlled adapter (private key)
+  const adapter = createAdapterFromPrivateKey({
+    privateKey: '0x...',
+  })
+  ```
+
+  ## ⛽ Gas Management
+  - **Intelligent Gas Estimation**: Automatic gas limit calculation with safety buffers
+  - **Dynamic Fee Calculation**: Real-time gas price fetching with configurable buffers
+  - **EIP-1559 Support**: Type 2 transaction support for modern fee markets
+  - **Gas Optimization**: Efficient transaction batching and optimization
+
+  ## 🔐 Security Features
+  - **Type Safety**: Full TypeScript support with strict type checking
+  - **Parameter Validation**: Runtime validation of all transaction parameters
+  - **Secure Signing**: Leverages ethers.js battle-tested signing infrastructure
+  - **Error Handling**: Comprehensive error handling with detailed error messages
+
+  ## 🛠️ Developer Experience
+  - **Rich JSDoc Documentation**: Complete API documentation with examples
+  - **TypeScript First**: Built with TypeScript for superior developer experience
+  - **Familiar APIs**: Consistent with ethers.js patterns and conventions
+  - **Comprehensive Testing**: Extensive test coverage for reliability
+
+  This adapter provides a robust foundation for EVM-based cross-chain USDC transfers, leveraging the mature ethers.js ecosystem while providing the specialized functionality needed for bridge operations.

package/README.md

@@ -14,34 +14,46 @@ _Seamlessly interact with 16+ EVM networks using a single, strongly-typed interf
 
 ## Table of Contents
 
-- [Overview](#overview)
-  - [Why Ethers v6 Adapter?](#why-ethers-v6-adapter)
-  - [When to Use This Adapter](#when-to-use-this-adapter)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-  - [Zero-Config Setup (Recommended)](#zero-config-setup-recommended)
-  - [Production Setup](#production-setup)
-  - [Browser Wallet Setup](#browser-wallet-setup)
-- [OperationContext Pattern](#operationcontext-pattern)
-  - [Why OperationContext?](#why-operationcontext)
-  - [Basic Usage](#basic-usage)
-  - [Multi-Chain Operations](#multi-chain-operations)
-- [Address Context Guide](#address-context-guide)
-  - [User-Controlled (Recommended)](#user-controlled-recommended)
-  - [Developer-Controlled (Advanced)](#developer-controlled-advanced)
-  - [Decision Matrix](#decision-matrix)
-- [Usage Examples](#usage-examples)
-  - [Contract Interactions](#contract-interactions)
-  - [EIP-712 Signatures](#eip-712-signatures)
-  - [Cross-Chain Bridging](#cross-chain-bridging)
-- [API Reference](#api-reference)
-  - [Factory Functions](#factory-functions)
-  - [Core Methods](#core-methods)
-  - [Token Operations](#token-operations)
-- [Migration Guide](#migration-guide)
-- [Supported Chains](#supported-chains)
-- [Development](#development)
-- [License](#license)
+- [Ethers v6 Adapter](#ethers-v6-adapter)
+  - [Table of Contents](#table-of-contents)
+  - [Overview](#overview)
+    - [Why Ethers v6 Adapter?](#why-ethers-v6-adapter)
+    - [When to Use This Adapter](#when-to-use-this-adapter)
+      - [For Kit Users](#for-kit-users)
+      - [For Kit Provider Developers](#for-kit-provider-developers)
+  - [Installation](#installation)
+  - [Peer Dependencies](#peer-dependencies)
+    - [Troubleshooting Version Conflicts](#troubleshooting-version-conflicts)
+  - [Quick Start](#quick-start)
+    - [Zero-Config Setup (Recommended)](#zero-config-setup-recommended)
+    - [Production Setup](#production-setup)
+    - [Browser Wallet Setup](#browser-wallet-setup)
+  - [OperationContext Pattern](#operationcontext-pattern)
+    - [Why OperationContext?](#why-operationcontext)
+    - [Basic Usage](#basic-usage)
+    - [Multi-Chain Operations](#multi-chain-operations)
+  - [Address Context Guide](#address-context-guide)
+    - [User-Controlled (Recommended)](#user-controlled-recommended)
+    - [Developer-Controlled (Advanced)](#developer-controlled-advanced)
+  - [Usage Examples](#usage-examples)
+    - [Contract Interactions](#contract-interactions)
+    - [EIP-712 Signatures](#eip-712-signatures)
+    - [Cross-Chain Bridging](#cross-chain-bridging)
+  - [API Reference](#api-reference)
+    - [Factory Functions](#factory-functions)
+      - [`createAdapterFromPrivateKey(params)`](#createadapterfromprivatekeyparams)
+      - [`createAdapterFromProvider(params)`](#createadapterfromproviderparams)
+    - [Core Methods](#core-methods)
+      - [`prepare(params, ctx)`](#prepareparams-ctx)
+      - [`signTypedData(typedData, ctx)`](#signtypeddatatypeddata-ctx)
+      - [`waitForTransaction(txHash, config?)`](#waitfortransactiontxhash-config)
+      - [`getAddress(chain)`](#getaddresschain)
+    - [Token Operations](#token-operations)
+  - [Supported Chains \& Routes](#supported-chains--routes)
+    - [Mainnet Chains (17 chains)](#mainnet-chains-17-chains)
+    - [Testnet Chains (17 chains)](#testnet-chains-17-chains)
+  - [Development](#development)
+  - [License](#license)
 
 ## Overview
 
@@ -574,7 +586,7 @@ Waits for transaction confirmation.
 const receipt = await adapter.waitForTransaction('0x...')
 ```
 
-#### `getAddress(chain?)`
+#### `getAddress(chain)`
 
 Gets the connected wallet address. Chain parameter is provided automatically by OperationContext resolution.