Skip to content

feat/owner-account-param #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RanaBug merged 3 commits into from
Nov 5, 2025
Merged

feat/owner-account-param #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eed1747
added ownerAccount param as LocalAccount
RanaBug Nov 4, 2025
2c5438f
rename ownerAccount to viemLocalAccount
RanaBug Nov 5, 2025
d39104e
Typo fix
IAmKio Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## [2.1.2] - 2025-01-27

### Added Changes

- **viemLocalAccount Support**: Added support for passing a `LocalAccount` (from viem) directly to the Transaction Kit via the `viemLocalAccount` parameter in `delegatedEoa` mode. This allows users to bypass `privateKeyToAccount` conversion when they already have a `LocalAccount` object. The `viemLocalAccount` parameter works equivalently to `privateKey` and provides the same functionality - users can provide either `privateKey` or `viemLocalAccount`, but not both.

## [2.1.1] - 2025-01-27

### Added Changes
Expand Down
48 changes: 25 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ import { TransactionKit } from '@etherspot/transaction-kit';
// Initialize TransactionKit
const kit = TransactionKit({
chainId: 137, // Polygon mainnet
privateKey: '0x...your-private-key...', // Required for EIP-7702
privateKey: '0x...your-private-key...', // Required for EIP-7702 (either privateKey or viemLocalAccount)
bundlerApiKey: 'your-bundler-api-key', // Optional but recommended
walletMode: 'delegatedEoa', // Required for EIP-7702
});
Expand Down Expand Up @@ -240,7 +240,7 @@ For EIP-7702 specific functionalities:
// Initialize with delegated EOA mode
const kit = TransactionKit({
chainId: 137, // Polygon
privateKey: '0x...your-private-key...',
privateKey: '0x...your-private-key...', // Required for EIP-7702 (either privateKey or viemLocalAccount)
bundlerApiKey: 'your-bundler-api-key',
walletMode: 'delegatedEoa',
});
Expand Down Expand Up @@ -361,6 +361,7 @@ const result = await kit.sendBatches({ authorization });
```

Notes:

- The `authorization` must match the transaction `chainId` and Kernel v3.3 implementation.
- For multi-chain batches, the `authorization` will only be applied to chain groups matching the authorization's `chainId`.
- `authorization` is only supported in `delegatedEoa` mode; using it in `modular` mode will cause validation errors.
Expand Down Expand Up @@ -436,7 +437,7 @@ Advanced EIP-7702 functionality with delegated Externally Owned Accounts:
```typescript
const kit = TransactionKit({
chainId: 137, // Required: Default chain ID
privateKey: '0x...your-private-key...', // Required: EOA private key
privateKey: '0x...your-private-key...', // Required for EIP-7702 (either privateKey or viemLocalAccount)
bundlerApiKey: 'your-api-key', // Optional: For better performance
bundlerUrl: 'https://your-bundler-url.com', // Optional: Custom bundler URL
bundlerApiKeyFormat: '?api-key=', // Optional: API key format (default: '?api-key=')
Expand All @@ -445,21 +446,21 @@ const kit = TransactionKit({
});
```

**Note**: In delegated EOA mode, you don't need to provide a `provider` as the private key is used directly to create the account.
**Note**: In delegated EOA mode, you don't need to provide a `provider`. You can provide either a `privateKey` or a `viemLocalAccount` (a `LocalAccount` from viem) directly, but not both. The `viemLocalAccount` option is useful when you already have a `LocalAccount` object and want to bypass the `privateKey` conversion.

### Wallet Mode Comparison

| Feature | Modular Mode | Delegated EOA Mode |
| --------------------------- | ------------------------ | ---------------------------------- |
| **Account Type** | Etherspot Smart Account | EIP-7702 Delegated EOA |
| **Provider Required** | ✅ Yes (wallet provider) | ❌ No (uses private key) |
| **Private Key Required** | ❌ No | ✅ Yes |
| **Client-Side Safe** | ✅ Yes | ⚠️ Depends on private key handling |
| **Paymaster Support** | ✅ Full support | ⚠️ Not yet supported |
| **UserOp Overrides** | ✅ Supported | ⚠️ Not yet supported |
| **EIP-7702 Methods** | ❌ Not available | ✅ Yes |
| **Modular SDK Integration** | ✅ Yes | ❌ No |
| **ZeroDev Integration** | ❌ No | ✅ Yes integration |
| Feature | Modular Mode | Delegated EOA Mode |
| -------------------------------------- | ------------------------ | ---------------------------------------------- |
| **Account Type** | Etherspot Smart Account | EIP-7702 Delegated EOA |
| **Provider Required** | ✅ Yes (wallet provider) | ❌ No (uses privateKey or viemLocalAccount) |
| **Private Key/Owner Account Required** | ❌ No | ✅ Yes (either privateKey or viemLocalAccount) |
| **Client-Side Safe** | ✅ Yes | ⚠️ Depends on private key/account handling |
| **Paymaster Support** | ✅ Full support | ⚠️ Not yet supported |
| **UserOp Overrides** | ✅ Supported | ⚠️ Not yet supported |
| **EIP-7702 Methods** | ❌ Not available | ✅ Yes |
| **Modular SDK Integration** | ✅ Yes | ❌ No |
| **ZeroDev Integration** | ❌ No | ✅ Yes integration |

### Advanced Bundler Configuration

Expand Down Expand Up @@ -512,7 +513,7 @@ if (kit.getEtherspotProvider().getWalletMode() === 'delegatedEoa') {

// Get account instances (delegatedEoa mode only)
const delegatedEoaAccount = await kit.getDelegatedEoaAccount(137);
const ownerAccount = await kit.getOwnerAccount(137);
const viemLocalAccount = await kit.getOwnerAccount(137);
}

// Get transaction hash from userOp hash (available in both modes)
Expand Down Expand Up @@ -574,11 +575,11 @@ When calling `delegateSmartAccountToEoa({ delegateImmediately: false })`, the me

## 🔒 Security Considerations

### Private Key Handling in Delegated EOA Mode
### Private Key and Owner Account Handling in Delegated EOA Mode

When using `walletMode: 'delegatedEoa'`, you must provide a private key. Here are important security considerations:
When using `walletMode: 'delegatedEoa'`, you must provide either a `privateKey` or a `viemLocalAccount` (LocalAccount from viem). Here are important security considerations:

**⚠️ Never expose private keys in client-side code or logs!**
**⚠️ Never expose private keys or owner accounts in client-side code or logs!**

```typescript
// ❌ BAD: Hardcoded private key
Expand All @@ -593,7 +594,7 @@ const kit = TransactionKit({
walletMode: 'delegatedEoa',
});

// ✅ GOOD: Use secure key management
// ✅ GOOD: Use secure key management (works with both privateKey and viemLocalAccount)
const kit = TransactionKit({
privateKey: await getSecurePrivateKey(), // From secure storage
walletMode: 'delegatedEoa',
Expand All @@ -602,20 +603,21 @@ const kit = TransactionKit({

**Best Practices:**

1. **Private Key Security**: Handle private keys securely - never hardcode them in client-side code
1. **Private Key/Owner Account Security**: Handle private keys and owner accounts securely - never hardcode them in client-side code
2. **Environment Variables**: Store private keys in environment variables, never in code
3. **Key Rotation**: Regularly rotate private keys for enhanced security
4. **Access Control**: Implement proper access controls around private key usage
4. **Access Control**: Implement proper access controls around private key and owner account usage
5. **Audit Logging**: Log all transactions for security auditing
6. **Secure Storage**: Use hardware security modules (HSM) or secure key management services for production
7. **Owner Account Usage**: When using `viemLocalAccount`, ensure the underlying private key is handled securely

### Important Limitations & Considerations

#### Delegated EOA Mode Limitations

- **Paymaster Support**: Currently not supported in delegated EOA mode
- **UserOp Overrides**: Custom userOp overrides are not yet supported
- **Private Key Security**: Requires careful private key handling
- **Private Key/Owner Account Security**: Requires careful private key or owner account handling
- **ZeroDev Dependency**: Requires `@zerodev/sdk` package

#### Modular Mode Limitations
Expand Down
Loading