@circle-fin/adapter-ethers-v6 0.0.2-alpha.7 → 1.0.0

package/README.md

@@ -45,7 +45,7 @@ _Seamlessly interact with 16+ EVM networks using a single, strongly-typed interf
 
 ## Overview
 
-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 [Bridging Kit](https://www.npmjs.com/package/@circle-fin/bridging-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 Stablecoin Kits architecture and/or any providers plugged into those kits.
+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 Stablecoin Kits architecture and/or any providers plugged into those kits.
 
 ### Why Ethers v6 Adapter?
 
@@ -60,12 +60,22 @@ The Ethers v6 Adapter is a strongly-typed implementation of the `Adapter` interf
 
 #### For Kit Users
 
-If you're using the Bridging Kit or other Stablecoin 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.
+If you're using the Bridge Kit or other Stablecoin 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.
 
 ```typescript
 // Single adapter instance for multi-chain operations
+// Note: Private keys can be provided with or without '0x' prefix
 const adapter = createAdapterFromPrivateKey({
-  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`, // Both '0x...' and '...' work
+})
+
+// Both formats are automatically normalized:
+const adapter1 = createAdapterFromPrivateKey({
+  privateKey: '0x1234...', // With prefix ✅
+})
+
+const adapter2 = createAdapterFromPrivateKey({
+  privateKey: '1234...', // Without prefix ✅ (automatically normalized)
 })
 ```
 
@@ -81,6 +91,27 @@ npm install @circle-fin/adapter-ethers-v6 ethers
 yarn add @circle-fin/adapter-ethers-v6 ethers
 ```
 
+## Peer Dependencies
+
+This adapter requires `ethers` (v6) as a peer dependency. Install it alongside the adapter:
+
+```bash
+npm install @circle-fin/adapter-ethers-v6 ethers
+# or
+yarn add @circle-fin/adapter-ethers-v6 ethers
+```
+
+**Supported Versions:** `^6.11.0` (6.11.x through 6.x.x, excluding 7.x.x)
+
+### Troubleshooting Version Conflicts
+
+If you encounter peer dependency warnings:
+
+- Check your `ethers` version: `npm ls ethers`
+- Ensure ethers v6 is between 6.11.0 and 7.0.0 (exclusive)
+- Use `npm install ethers@^6.11.0` to install a compatible version
+- Note: This adapter is **not** compatible with ethers v5 or v7
+
 ## Quick Start
 
 ### Zero-Config Setup (Recommended)
@@ -91,8 +122,9 @@ The simplest way to get started with lazy initialization. Default configuration
 import { createAdapterFromPrivateKey } from '@circle-fin/adapter-ethers-v6'
 
 // Minimal configuration with lazy initialization
+// Note: Private keys work with or without '0x' prefix
 const adapter = createAdapterFromPrivateKey({
-  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`, // Both '0x...' and '...' work
   // Defaults applied:
   // - addressContext: 'user-controlled'
   // - supportedChains: all EVM chains (~34 networks)
@@ -419,18 +451,18 @@ console.log('Permit signature:', signature)
 
 ### Cross-Chain Bridging
 
-**Bridge USDC** using the Bridging Kit with OperationContext:
+**Bridge USDC** using the Bridge Kit with OperationContext:
 
 ```typescript
 import { createAdapterFromPrivateKey } from '@circle-fin/adapter-ethers-v6'
-import { BridgingKit } from '@circle-fin/bridging-kit'
+import { BridgeKit } from '@circle-fin/bridge-kit'
 
 // Create adapter for multi-chain operations
 const adapter = createAdapterFromPrivateKey({
   privateKey: process.env.PRIVATE_KEY as `0x${string}`,
 })
 
-const kit = new BridgingKit()
+const kit = new BridgeKit()
 
 // Bridge from Ethereum to Base using the same adapter
 const result = await kit.bridge({
@@ -548,12 +580,6 @@ Gets the connected wallet address. Chain parameter is provided automatically by
 
 **Returns:** `Promise<string>` - Wallet address
 
-#### `getChain()`
-
-**Deprecated** - Use OperationContext pattern instead. Gets the current chain definition.
-
-**Returns:** `Promise<ChainDefinition>`
-
 ### Token Operations
 
 Built-in token operations using the action system: