@circle-fin/adapter-ethers-v6 0.0.2-alpha.6

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2025 Circle Internet Financial Limited
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,338 @@
+# Ethers v6 Adapter
+
+<div align="center">
+
+[![npm version](https://badge.fury.io/js/@circle-fin%2Fadapter-ethers-v6.svg)](https://badge.fury.io/js/@circle-fin%2Fadapter-ethers-v6)
+[![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue.svg)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+**Type-safe EVM blockchain adapter powered by Ethers v6**
+
+_Seamlessly interact with 12+ EVM networks using a single, strongly-typed interface_
+
+</div>
+
+## Table of Contents
+
+- [Ethers v6 Adapter](#ethers-v6-adapter)
+  - [Overview](#overview)
+    - [Why Ethers v6 Adapter?](#why-ethers-v6-adapter)
+  - [Installation](#installation)
+  - [Quick Start](#quick-start)
+    - [🚀 Easy Setup with Factory Methods (Recommended)](#-easy-setup-with-factory-methods-recommended)
+    - [🏭 Production Considerations](#-production-considerations)
+  - [Usage Examples](#usage-examples)
+    - [Basic Usage with Factory Methods](#basic-usage-with-factory-methods)
+    - [Manual Setup with Ethers Clients](#manual-setup-with-ethers-clients)
+    - [Multi-Chain Setup](#multi-chain-setup)
+    - [Methods](#methods)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## Overview
+
+The Ethers v6 Adapter is a strongly-typed implementation of the [`Adapter`](https://github.com/circlefin/stablecoin-kits-private/blob/main/core/adapter/README.md) 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://github.com/circlefin/stablecoin-kits-private/tree/main/kits/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.
+
+### Why Ethers v6 Adapter?
+
+- **🔧 Bring your own setup**: Use your existing Ethers `JsonRpcProvider` and `Wallet` instances
+- **⚡ EVM-compatible**: Works with Ethereum, Base, Arbitrum, and all EVM chains
+- **🔒 Type-safe**: Built with TypeScript strict mode for complete type safety
+- **🎯 Simple API**: Clean abstraction over complex blockchain operations
+- **🔄 Transaction lifecycle** - Complete prepare/estimate/execute workflow
+- **🌉 Cross-chain ready** - Seamlessly bridge USDC between EVM chains and Solana
+
+### When and How Should I Use The Ethers v6 Adapter?
+
+#### I'm a developer using a kit
+
+If you're using one of the kits to perform actions such as bridging from chain 'A' to chain 'B', you only need to instantiate the adapter for your chain and pass it to the kit.
+
+##### Example
+
+```typescript
+const adapter = createAdapterFromPrivateKey({
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  defaultChain: 'Ethereum',
+})
+```
+
+#### I'm a developer making a Kit Provider
+
+If you are making a provider for other Kit users to plug in to the kit, e.g. a `BridgingProvider`, and you'll need to interact with diff chains, then you'll need to use the abstracted `Adapter` methods to execute on chain.
+
+## Installation
+
+```bash
+npm install @circle-fin/adapter-ethers-v6 ethers
+# or
+yarn add @circle-fin/adapter-ethers-v6 ethers
+```
+
+## Quick Start
+
+### 🚀 Easy Setup with Factory Methods (Recommended)
+
+The simplest way to get started is with our factory methods. You can create just **one adapter** and use it across different chains!
+
+```typescript
+import { createAdapterFromPrivateKey } from '@circle-fin/adapter-ethers-v6'
+
+// Create ONE adapter that can work across chains!
+const adapter = createAdapterFromPrivateKey({
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  defaultChain: 'Ethereum',
+})
+
+// Ready to use with Bridging Kit!
+const address = await adapter.getAddress()
+console.log('Connected address:', address)
+```
+
+### 🏭 Production Considerations
+
+> **⚠️ Important for Production**: The factory methods use Ethers's default public RPC endpoints, which may have rate limits and lower reliability. For production applications, we strongly recommend using dedicated RPC providers like Alchemy, Infura, or QuickNode.
+
+```typescript
+import { createAdapterFromPrivateKey } from '@circle-fin/adapter-ethers-v6'
+import { JsonRpcProvider } from 'ethers'
+
+// Production-ready setup with custom RPC endpoints
+const adapter = createAdapterFromPrivateKey({
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  defaultChain: 'Ethereum',
+  getProvider: ({ chain }) =>
+    new JsonRpcProvider(
+      `https://eth-mainnet.alchemyapi.io/v2/${process.env.ALCHEMY_KEY}`,
+    ),
+})
+```
+
+### 🌐 Browser Support with Wallet Providers
+
+For browser environments with wallet providers like MetaMask:
+
+```typescript
+import { createAdapterFromProvider } from '@circle-fin/adapter-ethers-v6'
+
+// Create an adapter from a browser wallet
+const adapter = await createAdapterFromProvider({
+  provider: window.ethereum,
+  chain: 'Ethereum', // Required: specify the intended chain
+  getProvider: ({ chain }) =>
+    new JsonRpcProvider(
+      `https://eth-mainnet.alchemyapi.io/v2/${process.env.ALCHEMY_KEY}`,
+    ),
+})
+```
+
+### 🔧 Advanced Manual Setup
+
+For advanced use cases requiring custom RPC endpoints:
+
+```typescript
+import { EthersAdapter } from '@circle-fin/adapter-ethers-v6'
+import { JsonRpcProvider, Wallet } from 'ethers'
+
+// Use your existing Ethers setup
+const provider = new JsonRpcProvider('https://your-custom-rpc.com')
+const wallet = new Wallet(process.env.PRIVATE_KEY, provider)
+
+// Create the adapter
+const adapter = new EthersAdapter({
+  provider,
+  wallet,
+})
+```
+
+## Features
+
+- ✅ **Full EVM compatibility** - Works with any Ethereum-compatible blockchain
+- ✅ **Ethers v6 integration** - Uses your existing `JsonRpcProvider` and `Wallet`
+- ✅ **Transaction lifecycle** - Complete prepare/estimate/execute workflow
+- ✅ **Type safety** - Full TypeScript support with strict mode
+- ✅ **Cross-chain ready** - Seamlessly bridge USDC between Solana and EVM chains
+
+## Usage Examples
+
+### Basic Usage with Factory Methods
+
+```typescript
+import { createAdapterFromPrivateKey } from '@circle-fin/adapter-ethers-v6'
+import { BridgingKit } from '@circle-fin/bridging-kit'
+
+// Create ONE adapter that can work across chains - so simple!
+const adapter = createAdapterFromPrivateKey({
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  defaultChain: 'Ethereum',
+})
+
+// Use directly with Bridging Kit - same adapter, different chains!
+const kit = new BridgingKit()
+const result = await kit.bridge({
+  from: { adapter }, // Uses default chain (Ethereum)
+  to: { adapter, chain: 'Base' }, // Same adapter, different chain
+  amount: '10.50',
+})
+```
+
+### Manual Setup with Ethers
+
+```typescript
+import { EthersAdapter } from '@circle-fin/adapter-ethers-v6'
+import { BridgingKit } from '@circle-fin/bridging-kit'
+import { JsonRpcProvider, Wallet } from 'ethers'
+
+const provider = new JsonRpcProvider('https://your-custom-rpc.com')
+const wallet = new Wallet(process.env.PRIVATE_KEY!, provider)
+
+const adapter = new EthersAdapter({ provider, wallet })
+
+const destinationAdapter = new EthersAdapter({
+  provider: new JsonRpcProvider('https://another-rpc.com'),
+  wallet: new Wallet(
+    process.env.PRIVATE_KEY!,
+    new JsonRpcProvider('https://another-rpc.com'),
+  ),
+})
+
+const kit = new BridgingKit()
+const result = await kit.bridge({
+  from: { adapter },
+  to: { adapter: destinationAdapter },
+  amount: '10.50',
+})
+```
+
+### Multi-Chain Setup
+
+```typescript
+import { createAdapterFromPrivateKey } from '@circle-fin/adapter-ethers-v6'
+import { BridgingKit } from '@circle-fin/bridging-kit'
+
+const kit = new BridgingKit()
+
+// Create ONE adapter that can work across ANY supported chain
+const adapter = createAdapterFromPrivateKey({
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  defaultChain: 'Ethereum', // This is just the default
+})
+
+// Use for cross-chain bridging by specifying different chains
+const result = await kit.bridge({
+  from: { adapter }, // Ethereum (from defaultChain)
+  to: { adapter, chain: 'Base' }, // Base (explicitly specified)
+  amount: '10.50',
+  token: 'USDC',
+})
+
+// Or bridge between any other supported chains
+const anotherResult = await kit.bridge({
+  from: { adapter, chain: 'Arbitrum' },
+  to: { adapter, chain: 'Polygon' },
+  amount: '25.00',
+  token: 'USDC',
+})
+```
+
+> **💡 Pro Tip**: With the single adapter pattern, you create one adapter and can use it for bridging between any supported EVM chains. Just specify the desired chain in the bridge parameters!
+
+## Supported Chains
+
+Works with all EVM-compatible chains supported by Ethers v6 and the Bridging Kit:
+
+**Ethereum**, **Base**, **Arbitrum**, **Avalanche**, **Polygon**, **Optimism**, **Linea**, **Sonic**, **Unichain**, **World Chain**, **Codex**, and their respective testnets.
+
+## API Reference
+
+### Constructor Options
+
+```typescript
+interface EthersAdapterOptions {
+  getProvider: (params: { chain: ChainDefinition }) => Provider
+  signer: Signer
+}
+```
+
+### Methods
+
+- `getAddress()` - Get the connected wallet address
+- `getChain()` - Get chain information
+- `prepare()` - Prepare transactions for execution
+- `estimate()` - Estimate transaction costs
+- `execute()` - Execute prepared transactions
+- `waitForTransaction()` - Wait for transaction confirmation
+- `calculateTransactionFee()` - Calculate transaction fees with optional buffer
+- `readContract()` - Read contract functions with comprehensive validation
+
+You can see the implementation of each of these methods in the Ethers v6 Adapter's [main implementation file](./src/adapter/adapter.ts).
+
+### Token Operations via Actions
+
+For token balance and allowance operations, this adapter uses the standardized action-based system inherited from `EvmAdapter`:
+
+- **`token.balanceOf`** - Get balance for any ERC-20 token
+- **`token.allowance`** - Get allowance for any ERC-20 token
+- **`usdc.balanceOf`** - Get USDC balance (uses `token.balanceOf` with USDC address)
+- **`usdc.allowance`** - Get USDC allowance (uses `token.allowance` with USDC address)
+
+These actions provide type-safe, validated interfaces and use the adapter's `readContract()` method internally.
+
+## Integration with Stablecoin Kits
+
+This adapter is designed to work seamlessly across the Stablecoin Kits ecosystem. Here's an example with the [Bridging Kit](https://github.com/circlefin/stablecoin-kits-private/tree/main/kits/bridging-kit):
+
+```typescript
+import { BridgingKit } from '@circle-fin/bridging-kit'
+import { createAdapterFromPrivateKey } from '@circle-fin/adapter-ethers-v6'
+
+const kit = new BridgingKit()
+
+// Create ONE adapter that works across all EVM chains - incredibly simple!
+const adapter = createAdapterFromPrivateKey({
+  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
+  defaultChain: 'Ethereum',
+})
+
+// Ready for cross-chain bridging between any supported chains!
+await kit.bridge({
+  from: { adapter }, // Uses default chain (Ethereum)
+  to: { adapter, chain: 'Base' }, // Same adapter, different chain
+  amount: '50.0',
+})
+```
+
+**For Production Use**: Remember to provide custom RPC endpoints using the `getProvider` parameter for better reliability and performance!
+
+## Development
+
+This package is part of the Stablecoin Kits monorepo.
+
+```bash
+# Build
+nx build @circle-fin/adapter-ethers-v6
+
+# Test
+nx test @circle-fin/adapter-ethers-v6
+```
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://github.com/circlefin/stablecoin-kits-private/blob/main/CONTRIBUTING.md) for details.
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](https://github.com/circlefin/stablecoin-kits-private/blob/main/LICENSE) file for details.
+
+---
+
+<div align="center">
+
+**Ready to integrate?**
+
+[View Stablecoin Kits](https://github.com/circlefin/stablecoin-kits-private) • [Join Discord](https://discord.com/invite/buildoncircle) • [Report Issues](https://github.com/circlefin/stablecoin-kits-private/issues)
+
+_Built with ❤️ by Circle_
+
+</div>